annotate libmlk-core/mlk/core/state.c @ 580:459ff09c09b3

core: animation can be looped
author David Demelier <markand@malikania.fr>
date Sat, 11 Mar 2023 21:20:33 +0100
parents 7fb5a859bcb4
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
162
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
539
7fb5a859bcb4 core: doxygenize state
David Demelier <markand@malikania.fr>
parents: 469
diff changeset
2 * state.c -- abstract game loop state
162
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
445
773a082f0b91 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 431
diff changeset
4 * Copyright (c) 2020-2023 David Demelier <markand@malikania.fr>
162
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #include <assert.h>
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
20
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 #include "state.h"
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
22
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 void
469
0d6206cee6b9 core: state -> mlk_state
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
24 mlk_state_start(struct mlk_state *state)
162
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 {
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 assert(state);
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 if (state->start)
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 state->start(state);
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 }
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 void
469
0d6206cee6b9 core: state -> mlk_state
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
33 mlk_state_handle(struct mlk_state *state, const union mlk_event *ev)
162
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 {
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 assert(state);
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 assert(ev);
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
37
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 if (state->handle)
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 state->handle(state, ev);
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 }
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
41
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 void
469
0d6206cee6b9 core: state -> mlk_state
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
43 mlk_state_update(struct mlk_state *state, unsigned int ticks)
162
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 {
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 assert(state);
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
46
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 if (state->update)
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 state->update(state, ticks);
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 }
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
50
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 void
469
0d6206cee6b9 core: state -> mlk_state
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
52 mlk_state_draw(struct mlk_state *state)
162
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 {
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 assert(state);
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
55
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 if (state->draw)
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 state->draw(state);
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 }
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
59
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 void
469
0d6206cee6b9 core: state -> mlk_state
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
61 mlk_state_suspend(struct mlk_state *state)
299
648f5f949afb core: implement stackable states
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
62 {
648f5f949afb core: implement stackable states
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
63 assert(state);
648f5f949afb core: implement stackable states
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
64
648f5f949afb core: implement stackable states
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
65 if (state->suspend)
648f5f949afb core: implement stackable states
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
66 state->suspend(state);
648f5f949afb core: implement stackable states
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
67 }
648f5f949afb core: implement stackable states
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
68
648f5f949afb core: implement stackable states
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
69 void
469
0d6206cee6b9 core: state -> mlk_state
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
70 mlk_state_resume(struct mlk_state *state)
299
648f5f949afb core: implement stackable states
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
71 {
648f5f949afb core: implement stackable states
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
72 assert(state);
648f5f949afb core: implement stackable states
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
73
648f5f949afb core: implement stackable states
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
74 if (state->resume)
648f5f949afb core: implement stackable states
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
75 state->resume(state);
648f5f949afb core: implement stackable states
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
76 }
648f5f949afb core: implement stackable states
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
77
648f5f949afb core: implement stackable states
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
78 void
469
0d6206cee6b9 core: state -> mlk_state
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
79 mlk_state_end(struct mlk_state *state)
162
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
80 {
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 assert(state);
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
82
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 if (state->end)
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 state->end(state);
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 }
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
86
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 void
469
0d6206cee6b9 core: state -> mlk_state
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
88 mlk_state_finish(struct mlk_state *state)
162
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
89 {
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 assert(state);
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
91
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
92 if (state->finish)
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
93 state->finish(state);
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents:
diff changeset
94 }