SdlAddTimer

Call a callback function at a future time.

The callback function is passed the current timer interval 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 SdlGetTicksNS or SdlGetPerformanceCounter in case your callback needs to adjust for variances.

Definition

Unit: Neslib.Sdl3.Time

function SdlAddTimer(const AInterval: Integer; const ACallback: TSdlTimerCallback): TSdlTimerID

Parameters

AInterval: Integer : The timer delay, in milliseconds, passed to ACallback.

ACallback: TSdlTimerCallback : The SdlTimerCallback function to call when the specified AInterval elapses.

Returns

TSdlTimerID: A timer ID.

Exceptions

ESdlError: Raised on failure.

See Also

• SdlAddTimerNS
• SdlRemoveTimer

Remarks

It is safe to call this function from any thread.