SDL_TimerCallback - Function prototype for the millisecond timer callback function.
Contents
Availability
This datatype is available since SDL 3.2.0.
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.
Header File
Defined in SDL3/SDL_timer.h
Name
SDL_TimerCallback - Function prototype for the millisecond timer callback function.
Return Value
Returns the new callback time interval, or 0 to disable further runs of the callback.
See Also
•(3), SDL_AddTimer(3) Simple Directmedia Layer SDL 3.2.10 SDL_TimerCallback(3type)
Synopsis
#include"SDL3/SDL.h"typedefUint32(SDLCALL*SDL_TimerCallback)(void*userdata,SDL_TimerIDtimerID,Uint32interval);
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.
