(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_TryWaitSemaphore

See if a semaphore has a positive value and decrement it if it does.

Header File

Syntax

bool SDL_TryWaitSemaphore(SDL_Semaphore *sem);

Function Parameters

SDL_Semaphore *

sem

the semaphore to wait on.

Return Value

(bool) Returns true if the wait succeeds, false if the wait would block.

Remarks

This function checks to see if the semaphore pointed to by sem has a positive value and atomically decrements the semaphore value if it does. If the semaphore doesn't have a positive value, the function immediately returns false.

Version

This function is available since SDL 3.1.3.