Mercurial > molko

annotate libmlk-core/mlk/core/drawable-stack.h @ 646:7e1eb7f6c049 default tip @

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: remove .clang
author David Demelier <markand@malikania.fr>
date Sun, 04 Feb 2024 15:24:37 +0100
parents 75944708c55c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
368
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
518
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
2 * drawable-stack.h -- convenient stack of drawable objects
368
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
445
773a082f0b91 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 431
diff changeset
4 * Copyright (c) 2020-2023 David Demelier <markand@malikania.fr>
368
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef MLK_CORE_DRAWABLE_STACK_H
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define MLK_CORE_DRAWABLE_STACK_H
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
518
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
22 /**
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
23 * \file mlk/core/drawable-stack.h
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
24 * \brief Convenient stack of drawable objects
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
25 */
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
26
393
b172b10bbe1c core: do the same for drawables
David Demelier <markand@malikania.fr>
parents: 378
diff changeset
27 #include <stddef.h>
b172b10bbe1c core: do the same for drawables
David Demelier <markand@malikania.fr>
parents: 378
diff changeset
28
518
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
29 /**
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
30 * \struct mlk_drawable_stack
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
31 * \brief Drawable stack structure
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
32 */
449
f2f0e73ea9da core: drawable -> mlk_drawable
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
33 struct mlk_drawable_stack {
518
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
34 /**
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
35 * (read-write, borrowed)
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
36 *
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
37 * Array of non-owning drawables to draw.
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
38 */
449
f2f0e73ea9da core: drawable -> mlk_drawable
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
39 struct mlk_drawable **objects;
518
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
40
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
41 /**
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
42 * (read-write)
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
43 *
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
44 * Number of drawables in array ::mlk_drawable_stack::objects.
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
45 *
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
46 * \warning changing this value must be kept in sync with the array
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
47 * dimension.
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
48 */
393
b172b10bbe1c core: do the same for drawables
David Demelier <markand@malikania.fr>
parents: 378
diff changeset
49 size_t objectsz;
368
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 };
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
51
517
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 516
diff changeset
52 #if defined(__cplusplus)
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 516
diff changeset
53 extern "C" {
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 516
diff changeset
54 #endif
368
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
55
518
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
56 /**
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
57 * Initialize the drawable stack.
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
58 *
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
59 * This function will set all pointers in the ::mlk_drawable_stack::objects to
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
60 * NULL.
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
61 *
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
62 * \pre stack != NULL
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
63 * \param stack the drawable stack
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
64 */
368
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 void
518
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
66 mlk_drawable_stack_init(struct mlk_drawable_stack *stack);
368
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
67
518
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
68 /**
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
69 * Try to append a new drawable into the stack if one slot in the
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
70 * ::mlk_drawable_stack::objects is NULL
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
71 *
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
72 * The object is inserted as-is and ownership is left to the caller.
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
73 *
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
74 * \pre stack != NULL
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
75 * \param stack the drawable stack
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
76 * \param drawable the object to append
548
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 519
diff changeset
77 * \return 0 on success or -1 on error
518
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
78 */
368
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 int
518
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
80 mlk_drawable_stack_add(struct mlk_drawable_stack *stack,
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
81 struct mlk_drawable *drawable);
368
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
82
518
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
83 /**
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
84 * Tells if there are still at least one drawable in the stack.
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
85 *
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
86 * \pre stack != NULL
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
87 * \param stack the drawable stack
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
88 */
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
89 int
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
90 mlk_drawable_stack_completed(const struct mlk_drawable_stack *stack);
368
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
91
518
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
92 /**
519
8b603a7e048a core: doxygenize drawable
David Demelier <markand@malikania.fr>
parents: 518
diff changeset
93 * Invoke ::mlk_drawable_update on all drawables.
518
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
94 *
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
95 * \pre stack != NULL
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
96 * \param stack the drawable stack
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
97 * \param ticks frame ticks
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
98 * \return non-zero if completed
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
99 */
368
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
100 int
518
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
101 mlk_drawable_stack_update(struct mlk_drawable_stack *stack, unsigned int ticks);
368
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
102
518
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
103 /**
519
8b603a7e048a core: doxygenize drawable
David Demelier <markand@malikania.fr>
parents: 518
diff changeset
104 * Invoke ::mlk_drawable_update on all drawables.
518
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
105 *
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
106 * \pre stack != NULL
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
107 * \param stack the drawable stack
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
108 */
368
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
109 void
518
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
110 mlk_drawable_stack_draw(struct mlk_drawable_stack *stack);
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
111
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
112 /**
519
8b603a7e048a core: doxygenize drawable
David Demelier <markand@malikania.fr>
parents: 518
diff changeset
113 * Invoke ::mlk_drawable_finish on all drawables left.
518
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
114 *
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
115 * \pre stack != NULL
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
116 * \param stack the drawable stack
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
117 */
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
118 void
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
119 mlk_drawable_stack_finish(struct mlk_drawable_stack *stack);
368
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
120
517
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 516
diff changeset
121 #if defined(__cplusplus)
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 516
diff changeset
122 }
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 516
diff changeset
123 #endif
368
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
124
15bdac29ba4b core: split drawable and drawable_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
125 #endif /* !MLK_CORE_DRAWABLE_STACK_H */