Mercurial > molko
comparison libmlk-core/mlk/core/action-stack.h @ 518:47f0fe6f6581
core: doxygenize drawable-stack
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sat, 04 Mar 2023 14:42:03 +0100 |
parents | 6e8f6640e05b |
children | 75944708c55c |
comparison
equal
deleted
inserted
replaced
517:6e8f6640e05b | 518:47f0fe6f6581 |
---|---|
51 struct mlk_action **actions; | 51 struct mlk_action **actions; |
52 | 52 |
53 /** | 53 /** |
54 * (read-write) | 54 * (read-write) |
55 * | 55 * |
56 * Number of actions in array ::mlk_action_script::actions | 56 * Number of actions in array ::mlk_action_stack::actions |
57 * | 57 * |
58 * \warning changing this value must be kept in sync with the array | 58 * \warning changing this value must be kept in sync with the array |
59 * dimension. | 59 * dimension. |
60 */ | 60 */ |
61 size_t actionsz; | 61 size_t actionsz; |
64 #if defined(__cplusplus) | 64 #if defined(__cplusplus) |
65 extern "C" { | 65 extern "C" { |
66 #endif | 66 #endif |
67 | 67 |
68 /** | 68 /** |
69 * Initialize the action sequence structure. | 69 * Initialize the action stack structure. |
70 * | 70 * |
71 * This function will set all pointers in the ::mlk_action_stack::actions to | 71 * This function will set all pointers in the ::mlk_action_stack::actions to |
72 * NULL. | 72 * NULL. |
73 * | 73 * |
74 * \pre stack != NULL | 74 * \pre stack != NULL |
127 * Invoke ::mlk_action_update on all actions. | 127 * Invoke ::mlk_action_update on all actions. |
128 * | 128 * |
129 * \pre stack != NULL | 129 * \pre stack != NULL |
130 * \param stack the action stack | 130 * \param stack the action stack |
131 * \param ticks frame ticks | 131 * \param ticks frame ticks |
132 * \return non-zero if completed | |
132 */ | 133 */ |
133 int | 134 int |
134 mlk_action_stack_update(struct mlk_action_stack *stack, | 135 mlk_action_stack_update(struct mlk_action_stack *stack, |
135 unsigned int ticks); | 136 unsigned int ticks); |
136 | 137 |
142 */ | 143 */ |
143 void | 144 void |
144 mlk_action_stack_draw(const struct mlk_action_stack *stack); | 145 mlk_action_stack_draw(const struct mlk_action_stack *stack); |
145 | 146 |
146 /** | 147 /** |
148 * Invoke ::mlk_action_finish on all actions left. | |
147 * | 149 * |
148 * \pre stack != NULL | 150 * \pre stack != NULL |
149 * \param stack the action stack | 151 * \param stack the action stack |
150 */ | 152 */ |
151 void | 153 void |