summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoralberth <alberth@openttd.org>2009-06-26 23:20:32 +0000
committeralberth <alberth@openttd.org>2009-06-26 23:20:32 +0000
commit9489490e482917a76a1675fa70fa5457565e5ca7 (patch)
treeecc7fd2cee90e0fb6dd38234ed3989e9d7ac7062
parent56122e377bb7ce0f8dc10267c787bae95e283c25 (diff)
downloadopenttd-9489490e482917a76a1675fa70fa5457565e5ca7.tar.xz
(svn r16671) -Doc: Documenting Sprite structure.
-rw-r--r--src/spritecache.h11
1 files changed, 6 insertions, 5 deletions
diff --git a/src/spritecache.h b/src/spritecache.h
index 1d7c5d3b1..de277d212 100644
--- a/src/spritecache.h
+++ b/src/spritecache.h
@@ -7,12 +7,13 @@
#include "gfx_type.h"
+/** Data structure describing a sprite. */
struct Sprite {
- byte height;
- uint16 width;
- int16 x_offs;
- int16 y_offs;
- byte data[];
+ byte height; ///< Height of the sprite.
+ uint16 width; ///< Width of the sprite.
+ int16 x_offs; ///< Number of pixels to shift the sprite to the right.
+ int16 y_offs; ///< Number of pixels to shift the sprite downwards.
+ byte data[]; ///< Sprite data.
};
extern uint _sprite_cache_size;