7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
10 TITLE="SDL Library Documentation"
11 HREF="index.html"><LINK
14 HREF="time.html"><LINK
16 TITLE="SDL_RemoveTimer"
17 HREF="sdlremovetimer.html"></HEAD
28 SUMMARY="Header navigation table"
37 >SDL Library Documentation</TH
45 HREF="sdlremovetimer.html"
76 >SDL_SetTimer -- Set a callback to run after the specified number of milliseconds has
79 CLASS="REFSYNOPSISDIV"
93 CLASS="FUNCSYNOPSISINFO"
94 >#include "SDL.h"</PRE
103 >(Uint32 interval, SDL_TimerCallback callback);</CODE
112 NAME="SDLTIMERCALLBACK"
117 >/* Function prototype for the timer callback function */
118 typedef Uint32 (*SDL_TimerCallback)(Uint32 interval);</P
128 >Set a callback to run after the specified number of milliseconds has
129 elapsed. The callback function is passed the current timer interval
130 and returns the next timer interval. If the returned value is the
131 same as the one passed in, the periodic alarm continues, otherwise a
132 new alarm is scheduled.</P
134 >To cancel a currently running timer, call
137 >SDL_SetTimer(0, NULL);</TT
140 >The timer callback function may run in a different thread than your
141 main constant, and so shouldn't call any functions from within itself.</P
143 >The maximum resolution of this timer is 10 ms, which means that if
144 you request a 16 ms timer, your callback will run approximately 20 ms
145 later on an unloaded system. If you wanted to set a flag signaling
146 a frame update at 30 frames per second (every 33 ms), you might set a
147 timer for 30 ms (see example below).</P
149 >If you use this function, you need to pass <TT
164 >This function is kept for compatibility but has been superseded
165 by the new timer functions
167 HREF="sdladdtimer.html"
171 HREF="sdlremovetimer.html"
187 CLASS="PROGRAMLISTING"
188 >SDL_SetTimer((33/10)*10, my_callback);</PRE
200 HREF="sdladdtimer.html"
212 SUMMARY="Footer navigation table"
223 HREF="sdlremovetimer.html"