SDL_WaitSemaphoreTimeout(3)

Usage

#include "SDL3/SDL.h"

bool SDL_WaitSemaphoreTimeout(SDL_Semaphore *sem, Sint32 timeoutMS);

Header file

Defined in SDL3/SDL_mutex.h

Overview

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.

Referred to by

SDL_WaitSemaphore(3) Wait until a semaphore has a positive value and then decrements it. SDL_CreateSemaphore(3) Create a semaphore. SDL_SignalSemaphore(3) Atomically increment a semaphore's value and wake waiting threads. SDL_TryWaitSemaphore(3) See if a semaphore has a positive value and decrement it if it does.