Mercurial > molko
annotate src/core/sprite.h @ 72:6203e1ac9b18
doc: improve doxygen documentation a lot
author | David Demelier <markand@malikania.fr> |
---|---|
date | Tue, 28 Jan 2020 14:02:45 +0100 |
parents | 52792b863ff7 |
children | ed72843a7194 |
rev | line source |
---|---|
5
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 /* |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
2 * sprite.h -- image sprites |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 * |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 * Copyright (c) 2020 David Demelier <markand@malikania.fr> |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 * |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 * Permission to use, copy, modify, and/or distribute this software for any |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 * purpose with or without fee is hereby granted, provided that the above |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 * copyright notice and this permission notice appear in all copies. |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 * |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
17 */ |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
18 |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
19 #ifndef MOLKO_SPRITE_H |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
20 #define MOLKO_SPRITE_H |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 /** |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
23 * \file sprite.h |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 * \brief Image sprites. |
72
6203e1ac9b18
doc: improve doxygen documentation a lot
David Demelier <markand@malikania.fr>
parents:
59
diff
changeset
|
25 * \ingroup drawing |
5
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
26 */ |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
27 |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
28 struct texture; |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
29 |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
30 /** |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
31 * \brief Sprite structure. |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
32 */ |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
33 struct sprite { |
22
5519ad48822e
doc: add Doxygen documentation, closes #2450
David Demelier <markand@malikania.fr>
parents:
17
diff
changeset
|
34 struct texture *texture; /*!< Texture to access (RO) */ |
46
b815621df3e3
core: remove all fixed width integers, closes #2460
David Demelier <markand@malikania.fr>
parents:
27
diff
changeset
|
35 unsigned int cellw; /*!< Width per cell (RW) */ |
b815621df3e3
core: remove all fixed width integers, closes #2460
David Demelier <markand@malikania.fr>
parents:
27
diff
changeset
|
36 unsigned int cellh; /*!< Height per cell (RW) */ |
b815621df3e3
core: remove all fixed width integers, closes #2460
David Demelier <markand@malikania.fr>
parents:
27
diff
changeset
|
37 unsigned int nrows; /*!< Number of rows (RW) */ |
b815621df3e3
core: remove all fixed width integers, closes #2460
David Demelier <markand@malikania.fr>
parents:
27
diff
changeset
|
38 unsigned int ncols; /*!< Number of columns (RW) */ |
5
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
39 }; |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
40 |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
41 /** |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
42 * Initialize a sprite. |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
43 * |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
44 * The sprite does not take ownership of texture and must be valid until the |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
45 * sprite is no longer used. |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
46 * |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
47 * This function is only provided as convenience, user may initialize the |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
48 * sprite by itself if wanted. |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
49 * |
7
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
5
diff
changeset
|
50 * The fields `nrows' and `ncols' will be determined automatically from the |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
5
diff
changeset
|
51 * texture size. |
fbb7101b7bd8
core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
5
diff
changeset
|
52 * |
5
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
53 * \pre sprite != NULL |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
54 * \pre tex != NULL |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
55 * \param sprite the sprite to initialize |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
56 * \param tex the texture |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
57 * \param cellw the width per cell in pixels |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
58 * \param cellh the height per cell in pixels |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
59 */ |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
60 void |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
61 sprite_init(struct sprite *sprite, |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
62 struct texture *tex, |
46
b815621df3e3
core: remove all fixed width integers, closes #2460
David Demelier <markand@malikania.fr>
parents:
27
diff
changeset
|
63 unsigned int cellw, |
b815621df3e3
core: remove all fixed width integers, closes #2460
David Demelier <markand@malikania.fr>
parents:
27
diff
changeset
|
64 unsigned int cellh); |
5
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
65 |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
66 /** |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
67 * Draw the sprite component from row `r' and column `c'. |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
68 * |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
69 * \pre sprite != NULL |
22
5519ad48822e
doc: add Doxygen documentation, closes #2450
David Demelier <markand@malikania.fr>
parents:
17
diff
changeset
|
70 * \param sprite the sprite to draw |
5
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
71 * \param r the row number |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
72 * \param c the column number |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
73 * \param x the X destination |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
74 * \param y the Y destination |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
75 * \warning No bounds checking |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
76 */ |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
77 void |
46
b815621df3e3
core: remove all fixed width integers, closes #2460
David Demelier <markand@malikania.fr>
parents:
27
diff
changeset
|
78 sprite_draw(struct sprite *sprite, unsigned int r, unsigned int c, int x, int y); |
5
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
79 |
b5c649b6367b
core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
80 #endif /* !MOLKO_SPRITE_H */ |