]>
Commit | Line | Data |
---|---|---|
7407ac7f BB |
1 | /* |
2 | Simple DirectMedia Layer | |
3 | Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org> | |
4 | ||
5 | This software is provided 'as-is', without any express or implied | |
6 | warranty. In no event will the authors be held liable for any damages | |
7 | arising from the use of this software. | |
8 | ||
9 | Permission is granted to anyone to use this software for any purpose, | |
10 | including commercial applications, and to alter it and redistribute it | |
11 | freely, subject to the following restrictions: | |
12 | ||
13 | 1. The origin of this software must not be misrepresented; you must not | |
14 | claim that you wrote the original software. If you use this software | |
15 | in a product, an acknowledgment in the product documentation would be | |
16 | appreciated but is not required. | |
17 | 2. Altered source versions must be plainly marked as such, and must not be | |
18 | misrepresented as being the original software. | |
19 | 3. This notice may not be removed or altered from any source distribution. | |
20 | */ | |
21 | ||
22 | #ifndef _SDL_timer_h | |
23 | #define _SDL_timer_h | |
24 | ||
25 | /** | |
26 | * \file SDL_timer.h | |
27 | * | |
28 | * Header for the SDL time management routines. | |
29 | */ | |
30 | ||
31 | #include "SDL_stdinc.h" | |
32 | #include "SDL_error.h" | |
33 | ||
34 | #include "begin_code.h" | |
35 | /* Set up for C function definitions, even when using C++ */ | |
36 | #ifdef __cplusplus | |
37 | extern "C" { | |
38 | #endif | |
39 | ||
40 | /** | |
41 | * \brief Get the number of milliseconds since the SDL library initialization. | |
42 | * | |
43 | * \note This value wraps if the program runs for more than ~49 days. | |
44 | */ | |
45 | extern DECLSPEC Uint32 SDLCALL SDL_GetTicks(void); | |
46 | ||
47 | /** | |
48 | * \brief Get the current value of the high resolution counter | |
49 | */ | |
50 | extern DECLSPEC Uint64 SDLCALL SDL_GetPerformanceCounter(void); | |
51 | ||
52 | /** | |
53 | * \brief Get the count per second of the high resolution counter | |
54 | */ | |
55 | extern DECLSPEC Uint64 SDLCALL SDL_GetPerformanceFrequency(void); | |
56 | ||
57 | /** | |
58 | * \brief Wait a specified number of milliseconds before returning. | |
59 | */ | |
60 | extern DECLSPEC void SDLCALL SDL_Delay(Uint32 ms); | |
61 | ||
62 | /** | |
63 | * Function prototype for the timer callback function. | |
64 | * | |
65 | * The callback function is passed the current timer interval and returns | |
66 | * the next timer interval. If the returned value is the same as the one | |
67 | * passed in, the periodic alarm continues, otherwise a new alarm is | |
68 | * scheduled. If the callback returns 0, the periodic alarm is cancelled. | |
69 | */ | |
70 | typedef Uint32 (SDLCALL * SDL_TimerCallback) (Uint32 interval, void *param); | |
71 | ||
72 | /** | |
73 | * Definition of the timer ID type. | |
74 | */ | |
75 | typedef int SDL_TimerID; | |
76 | ||
77 | /** | |
78 | * \brief Add a new timer to the pool of timers already running. | |
79 | * | |
80 | * \return A timer ID, or NULL when an error occurs. | |
81 | */ | |
82 | extern DECLSPEC SDL_TimerID SDLCALL SDL_AddTimer(Uint32 interval, | |
83 | SDL_TimerCallback callback, | |
84 | void *param); | |
85 | ||
86 | /** | |
87 | * \brief Remove a timer knowing its ID. | |
88 | * | |
89 | * \return A boolean value indicating success or failure. | |
90 | * | |
91 | * \warning It is not safe to remove a timer multiple times. | |
92 | */ | |
93 | extern DECLSPEC SDL_bool SDLCALL SDL_RemoveTimer(SDL_TimerID id); | |
94 | ||
95 | ||
96 | /* Ends C function definitions when using C++ */ | |
97 | #ifdef __cplusplus | |
98 | } | |
99 | #endif | |
100 | #include "close_code.h" | |
101 | ||
102 | #endif /* _SDL_timer_h */ | |
103 | ||
104 | /* vi: set ts=4 sw=4 expandtab: */ |