SDL_AddTimer(3)

📦
version 3.4.18 · 10 versions
, in fedora 43, fedora 44

💖 SDL_AddTimer(3) 💖

okay bestie, welcome to the SDL3 FUNCTIONS section of the manual — this is the page for SDL_AddTimer, and it's literally the "hey can you come back and do this again later" function. group chat energy: it's giving ⏰ scheduled callback realness ⏰.

✨ NAME ✨

SDL_AddTimer — Call a callback function at a future time.

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_timer.h>

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

🦋 DESCRIPTION 🦋

So here's the tea 🍓: the callback function gets handed the current timer interval and the user-supplied parameter you passed into the SDL_AddTimer() call, and it's supposed to return the next timer interval. And if the value the callback returns is 0? 💀 that's the signal — the timer is canceled and will be removed. bye girl 👋.

The callback runs on a separate thread, and for short timeouts it can potentially be called before this function even returns. yes fr fr, it's that fast. no cap.

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. math queen behavior 👑.

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. ⚠️ don't skip this part bestie, the OS is out here vibing on its own schedule.

🎀 FUNCTION 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. if it flops, call SDL_GetError() for more information. 😭

🔥 THREAD SAFETY 🔥

It is safe to call this function from any thread. iconic, no notes ✨

🌈 AVAILABILITY 🌈

This function is available since SDL 3.2.0. ⭐

👑 SEE ALSO 👑

mwah 💋 that's the whole page, you ate it, periodt. This lil manual moment came to you from Simple Directmedia Layer, running SDL 3.4.18, and the page itself goes by SDL_AddTimer(3) — go forth and schedule something cute 🧚💜

📦 where this page comes from