annotate libmlk-core/core/painter.h @ 292:08ab73b32832

misc: add extern "C" {} blocks for C++ friends
author David Demelier <markand@malikania.fr>
date Fri, 05 Mar 2021 10:08:09 +0100
parents c4da052c0def
children 196264679079
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
243
71b3b7036de7 misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
19 #ifndef MOLKO_CORE_PAINTER_H
71b3b7036de7 misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
20 #define MOLKO_CORE_PAINTER_H
28
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 #include <stdbool.h>
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
24 #include "core.h"
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
25
28
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 struct texture;
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
28 CORE_BEGIN_DECLS
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
29
41
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
30 struct texture *
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
31 painter_get_target(void);
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
32
28
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 void
41
3996f873a54b core: implement walksprite, closes #2455
David Demelier <markand@malikania.fr>
parents: 28
diff changeset
34 painter_set_target(struct texture *tex);
28
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
35
46
b815621df3e3 core: remove all fixed width integers, closes #2460
David Demelier <markand@malikania.fr>
parents: 43
diff changeset
36 unsigned long
28
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 painter_get_color(void);
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
38
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 void
46
b815621df3e3 core: remove all fixed width integers, closes #2460
David Demelier <markand@malikania.fr>
parents: 43
diff changeset
40 painter_set_color(unsigned long color);
28
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
41
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 void
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 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
44
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 void
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 painter_draw_point(int x, int y);
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
47
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 void
96
04011a942e3b painter: simplify API
David Demelier <markand@malikania.fr>
parents: 74
diff changeset
49 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
50
106
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents: 96
diff changeset
51 void
ed1a6bb02a78 inventory_dialog: use a small circle as test
David Demelier <markand@malikania.fr>
parents: 96
diff changeset
52 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
53
28
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 void
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 painter_clear(void);
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 void
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 painter_present(void);
783841af4033 core: implement painter API, closes #2451 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
59
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
60 CORE_END_DECLS
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
61
253
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
62 #define PAINTER_BEGIN(tex) \
43
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
63 do { \
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
64 struct texture *__current_texture__; \
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
65 \
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
66 __current_texture__ = painter_get_target(); \
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
67 painter_set_target((tex))
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
68
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
69 #define PAINTER_END() \
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
70 painter_set_target(__current_texture__); \
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
71 } while (0)
291be94202c7 core: add PAINTER_(BEGIN|END) helpers, closes #2456
David Demelier <markand@malikania.fr>
parents: 41
diff changeset
72
243
71b3b7036de7 misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
73 #endif /* !MOLKO_CORE_PAINTER_H */