Mercurial > molko

annotate libcore/core/animation.h @ 127:6691c9f69028

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core: animation_update now returns true when complete
author David Demelier <markand@malikania.fr>
date Tue, 06 Oct 2020 13:52:52 +0200
parents 789b23e01f52
children 30b68089ae70
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * animation.h -- basic animations
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2020 David Demelier <markand@malikania.fr>
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef MOLKO_ANIMATION_H
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define MOLKO_ANIMATION_H
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 /**
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 * \file animation.h
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 * \brief Basic animations.
72
6203e1ac9b18 doc: improve doxygen documentation a lot
David Demelier <markand@malikania.fr>
parents: 59
diff changeset
25 * \ingroup drawing
7
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 */
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 #include <stdbool.h>
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
29
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 struct sprite;
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 /**
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 * \brief Animation object
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 */
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 struct animation {
127
6691c9f69028 core: animation_update now returns true when complete
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
36 struct sprite *sprite; /*!< (RW, ref) Sprite to use. */
6691c9f69028 core: animation_update now returns true when complete
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
37 unsigned int row; /*!< (RO) Current row. */
6691c9f69028 core: animation_update now returns true when complete
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
38 unsigned int column; /*!< (RO) Current column. */
6691c9f69028 core: animation_update now returns true when complete
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
39 unsigned int delay; /*!< (RO) Delay between frames. */
6691c9f69028 core: animation_update now returns true when complete
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
40 unsigned int elapsed; /*!< (RO) Elapsed time since last frame. */
7
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 };
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
42
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 /**
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 * Initialize the animation.
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 *
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 * The animation does not take sprite ownership, it must be valid until
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 * animation is no longer used.
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 *
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 * \pre an != NULL
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 * \pre sprite != NULL
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 * \param an the animation
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 * \param sprite the sprite to use
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 * \param delay the delay between frames in milliseconds
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 */
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 void
46
b815621df3e3 core: remove all fixed width integers, closes #2460
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
56 animation_init(struct animation *an, struct sprite *sprite, unsigned int delay);
7
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
57
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 /**
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 * Start an animation.
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 *
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 * \pre an != NULL
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 * \param an the animation
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 */
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 void
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 animation_start(struct animation *an);
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
66
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 /**
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 * Update the animation.
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 *
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 * You must call this function at each loop iteration to update the animation
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 * frame depending on its delay.
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 *
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 * \pre an != NULL
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 * \param an the animation
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 * \param ticks the elapsed ticks since the last call
127
6691c9f69028 core: animation_update now returns true when complete
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
76 * \return true if the animation is complete
7
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 */
127
6691c9f69028 core: animation_update now returns true when complete
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
78 bool
46
b815621df3e3 core: remove all fixed width integers, closes #2460
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
79 animation_update(struct animation *an, unsigned int ticks);
7
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
80
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 /**
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 * Draw the animation.
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 *
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 * \pre an != NULL
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 * \param an the animation
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
86 * \param x the X coordinate
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 * \param y the Y coordinate
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
88 */
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
89 void
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 animation_draw(struct animation *an, int x, int y);
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
91
fbb7101b7bd8 core: implement animations, closes #2439
David Demelier <markand@malikania.fr>
parents:
diff changeset
92 #endif /* !MOLKO_ANIMATION_H */