annotate libmlk-example/mlk/example/trace-hud.h @ 459:541cb950997b

examples: add libmlk-example library
author David Demelier <markand@malikania.fr>
date Sun, 26 Feb 2023 19:44:47 +0100
parents examples/example/trace_hud.h@773a082f0b91
children 2af25db99273
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
364
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * trace_hud.h -- on screen hud
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
445
773a082f0b91 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 441
diff changeset
4 * Copyright (c) 2020-2023 David Demelier <markand@malikania.fr>
364
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef EXAMPLES_TRACE_TRACE_HUD_H
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define EXAMPLES_TRACE_TRACE_HUD_H
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #define TRACE_HUD_TIMEOUT_DEFAULT (3000)
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 struct action;
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 struct theme;
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
26
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 struct trace_hud {
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 struct theme *theme;
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 unsigned int timeout;
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 };
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 extern struct trace_hud trace_hud;
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
33
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 void
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 trace_hud_handler(const char *);
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
36
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 void
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 trace_hud_update(unsigned int);
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
39
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 void
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 trace_hud_draw(void);
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
42
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 void
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 trace_hud_clear(void);
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
45
441
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents: 414
diff changeset
46 struct mlk_action *
364
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 trace_hud_action(void);
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
48
570ab19bf268 misc: start removing adventure from library
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 #endif /* !EXAMPLES_TRACE_TRACE_HUD_H */