annotate examples/example-notify/example-notify.c @ 522:f45a023f6690

core: doxygenize game
author David Demelier <markand@malikania.fr>
date Sat, 04 Mar 2023 16:47:54 +0100
parents 7f7602bae0bd
children c7664b679a95
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
415
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * example-notify -- show how notifications work
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
445
773a082f0b91 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 433
diff changeset
4 * Copyright (c) 2020-2023 David Demelier <markand@malikania.fr>
415
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #include <assert.h>
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
20
431
8f59201dc76b core: cleanup hierarchy
David Demelier <markand@malikania.fr>
parents: 415
diff changeset
21 #include <mlk/core/core.h>
8f59201dc76b core: cleanup hierarchy
David Demelier <markand@malikania.fr>
parents: 415
diff changeset
22 #include <mlk/core/event.h>
8f59201dc76b core: cleanup hierarchy
David Demelier <markand@malikania.fr>
parents: 415
diff changeset
23 #include <mlk/core/game.h>
8f59201dc76b core: cleanup hierarchy
David Demelier <markand@malikania.fr>
parents: 415
diff changeset
24 #include <mlk/core/image.h>
8f59201dc76b core: cleanup hierarchy
David Demelier <markand@malikania.fr>
parents: 415
diff changeset
25 #include <mlk/core/painter.h>
8f59201dc76b core: cleanup hierarchy
David Demelier <markand@malikania.fr>
parents: 415
diff changeset
26 #include <mlk/core/panic.h>
8f59201dc76b core: cleanup hierarchy
David Demelier <markand@malikania.fr>
parents: 415
diff changeset
27 #include <mlk/core/state.h>
8f59201dc76b core: cleanup hierarchy
David Demelier <markand@malikania.fr>
parents: 415
diff changeset
28 #include <mlk/core/texture.h>
8f59201dc76b core: cleanup hierarchy
David Demelier <markand@malikania.fr>
parents: 415
diff changeset
29 #include <mlk/core/util.h>
8f59201dc76b core: cleanup hierarchy
David Demelier <markand@malikania.fr>
parents: 415
diff changeset
30 #include <mlk/core/window.h>
415
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
433
862b15c3a3ae ui: cleanup hierarchy
David Demelier <markand@malikania.fr>
parents: 431
diff changeset
32 #include <mlk/ui/notify.h>
862b15c3a3ae ui: cleanup hierarchy
David Demelier <markand@malikania.fr>
parents: 431
diff changeset
33 #include <mlk/ui/label.h>
862b15c3a3ae ui: cleanup hierarchy
David Demelier <markand@malikania.fr>
parents: 431
diff changeset
34 #include <mlk/ui/ui.h>
415
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
35
486
d6757c30658e core: rework errors
David Demelier <markand@malikania.fr>
parents: 485
diff changeset
36 #include <mlk/example/example.h>
d6757c30658e core: rework errors
David Demelier <markand@malikania.fr>
parents: 485
diff changeset
37 #include <mlk/example/registry.h>
415
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
38
493
fce3b3c4b496 ui: label -> mlk_label
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
39 static struct mlk_label help = {
415
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 .text = "Keys: <Space> to generate a notification.",
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 .x = 10,
508
7f7602bae0bd examples: minor touches
David Demelier <markand@malikania.fr>
parents: 500
diff changeset
42 .y = 10
415
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 };
486
d6757c30658e core: rework errors
David Demelier <markand@malikania.fr>
parents: 485
diff changeset
44 static struct mlk_texture *icon;
415
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
45
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 static void
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 init(void)
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 {
486
d6757c30658e core: rework errors
David Demelier <markand@malikania.fr>
parents: 485
diff changeset
49 int err;
d6757c30658e core: rework errors
David Demelier <markand@malikania.fr>
parents: 485
diff changeset
50
d6757c30658e core: rework errors
David Demelier <markand@malikania.fr>
parents: 485
diff changeset
51 if ((err = mlk_example_init("example-notify")) < 0)
d6757c30658e core: rework errors
David Demelier <markand@malikania.fr>
parents: 485
diff changeset
52 mlk_panicf("mlk_example_init: %s", mlk_err_string(err));
d6757c30658e core: rework errors
David Demelier <markand@malikania.fr>
parents: 485
diff changeset
53
500
d7855791a2b8 examples: prefix mlk
David Demelier <markand@malikania.fr>
parents: 498
diff changeset
54 icon = &mlk_registry_textures[MLK_REGISTRY_TEXTURE_SWORD];
415
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 }
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
56
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 static void
469
0d6206cee6b9 core: state -> mlk_state
David Demelier <markand@malikania.fr>
parents: 465
diff changeset
58 handle(struct mlk_state *st, const union mlk_event *ev)
415
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 {
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 (void)st;
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
61
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 switch (ev->type) {
459
541cb950997b examples: add libmlk-example library
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
63 case MLK_EVENT_QUIT:
541cb950997b examples: add libmlk-example library
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
64 mlk_game_quit();
415
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 break;
459
541cb950997b examples: add libmlk-example library
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
66 case MLK_EVENT_KEYDOWN:
541cb950997b examples: add libmlk-example library
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
67 if (ev->key.key == MLK_KEY_SPACE)
494
35cc5d51bcb2 ui: notify -> mlk_notify
David Demelier <markand@malikania.fr>
parents: 493
diff changeset
68 mlk_notify(icon, "Quest", "Quest finished.");
415
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 break;
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 default:
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 break;
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 }
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 }
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
74
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 static void
469
0d6206cee6b9 core: state -> mlk_state
David Demelier <markand@malikania.fr>
parents: 465
diff changeset
76 update(struct mlk_state *st, unsigned int ticks)
415
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 {
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 (void)st;
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
79
494
35cc5d51bcb2 ui: notify -> mlk_notify
David Demelier <markand@malikania.fr>
parents: 493
diff changeset
80 mlk_notify_update(ticks);
415
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 }
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
82
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 static void
469
0d6206cee6b9 core: state -> mlk_state
David Demelier <markand@malikania.fr>
parents: 465
diff changeset
84 draw(struct mlk_state *st)
415
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 {
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
86 (void)st;
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
87
508
7f7602bae0bd examples: minor touches
David Demelier <markand@malikania.fr>
parents: 500
diff changeset
88 mlk_painter_set_color(MLK_EXAMPLE_BG);
459
541cb950997b examples: add libmlk-example library
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
89 mlk_painter_clear();
493
fce3b3c4b496 ui: label -> mlk_label
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
90 mlk_label_draw(&help);
494
35cc5d51bcb2 ui: notify -> mlk_notify
David Demelier <markand@malikania.fr>
parents: 493
diff changeset
91 mlk_notify_draw();
459
541cb950997b examples: add libmlk-example library
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
92 mlk_painter_present();
415
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
93 }
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
94
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
95 static void
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
96 run(void)
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
97 {
469
0d6206cee6b9 core: state -> mlk_state
David Demelier <markand@malikania.fr>
parents: 465
diff changeset
98 struct mlk_state state = {
415
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
99 .handle = handle,
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
100 .update = update,
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
101 .draw = draw
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
102 };
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
103
522
f45a023f6690 core: doxygenize game
David Demelier <markand@malikania.fr>
parents: 508
diff changeset
104 mlk_game_init();
459
541cb950997b examples: add libmlk-example library
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
105 mlk_game_push(&state);
541cb950997b examples: add libmlk-example library
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
106 mlk_game_loop();
415
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
107 }
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
108
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
109 static void
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
110 quit(void)
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
111 {
498
41267f6e344d examples: use mlk_example_finish
David Demelier <markand@malikania.fr>
parents: 497
diff changeset
112 mlk_example_finish();
415
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
113 }
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
114
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
115 int
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
116 main(int argc, char **argv)
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
117 {
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
118 (void)argc;
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
119 (void)argv;
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
120
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
121 init();
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
122 run();
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
123 quit();
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
124
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
125 return 0;
a5b98db4fd87 misc: fix .hgignore too greedy
David Demelier <markand@malikania.fr>
parents:
diff changeset
126 }