From 9489490e482917a76a1675fa70fa5457565e5ca7 Mon Sep 17 00:00:00 2001 From: alberth Date: Fri, 26 Jun 2009 23:20:32 +0000 Subject: (svn r16671) -Doc: Documenting Sprite structure. --- src/spritecache.h | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) (limited to 'src/spritecache.h') 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; -- cgit v1.2.3-54-g00ecf