Man page - sdl_createsemaphore(3)

Packages contains this manual

Manual

SDL_CreateSemaphore

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
FUNCTION PARAMETERS
RETURN VALUE
AVAILABILITY
SEE ALSO

NAME

SDL_CreateSemaphore - Create a semaphore.

HEADER FILE

Defined in SDL3/SDL_mutex.h

SYNOPSIS

#include "SDL3/SDL.h"

SDL_Semaphore * SDL_CreateSemaphore(Uint32 initial_value);

DESCRIPTION

This function creates a new semaphore and initializes it with the value initial_value . Each wait operation on the semaphore will atomically decrement the semaphore value and potentially block if the semaphore value is 0. Each post operation will atomically increment the semaphore value and wake waiting threads and allow them to retry the wait operation.

FUNCTION PARAMETERS

initial_value

the starting value of the semaphore.

RETURN VALUE

( SDL_Semaphore
*) Returns a new semaphore or NULL on failure; call SDL_GetError () for more information.

AVAILABILITY

This function is available since SDL 3.2.0.

SEE ALSO

• (3), SDL_DestroySemaphore (3), • (3), SDL_SignalSemaphore (3), • (3), SDL_TryWaitSemaphore (3), • (3), SDL_GetSemaphoreValue (3), • (3), SDL_WaitSemaphore (3), • (3), SDL_WaitSemaphoreTimeout (3)