SDL_TimerCallback.3type - Man Page
Function prototype for the millisecond timer callback function.
Header File
Defined in SDL3/SDL_timer.h
Synopsis
#include "SDL3/SDL.h" typedef Uint32 (SDLCALL *SDL_TimerCallback)(void *userdata, SDL_TimerID timerID, Uint32 interval);
Description
The callback function is passed the current timer interval and returns the next timer interval, in milliseconds. If the returned value is the same as the one passed in, the periodic alarm continues, otherwise a new alarm is scheduled. If the callback returns 0, the periodic alarm is canceled and will be removed.
Function Parameters
- userdata
an arbitrary pointer provided by the app through SDL_AddTimer , for its own use.
- timerID
the current timer being processed.
- interval
the current callback time interval.
Return Value
Returns the new callback time interval, or 0 to disable further runs of the callback.
Thread Safety
SDL may call this callback at any time from a background thread; the application is responsible for locking resources the callback touches that need to be protected.
Availability
This datatype is available since SDL 3.2.0.
See Also
·(3), SDL_AddTimer(3)