(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_AddTimer

Call a callback function at a future time.

Header File

Syntax

SDL_TimerID SDL_AddTimer(Uint32 interval, SDL_TimerCallback callback, void *userdata);

Function Parameters

Uint32	interval	the timer delay, in milliseconds, passed to `callback`.
SDL_TimerCallback	callback	the SDL_TimerCallback function to call when the specified `interval` elapses.
void *	userdata	a pointer that is passed to `callback`.

Return Value

(SDL_TimerID) Returns a timer ID or 0 on failure; call SDL_GetError() for more information.

Remarks

The callback function is passed the current timer interval and the user supplied parameter from the SDL_AddTimer() call and should return the next timer interval. If the value returned from the callback is 0, the timer is canceled and will be removed.

The callback is run on a separate thread, and for short timeouts can potentially be called before this function returns.

Timers take into account the amount of time it took to execute the callback. For example, if the callback took 250 ms to execute and returned 1000 (ms), the timer would only wait another 750 ms before its next iteration.

Timing may be inexact due to OS scheduling. Be sure to note the current time with SDL_GetTicksNS() or SDL_GetPerformanceCounter() in case your callback needs to adjust for variances.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.1.3.