Mercurial > molko

annotate libmlk-core/mlk/core/clock.h @ 586:4349b591c3ac

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
cmake: put NLS back
author David Demelier <markand@malikania.fr>
date Sat, 18 Mar 2023 20:05:58 +0100
parents 6e8f6640e05b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * clock.h -- track elapsed time
3054723e53d7 core: implement clock, closes #2443
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>
6
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
3054723e53d7 core: implement clock, closes #2443
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_CLOCK_H
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
20 #define MLK_CORE_CLOCK_H
6
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
512
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
22 /**
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
23 * \file mlk/core/clock.h
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
24 * \brief Track elapsed time
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
25 *
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
26 * This simple module provide functions to keep track of elapsed time.
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
27 *
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
28 * It is mostly used in the game loop because most objects in the overall API
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
29 * get the frame ticks instead.
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
30 */
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
31
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
32 /**
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
33 * \struct mlk_clock
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
34 * \brief Clock structure
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
35 *
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
36 * This structure is non-opaque but has no public fields.
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
37 */
421
3edda1ce314c core: remove mlk_ prefix for now
David Demelier <markand@malikania.fr>
parents: 378
diff changeset
38 struct mlk_clock {
512
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
39 /** \cond MLK_PRIVATE_DECLS */
253
c4da052c0def core: goodbye doxygen
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
40 unsigned int ticks;
512
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
41 /** \endcond MLK_PRIVATE_DECLS */
6
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 };
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
43
517
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 512
diff changeset
44 #if defined(__cplusplus)
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 512
diff changeset
45 extern "C" {
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 512
diff changeset
46 #endif
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
47
512
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
48 /**
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
49 * Start or reset the clock.
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
50 *
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
51 * \pre clock != NULL
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
52 * \param clock the clock timer
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
53 */
6
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 void
512
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
55 mlk_clock_start(struct mlk_clock *clock);
6
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
56
512
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
57 /**
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
58 * Returns the number of elapsed milliseconds since last call to
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
59 * ::mlk_clock_start.
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
60 *
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
61 * \pre clock != NULL
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
62 * \param clock the clock timer
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
63 * \return the number of elapsed milliseconds
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
64 */
46
b815621df3e3 core: remove all fixed width integers, closes #2460
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
65 unsigned int
512
9877e34bb6eb core: doxygenize clock
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
66 mlk_clock_elapsed(const struct mlk_clock *clock);
6
3054723e53d7 core: implement clock, closes #2443
David Demelier <markand@malikania.fr>
parents:
diff changeset
67
517
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 512
diff changeset
68 #if defined(__cplusplus)
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 512
diff changeset
69 }
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 512
diff changeset
70 #endif
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 253
diff changeset
71
366
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
72 #endif /* !MLK_CORE_CLOCK_H */