Mercurial > molko

annotate libcore/core/painter.h @ 228:2734223d3daf

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core: add a alloc_pool module A miniamlist expandable array that gros each time new data is required, ideal where data must be allocated dynamically without knowing in advance the number of items.
author David Demelier <markand@malikania.fr>
date Thu, 19 Nov 2020 14:11:11 +0100
parents 789b23e01f52
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
28
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * painter.h -- basic drawing routines
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2020 David Demelier <markand@malikania.fr>
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef MOLKO_PAINTER_H
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define MOLKO_PAINTER_H
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 /**
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 * \file painter.h
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 * \brief Basic drawing routines.
72
6203e1ac9b18 doc: improve doxygen documentation a lot
David Demelier <markand@malikania.fr>
parents: 59
diff changeset
25 * \ingroup drawing
28
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 */
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 #include <stdbool.h>
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
29
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 struct texture;
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 /**
41
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
33 * Give the current texture being used for rendering, maybe NULL if the
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
34 * rendering is on root.
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
35 *
96
04011a942e3b painter: simplify API
David Demelier <markand@malikania.fr>
parents: 74
diff changeset
36 * \return Texture or NULL.
41
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
37 */
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
38 struct texture *
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
39 painter_get_target(void);
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
40
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
41 /**
28
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 * Set the rendering context to the given texture.
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 *
41
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
44 * Since this function change an internal global variable it is strongly
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
45 * encouraged to store a local backup of the current texture using \a
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
46 * painter_get_target and call this function with it afterwards.
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
47 *
28
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 * If texture is NULL, use default context aka the window.
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 *
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 * \param tex the texture
74
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
51 * \see \ref PAINTER_BEGIN
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
52 * \see \ref PAINTER_END
28
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 */
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 void
41
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
55 painter_set_target(struct texture *tex);
28
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
56
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 /**
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 * Get the current drawing color.
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 *
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 * \return the color in RRGGBBAA format
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 */
46
b815621df3e3 core: remove all fixed width integers, closes #2460
David Demelier <markand@malikania.fr>
parents: 43
diff changeset
62 unsigned long
28
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 painter_get_color(void);
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
64
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 /**
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 * Set the rendering drawing color.
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 *
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 * \param color in RRGGBBAA format
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 */
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 void
46
b815621df3e3 core: remove all fixed width integers, closes #2460
David Demelier <markand@malikania.fr>
parents: 43
diff changeset
71 painter_set_color(unsigned long color);
28
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
72
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 /**
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 * Draw a line.
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 *
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 * \param x1 first X coordinate
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 * \param y1 first Y coordinate
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 * \param x2 second X coordinate
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 * \param y2 second Y coordinate
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
80 */
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 void
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 painter_draw_line(int x1, int y1, int x2, int y2);
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
83
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 /**
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 * Draw a pixel point.
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
86 *
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 * \param x the X coordinate
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
88 * \param y the Y coordinate
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
89 */
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 void
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
91 painter_draw_point(int x, int y);
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
92
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
93 /**
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
94 * Draw a rectangle
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
95 *
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
96 * \param x the X coordinate
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
97 * \param y the Y coordinate
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
98 * \param w the rectangle width
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
99 * \param h the rectangle height
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
100 */
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
101 void
96
04011a942e3b painter: simplify API
David Demelier <markand@malikania.fr>
parents: 74
diff changeset
102 painter_draw_rectangle(int x, int y, unsigned int w, unsigned int h);
28
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
103
121
789b23e01f52 misc: reorganize hierarchy, closes #2490
David Demelier <markand@malikania.fr>
parents: 106
diff changeset
104 /**
789b23e01f52 misc: reorganize hierarchy, closes #2490
David Demelier <markand@malikania.fr>
parents: 106
diff changeset
105 * Draw a circle.
789b23e01f52 misc: reorganize hierarchy, closes #2490
David Demelier <markand@malikania.fr>
parents: 106
diff changeset
106 *
789b23e01f52 misc: reorganize hierarchy, closes #2490
David Demelier <markand@malikania.fr>
parents: 106
diff changeset
107 * \param x the X coordinate
789b23e01f52 misc: reorganize hierarchy, closes #2490
David Demelier <markand@malikania.fr>
parents: 106
diff changeset
108 * \param y the Y coordinate
789b23e01f52 misc: reorganize hierarchy, closes #2490
David Demelier <markand@malikania.fr>
parents: 106
diff changeset
109 * \param radius the radius size
789b23e01f52 misc: reorganize hierarchy, closes #2490
David Demelier <markand@malikania.fr>
parents: 106
diff changeset
110 */
106
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents: 96
diff changeset
111 void
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents: 96
diff changeset
112 painter_draw_circle(int x, int y, int radius);
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents: 96
diff changeset
113
28
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
114 /**
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
115 * Clear the window.
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
116 */
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
117 void
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
118 painter_clear(void);
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
119
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
120 /**
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
121 * Present the window, only call this function one time in the main loop.
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
122 */
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
123 void
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
124 painter_present(void);
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
125
43
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
126 /**
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
127 * Use this macro to start painting on the texture to store the current
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
128 * rendering context and put it back afterwards.
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
129 *
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
130 * \pre tex != NULL
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
131 * \param tex the texture to use
74
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
132 * \see \ref PAINTER_END
43
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
133 */
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
134 #define PAINTER_BEGIN(tex ) \
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
135 do { \
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
136 struct texture *__current_texture__; \
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
137 \
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
138 __current_texture__ = painter_get_target(); \
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
139 painter_set_target((tex))
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
140
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
141 /**
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
142 * Use this macro at the end of rendering into a given texture.
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
143 *
74
4991bf5f2343 core: implement inhibit system, closes #2468 @1h
David Demelier <markand@malikania.fr>
parents: 72
diff changeset
144 * \see \ref PAINTER_BEGIN
43
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
145 */
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
146 #define PAINTER_END() \
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
147 painter_set_target(__current_texture__); \
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
148 } while (0)
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
149
28
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
150 #endif /* !MOLKO_PAINTER_H */