SDL_TryWaitSemaphore(3)

SDL_TryWaitSemaphore3

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

Usage

#include "SDL3/SDL.h"

bool SDL_TryWaitSemaphore(SDL_Semaphore *sem);

Header file

Defined in SDL3/SDL_mutex.h

Overview

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.

Function parameters

sem

the semaphore to wait on.

Return value

Returns true if the wait succeeds, false if the wait would block.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.