Mercurial > molko

annotate libmlk-core/core/sprite.h @ 243:71b3b7036de7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: lot of cleanups, - prefix libraries with libmlk, - move assets from source directories closes #2520, - prefix header guards closes #2519
author David Demelier <markand@malikania.fr>
date Sat, 28 Nov 2020 22:37:30 +0100
parents libcore/core/sprite.h@4ad7420ab678
children c4da052c0def
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
243
71b3b7036de7 misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents: 192
diff changeset
19 #ifndef MOLKO_CORE_SPRITE_H
71b3b7036de7 misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents: 192
diff changeset
20 #define MOLKO_CORE_SPRITE_H
5
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
166
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
26 *
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
27 * The sprite is a module to help rendering a large image that is split into
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
28 * individual parts. This improves memory usage as several images are loaded
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
29 * in a unique one instead of individual parts.
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
30 *
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
31 * Example of sprite.
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
32 *
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
33 * ```
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
34 * +---+---+---+
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
35 * | 0 | 1 | 2 |
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
36 * +---+---+---+
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
37 * | 3 | 4 | 5 |
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
38 * +---+---+---+
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
39 * ```
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
40 *
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
41 * If an image is designed like this grid, it contains three columns and 2 rows.
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
42 *
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
43 * \note The image may not contain space, margins or padding within each cell.
5
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 */
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
45
166
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
46 #include <stdbool.h>
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
47
5
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 struct texture;
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
49
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 /**
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 * \brief Sprite structure.
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 */
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 struct sprite {
147
b386d25832c8 doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents: 128
diff changeset
54 struct texture *texture; /*!< (+&) Texture to access. */
b386d25832c8 doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents: 128
diff changeset
55 unsigned int cellw; /*!< (-) Width per cell. */
b386d25832c8 doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents: 128
diff changeset
56 unsigned int cellh; /*!< (-) Height per cell. */
b386d25832c8 doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents: 128
diff changeset
57 unsigned int nrows; /*!< (-) Number of rows. */
b386d25832c8 doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents: 128
diff changeset
58 unsigned int ncols; /*!< (-) Number of columns. */
5
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
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 /**
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 * Initialize a sprite.
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 *
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 * 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
65 * sprite is no longer used.
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 * 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
68 * sprite by itself if wanted.
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 *
7
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents: 5
diff changeset
70 * 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
71 * texture size.
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents: 5
diff changeset
72 *
5
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 * \pre sprite != NULL
94
ed72843a7194 core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
74 * \pre tex != NULL && texture_ok(tex)
5
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 * \param sprite the sprite to initialize
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 * \param tex the texture
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 * \param cellw the width per cell in pixels
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 * \param cellh the height per cell in pixels
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 void
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 sprite_init(struct sprite *sprite,
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 struct texture *tex,
46
b815621df3e3 core: remove all fixed width integers, closes #2460
David Demelier <markand@malikania.fr>
parents: 27
diff changeset
83 unsigned int cellw,
b815621df3e3 core: remove all fixed width integers, closes #2460
David Demelier <markand@malikania.fr>
parents: 27
diff changeset
84 unsigned int cellh);
5
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
85
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
86 /**
166
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
87 * Tells if the sprite has a texture and isn't null sized.
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
88 *
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
89 * \param sprite the sprite to check (may be NULL)
169
eb0a7ab71023 misc: extreme cleanup, closes #2506
David Demelier <markand@malikania.fr>
parents: 166
diff changeset
90 * \return True if it is initialized correctly.
166
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
91 */
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
92 bool
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
93 sprite_ok(const struct sprite *sprite);
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
94
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
95 /**
5
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
96 * Draw the sprite component from row `r' and column `c'.
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
97 *
166
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
98 * \pre r < sprite->nrows
e8c3ea4fe5d2 core: add sprite_ok function, closes #2505
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
99 * \pre c < sprite->ncols
5
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
100 * \pre sprite != NULL
22
5519ad48822e doc: add Doxygen documentation, closes #2450
David Demelier <markand@malikania.fr>
parents: 17
diff changeset
101 * \param sprite the sprite to draw
5
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
102 * \param r the row number
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
103 * \param c the column number
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
104 * \param x the X destination
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
105 * \param y the Y destination
169
eb0a7ab71023 misc: extreme cleanup, closes #2506
David Demelier <markand@malikania.fr>
parents: 166
diff changeset
106 * \return False in case of rendering error.
5
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
107 */
169
eb0a7ab71023 misc: extreme cleanup, closes #2506
David Demelier <markand@malikania.fr>
parents: 166
diff changeset
108 bool
192
4ad7420ab678 rpg: add minimalist battle system, continue #2477 @60h
David Demelier <markand@malikania.fr>
parents: 169
diff changeset
109 sprite_draw(const 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
110
243
71b3b7036de7 misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents: 192
diff changeset
111 #endif /* !MOLKO_CORE_SPRITE_H */