table of contents
- experimental 3.1.0+ds-1
SDL_WaitSemaphoreTimeout(3) | SDL3 FUNCTIONS | SDL_WaitSemaphoreTimeout(3) |
NAME¶
SDL_WaitSemaphoreTimeout - Wait until a semaphore has a positive value and then decrements it.
SYNOPSIS¶
#include "SDL3/SDL.h"
int 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, the call is interrupted by a signal or error, or the specified time has elapsed. If the call is successful it will atomically decrement the semaphore value.
FUNCTION PARAMETERS¶
RETURN VALUE¶
Returns 0 if the wait succeeds, SDL_MUTEX_TIMEDOUT if the wait does not succeed in the allotted time, or a negative error code on failure; call SDL_GetError () for more information.
AVAILABILITY¶
This function is available since SDL 3.0.0.
SEE ALSO¶
SDL_PostSemaphore(3), SDL_TryWaitSemaphore(3), SDL_WaitSemaphore(3)
SDL 3.1.0 | SDL |