annotate libmlk-adventure/adventure/state/splashscreen.h @ 243:71b3b7036de7

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 libadventure/adventure/state/splashscreen.h@629f55f3961e
children 16be1ad3ddba
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
59
52792b863ff7 misc: separate core from game
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
162
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
2 * splashscreen.h -- splash screen state
59
52792b863ff7 misc: separate core from game
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
52792b863ff7 misc: separate core from game
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2020 David Demelier <markand@malikania.fr>
52792b863ff7 misc: separate core from game
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
52792b863ff7 misc: separate core from game
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
52792b863ff7 misc: separate core from game
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
52792b863ff7 misc: separate core from game
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
52792b863ff7 misc: separate core from game
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
52792b863ff7 misc: separate core from game
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
52792b863ff7 misc: separate core from game
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
52792b863ff7 misc: separate core from game
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
52792b863ff7 misc: separate core from game
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
52792b863ff7 misc: separate core from game
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
52792b863ff7 misc: separate core from game
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
52792b863ff7 misc: separate core from game
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
52792b863ff7 misc: separate core from game
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
52792b863ff7 misc: separate core from game
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
243
71b3b7036de7 misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents: 162
diff changeset
19 #ifndef MOLKO_ADVENTURE_STATE_SPLASHSCREEN_H
71b3b7036de7 misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents: 162
diff changeset
20 #define MOLKO_ADVENTURE_STATE_SPLASHSCREEN_H
59
52792b863ff7 misc: separate core from game
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
52792b863ff7 misc: separate core from game
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 /**
162
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
23 * \file splashscreen.h
59
52792b863ff7 misc: separate core from game
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 * \brief Splash screen state.
52792b863ff7 misc: separate core from game
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 */
52792b863ff7 misc: separate core from game
David Demelier <markand@malikania.fr>
parents:
diff changeset
26
80
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents: 63
diff changeset
27 /**
162
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
28 * Create a state for showing a splashcreen.
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
29 *
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
30 * \pre state != NULL
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
31 * \pre next != NULL
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
32 * \param state the state to initialize
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
33 * \param next the next state once it's finished
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
34 * \post state->data is set internal data
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
35 * \post state->draw is set
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
36 * \post state->update is set
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
37 * \post state->finish is set
80
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents: 63
diff changeset
38 */
162
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
39 void
629f55f3961e core: rework states
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
40 splashscreen_state(struct state *state, struct state *next);
80
05ffbcdee585 adventure: create main menu, closes #2482 @4h
David Demelier <markand@malikania.fr>
parents: 63
diff changeset
41
243
71b3b7036de7 misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents: 162
diff changeset
42 #endif /* !MOLKO_ADVENTURE_STATE_SPLASHSCREEN_H */