My Project
SDL_timer.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2020 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 
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 
45 extern DECLSPEC Uint32 SDLCALL SDL_GetTicks(void);
46 
56 #define SDL_TICKS_PASSED(A, B) ((Sint32)((B) - (A)) <= 0)
57 
61 extern DECLSPEC Uint64 SDLCALL SDL_GetPerformanceCounter(void);
62 
66 extern DECLSPEC Uint64 SDLCALL SDL_GetPerformanceFrequency(void);
67 
71 extern DECLSPEC void SDLCALL SDL_Delay(Uint32 ms);
72 
81 typedef Uint32 (SDLCALL * SDL_TimerCallback) (Uint32 interval, void *param);
82 
86 typedef int SDL_TimerID;
87 
93 extern DECLSPEC SDL_TimerID SDLCALL SDL_AddTimer(Uint32 interval,
94  SDL_TimerCallback callback,
95  void *param);
96 
104 extern DECLSPEC SDL_bool SDLCALL SDL_RemoveTimer(SDL_TimerID id);
105 
106 
107 /* Ends C function definitions when using C++ */
108 #ifdef __cplusplus
109 }
110 #endif
111 #include "close_code.h"
112 
113 #endif /* SDL_timer_h_ */
114 
115 /* vi: set ts=4 sw=4 expandtab: */
DECLSPEC Uint32 SDLCALL SDL_GetTicks(void)
Get the number of milliseconds since the SDL library initialization.
DECLSPEC Uint64 SDLCALL SDL_GetPerformanceCounter(void)
Get the current value of the high resolution counter.
Uint32(SDLCALL * SDL_TimerCallback)(Uint32 interval, void *param)
Definition: SDL_timer.h:81
int SDL_TimerID
Definition: SDL_timer.h:86
DECLSPEC Uint64 SDLCALL SDL_GetPerformanceFrequency(void)
Get the count per second of the high resolution counter.
DECLSPEC SDL_TimerID SDLCALL SDL_AddTimer(Uint32 interval, SDL_TimerCallback callback, void *param)
Add a new timer to the pool of timers already running.
DECLSPEC void SDLCALL SDL_Delay(Uint32 ms)
Wait a specified number of milliseconds before returning.
DECLSPEC SDL_bool SDLCALL SDL_RemoveTimer(SDL_TimerID id)
Remove a timer knowing its ID.