Mercurial > molko

annotate src/sprite.h @ 18:3ddd3acfe0e9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: add .clang
author David Demelier <markand@malikania.fr>
date Wed, 08 Jan 2020 13:25:17 +0100
parents fc71221b7bee
children 5519ad48822e
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
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.
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 */
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 #include <stdint.h>
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 struct texture;
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 /**
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 * \brief Sprite structure.
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 */
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 struct sprite {
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 struct texture *texture; /* Texture to access (RO) */
7
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents: 5
diff changeset
36 uint16_t cellw; /* Width per cell (RW) */
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents: 5
diff changeset
37 uint16_t cellh; /* Height per cell (RW) */
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents: 5
diff changeset
38 uint16_t nrows; /* Number of rows (RW) */
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents: 5
diff changeset
39 uint16_t ncols; /* Number of columns (RW) */
5
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 /**
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 * Initialize a sprite.
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 * 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
46 * sprite is no longer used.
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 *
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 * 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
49 * sprite by itself if wanted.
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 *
7
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents: 5
diff changeset
51 * 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
52 * texture size.
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents: 5
diff changeset
53 *
5
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 * \pre sprite != NULL
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 * \pre tex != NULL
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 * \param sprite the sprite to initialize
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 * \param tex the texture
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 * \param cellw the width per cell in pixels
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 * \param cellh the height per cell in pixels
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 void
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 sprite_init(struct sprite *sprite,
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 struct texture *tex,
7
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents: 5
diff changeset
64 uint16_t cellw,
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents: 5
diff changeset
65 uint16_t cellh);
5
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 /**
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 * Draw the sprite component from row `r' and column `c'.
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 *
b5c649b6367b core: implement sprites, closes #2440
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 * \pre sprite != NULL
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
7
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents: 5
diff changeset
78 sprite_draw(struct sprite *sprite, uint16_t r, uint16_t 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 */