devela::_dep::sdl3::sys::timer

Function SDL_AddTimer

pub unsafe extern "C" fn SDL_AddTimer(
    interval: u32,
    callback: Option<unsafe extern "C" fn(_: *mut c_void, _: u32, _: u32) -> u32>,
    userdata: *mut c_void,
) -> u32 ⓘ
Available on crate feature dep_sdl3 only.
Expand description

Call a callback function at a future time.

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.

§Parameters

  • interval: the timer delay, in milliseconds, passed to callback.
  • callback: the SDL_TimerCallback function to call when the specified interval elapses.
  • userdata: a pointer that is passed to callback.

§Return value

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

§Thread safety

It is safe to call this function from any thread.

§Availability

This function is available since SDL 3.2.0.

§See also