Mercurial > molko

annotate libmlk-core/mlk/core/action.h @ 509:a11cd7ea3a37

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core: doxygenize action
author David Demelier <markand@malikania.fr>
date Sat, 04 Mar 2023 08:52:57 +0100
parents c1f64d451230
children 6e8f6640e05b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
57
9f6267843815 core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
2 * action.h -- generic in game actions
57
9f6267843815 core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
445
773a082f0b91 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 441
diff changeset
4 * Copyright (c) 2020-2023 David Demelier <markand@malikania.fr>
57
9f6267843815 core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
9f6267843815 core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
9f6267843815 core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
9f6267843815 core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
9f6267843815 core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
9f6267843815 core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9f6267843815 core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9f6267843815 core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
9f6267843815 core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
9f6267843815 core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
9f6267843815 core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
9f6267843815 core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
9f6267843815 core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
9f6267843815 core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
366
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
19 #ifndef MLK_CORE_ACTION_H
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
20 #define MLK_CORE_ACTION_H
57
9f6267843815 core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
22 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
23 * \file mlk/core/action.h
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
24 * \brief Generic in game actions.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
25 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
26 * This module help creating user interaction within the gameplay by adding
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
27 * actions. They have the following properties:
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
28 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
29 * - Can handle user input and events,
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
30 * - Can be updated through the game loop,
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
31 * - Can be drawn.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
32 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
33 * Most more high level objects can handle actions to add flexibility (like in
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
34 * battles, maps, etc).
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
35 */
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
36
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
37 #include "core.h"
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
38
450
b26dd49f69ff core: event -> mlk_event (and friends)
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
39 union mlk_event;
57
9f6267843815 core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
40
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
41 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
42 * \struct mlk_action
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
43 * \brief Action structure
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
44 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
45 * Use this structure to create an action that may handle input, be updated and
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
46 * drawn.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
47 */
441
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents: 431
diff changeset
48 struct mlk_action {
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
49 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
50 * (read-write, borrowed, optional)
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
51 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
52 * Arbitrary user data.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
53 */
57
9f6267843815 core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 void *data;
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
55
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
56 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
57 * (optional)
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
58 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
59 * Start the action.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
60 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
61 * Use this function when the action should start.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
62 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
63 * \param self this action
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
64 */
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
65 void (*start)(struct mlk_action *self);
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
66
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
67 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
68 * (optional)
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
69 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
70 * Handle an event.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
71 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
72 * \param self this action
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
73 * \param event the event
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
74 */
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
75 void (*handle)(struct mlk_action *self, const union mlk_event *event);
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
76
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
77 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
78 * (optional)
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
79 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
80 * Update the action with the given ticks since last frame.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
81 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
82 * The callback should return non-zero if it is considered complete.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
83 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
84 * \param self this action
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
85 * \param ticks frame ticks
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
86 * \return non-zero if complete
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
87 */
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
88 int (*update)(struct mlk_action *self, unsigned int ticks);
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
89
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
90 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
91 * (optional)
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
92 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
93 * Draw the action.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
94 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
95 * \param self this action
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
96 */
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
97 void (*draw)(struct mlk_action *self);
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
98
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
99 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
100 * (optional)
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
101 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
102 * Terminate the action.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
103 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
104 * In contrast to finish, this function should be called after the
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
105 * action was considered complete.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
106 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
107 * \param self this action
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
108 */
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
109 void (*end)(struct mlk_action *self);
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
110
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
111 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
112 * (optional)
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
113 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
114 * Dispose resources allocated by/for the action.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
115 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
116 * \param self this action
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
117 */
441
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents: 431
diff changeset
118 void (*finish)(struct mlk_action *);
57
9f6267843815 core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
119 };
9f6267843815 core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff changeset
120
462
5729efd23286 core: core -> mlk_core
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
121 MLK_CORE_BEGIN_DECLS
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
122
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
123 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
124 * Invoke ::mlk_action::start function if not null.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
125 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
126 * \pre action != NULL
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
127 * \param action the action
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
128 */
480
c1f64d451230 core: mlk_action has a start callback
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
129 void
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
130 mlk_action_start(struct mlk_action *action);
136
30b68089ae70 core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
131
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
132 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
133 * Invoke ::mlk_action::handle function if not null.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
134 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
135 * \pre action != NULL
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
136 * \param action the action
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
137 * \param event the event
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
138 */
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
139 void
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
140 mlk_action_handle(struct mlk_action *action, const union mlk_event *event);
136
30b68089ae70 core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
141
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
142 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
143 * Invoke ::mlk_action::update function if not null.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
144 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
145 * \pre action != NULL
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
146 * \param action the action
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
147 * \param ticks frame ticks
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
148 */
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
149 int
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
150 mlk_action_update(struct mlk_action *action, unsigned int ticks);
136
30b68089ae70 core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
151
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
152 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
153 * Invoke ::mlk_action::draw function if not null.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
154 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
155 * \pre action != NULL
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
156 * \param action the action
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
157 */
136
30b68089ae70 core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
158 void
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
159 mlk_action_draw(struct mlk_action *action);
136
30b68089ae70 core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
160
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
161 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
162 * Invoke ::mlk_action::end function if not null.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
163 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
164 * \pre action != NULL
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
165 * \param action the action
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
166 */
136
30b68089ae70 core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
167 void
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
168 mlk_action_end(struct mlk_action *action);
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
169
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
170 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
171 * Invoke ::mlk_action::finish function if not null.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
172 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
173 * \pre action != NULL
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
174 * \param action the action
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
175 */
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
176 void
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
177 mlk_action_finish(struct mlk_action *action);
136
30b68089ae70 core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
178
462
5729efd23286 core: core -> mlk_core
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
179 MLK_CORE_END_DECLS
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
180
366
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
181 #endif /* !MLK_CORE_ACTION_H */