SDL_WaitSemaphoreTimeout(3)

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

✨ SDL_WaitSemaphoreTimeout(3) ✨

okay bestie, welcome to the SDL3 FUNCTIONS corner of the man pages, where we learn how to make threads politely take turns 🎀

🌸 NAME 🌸

SDL_WaitSemaphoreTimeout — wait until a semaphore has a positive value and then decrements it.

no cap, that's literally the whole vibe. it waits, and then it takes one. 💅

🦋 SYNOPSIS 🦋

#include <SDL3/SDL_mutex.h>

bool SDL_WaitSemaphoreTimeout(SDL_Semaphore *sem, Sint32 timeoutMS);

💖 DESCRIPTION 💖

okay so here's the tea: this function suspends the calling thread — like, puts it in time-out, napping, not doing anything — until one of two things happens:

  • the semaphore pointed to by sem has a positive value, or
  • the specified time has elapsed.

and the way that it's atomic about the decrement? iconic. if the call is successful it will atomically decrement the semaphore value, meaning nobody can sneak in and mess with it mid-step. it's giving main character energy, it's giving thread-safe precision, it's giving 🫶

🎀 FUNCTION PARAMETERS 🎀

  • sem — the semaphore to wait on. that's your girl, the one you're queuing up for.
  • timeoutMS — the length of the timeout, in milliseconds, or -1 to wait indefinitely. yes, -1 means "bestie i will wait forever, take your time" 😭

⭐ RETURN VALUE ⭐

Returns true if the wait succeeds, or false if the wait times out.

that's it. that's the whole report card. no extra lore, no hidden fields. 💀

🔥 THREAD SAFETY 🔥

It is safe to call this function from any thread. any thread!! every thread!! the whole group chat can call it and nothing bad happens. periodt. 👑

🌈 AVAILABILITY 🌈

This function is available since SDL 3.2.0. so if you're on something older, sorry babes, you're not invited to this party 🙈

💜 SEE ALSO 💜

go read those too, they're the supporting cast and they ate. 🍓

Simple Directmedia Layer · SDL 3.4.18 · SDL_WaitSemaphoreTimeout(3)

mwah, that's a wrap bestie 🧚✨ go forth and semaphore responsibly, and remember: atomic decrements are the love language 💖

📦 where this page comes from