1SDL_SetTimer(3) SDL API Reference SDL_SetTimer(3)
2
3
4
6 SDL_SetTimer - Set a callback to run after the specified number of mil‐
7 liseconds has elapsed.
8
10 #include "SDL.h"
11
12 int SDL_SetTimer(Uint32 interval, SDL_TimerCallback callback);
13
15 /* Function prototype for the timer callback function */ typedef Uint32
16 (*SDL_TimerCallback)(Uint32 interval);
17
19 Set a callback to run after the specified number of milliseconds has
20 elapsed. The callback function is passed the current timer interval and
21 returns the next timer interval. If the returned value is the same as
22 the one passed in, the periodic alarm continues, otherwise a new alarm
23 is scheduled.
24
25 To cancel a currently running timer, call SDL_SetTimer(0, NULL);
26
27 The timer callback function may run in a different thread than your
28 main constant, and so shouldn't call any functions from within itself.
29
30 The maximum resolution of this timer is 10 ms, which means that if you
31 request a 16 ms timer, your callback will run approximately 20 ms later
32 on an unloaded system. If you wanted to set a flag signaling a frame
33 update at 30 frames per second (every 33 ms), you might set a timer for
34 30 ms (see example below).
35
36 If you use this function, you need to pass SDL_INIT_TIMER to
37 SDL_Init().
38
39 Note:
40
41 This function is kept for compatibility but has been superseded
42 by the new timer functions SDL_AddTimer and SDL_RemoveTimer
43 which support multiple timers.
44
46 SDL_SetTimer((33/10)*10, my_callback);
47
49 SDL_AddTimer
50
51
52
53SDL Tue 11 Sep 2001, 23:01 SDL_SetTimer(3)