plucky (3) SDL_LockMutex.3.gz

Provided by: libsdl3-doc_3.2.4+ds-2_all bug

NAME

       SDL_LockMutex - Lock the mutex.

HEADER FILE

       Defined in SDL3/SDL_mutex.h

SYNOPSIS

       #include "SDL3/SDL.h"

       void SDL_LockMutex(SDL_Mutex *mutex);

DESCRIPTION

       This  will block until the mutex is available, which is to say it is in the unlocked state and the OS has
       chosen the caller as the next thread to lock it. Of all threads waiting to lock the mutex, only  one  may
       do so at a time.

       It  is  legal for the owning thread to lock an already-locked mutex. It must unlock it the same number of
       times before it is actually made available for other threads in the system (this is known as a "recursive
       mutex").

       This  function  does not fail; if mutex is NULL, it will return immediately having locked nothing. If the
       mutex is valid, this function will always block until it can lock the mutex, and return with it locked.

FUNCTION PARAMETERS

       mutex  the mutex to lock.

AVAILABILITY

       This function is available since SDL 3.2.0.

SEE ALSO

       (3), SDL_TryLockMutex(3), (3), SDL_UnlockMutex(3)