annotate libmlk-core/core/window.h @ 253:c4da052c0def

core: goodbye doxygen
author David Demelier <markand@malikania.fr>
date Thu, 03 Dec 2020 09:06:52 +0100
parents 37771eaf4245
children 08ab73b32832
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * window.h -- basic window management
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2020 David Demelier <markand@malikania.fr>
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
243
71b3b7036de7 misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents: 226
diff changeset
19 #ifndef MOLKO_CORE_WINDOW_H
71b3b7036de7 misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents: 226
diff changeset
20 #define MOLKO_CORE_WINDOW_H
0
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #include <stdbool.h>
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
97
58133933ea17 window: expose some data to avoid functions
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
24 struct window {
253
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 248
diff changeset
25 unsigned int w;
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 248
diff changeset
26 unsigned int h;
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 248
diff changeset
27 unsigned int framerate;
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 248
diff changeset
28 void *handle;
97
58133933ea17 window: expose some data to avoid functions
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
29 };
58133933ea17 window: expose some data to avoid functions
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
30
163
4bbfcd9180a8 core: add window_set_cursor function, closes #2502
David Demelier <markand@malikania.fr>
parents: 156
diff changeset
31 enum window_cursor {
253
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 248
diff changeset
32 WINDOW_CURSOR_ARROW,
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 248
diff changeset
33 WINDOW_CURSOR_EDIT,
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 248
diff changeset
34 WINDOW_CURSOR_WAIT,
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 248
diff changeset
35 WINDOW_CURSOR_CROSSHAIR,
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 248
diff changeset
36 WINDOW_CURSOR_SIZE,
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 248
diff changeset
37 WINDOW_CURSOR_NO,
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 248
diff changeset
38 WINDOW_CURSOR_HAND,
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 248
diff changeset
39 WINDOW_CURSOR_LAST
163
4bbfcd9180a8 core: add window_set_cursor function, closes #2502
David Demelier <markand@malikania.fr>
parents: 156
diff changeset
40 };
4bbfcd9180a8 core: add window_set_cursor function, closes #2502
David Demelier <markand@malikania.fr>
parents: 156
diff changeset
41
97
58133933ea17 window: expose some data to avoid functions
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
42 extern struct window window;
58133933ea17 window: expose some data to avoid functions
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
43
2
832c20d6cce9 core: make window singleton for convenience (textures)
David Demelier <markand@malikania.fr>
parents: 1
diff changeset
44 bool
226
dd7c8d4321a3 misc: miscellaneous cleanups
David Demelier <markand@malikania.fr>
parents: 169
diff changeset
45 window_open(const char *title, unsigned int width, unsigned int height);
1
03f6d572fd17 core: implement basic drawing, closes #2438
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
46
163
4bbfcd9180a8 core: add window_set_cursor function, closes #2502
David Demelier <markand@malikania.fr>
parents: 156
diff changeset
47 void
4bbfcd9180a8 core: add window_set_cursor function, closes #2502
David Demelier <markand@malikania.fr>
parents: 156
diff changeset
48 window_set_cursor(enum window_cursor cursor);
4bbfcd9180a8 core: add window_set_cursor function, closes #2502
David Demelier <markand@malikania.fr>
parents: 156
diff changeset
49
0
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 void
97
58133933ea17 window: expose some data to avoid functions
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
51 window_finish(void);
0
efcc908bca21 core: implement basic windowing, closes #2437
David Demelier <markand@malikania.fr>
parents:
diff changeset
52
243
71b3b7036de7 misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents: 226
diff changeset
53 #endif /* !MOLKO_CORE_WINDOW_H */