Mercurial > molko

comparison src/sprite.h @ 22:5519ad48822e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: add Doxygen documentation, closes #2450
author David Demelier <markand@malikania.fr>
date Thu, 09 Jan 2020 20:48:01 +0100
parents fc71221b7bee
children 607bd90aba63
comparison
equal deleted inserted replaced
21:63eaec5ceba9 22:5519ad48822e
30 30
31 /** 31 /**
32 * \brief Sprite structure. 32 * \brief Sprite structure.
33 */ 33 */
34 struct sprite { 34 struct sprite {
35 struct texture *texture; /* Texture to access (RO) */ 35 struct texture *texture; /*!< Texture to access (RO) */
36 uint16_t cellw; /* Width per cell (RW) */ 36 uint16_t cellw; /*!< Width per cell (RW) */
37 uint16_t cellh; /* Height per cell (RW) */ 37 uint16_t cellh; /*!< Height per cell (RW) */
38 uint16_t nrows; /* Number of rows (RW) */ 38 uint16_t nrows; /*!< Number of rows (RW) */
39 uint16_t ncols; /* Number of columns (RW) */ 39 uint16_t ncols; /*!< Number of columns (RW) */
40 }; 40 };
41 41
42 /** 42 /**
43 * Initialize a sprite. 43 * Initialize a sprite.
44 * 44 *
66 66
67 /** 67 /**
68 * Draw the sprite component from row `r' and column `c'. 68 * Draw the sprite component from row `r' and column `c'.
69 * 69 *
70 * \pre sprite != NULL 70 * \pre sprite != NULL
71 * \param sprite the sprite to draw
71 * \param r the row number 72 * \param r the row number
72 * \param c the column number 73 * \param c the column number
73 * \param x the X destination 74 * \param x the X destination
74 * \param y the Y destination 75 * \param y the Y destination
75 * \warning No bounds checking 76 * \warning No bounds checking