SDL_WaitSemaphoreTimeout - Man Page
Wait until a semaphore has a positive value and then decrements it.
Header File
Defined in SDL3/SDL_mutex.h
Synopsis
#include "SDL3/SDL.h" bool SDL_WaitSemaphoreTimeout(SDL_Semaphore *sem, Sint32 timeoutMS);
Description
This function suspends the calling thread until either the semaphore pointed to by sem has a positive value or the specified time has elapsed. If the call is successful it will atomically decrement the semaphore value.
Function Parameters
- sem
the semaphore to wait on.
- timeoutMS
the length of the timeout, in milliseconds, or -1 to wait indefinitely.
Return Value
Returns true if the wait succeeds or false if the wait times out.
Availability
This function is available since SDL 3.2.0.
See Also
·(3), SDL_SignalSemaphore(3), ·(3), SDL_TryWaitSemaphore(3), ·(3), SDL_WaitSemaphore(3)
Referenced By
SDL_CreateSemaphore(3), SDL_SignalSemaphore(3), SDL_TryWaitSemaphore(3), SDL_WaitSemaphore(3).
SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS