plucky (3) SDL_CreateMutex.3.gz

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

NAME

       SDL_CreateMutex - Create a new mutex.

HEADER FILE

       Defined in SDL3/SDL_mutex.h

SYNOPSIS

       #include "SDL3/SDL.h"

       SDL_Mutex * SDL_CreateMutex(void);

DESCRIPTION

       All newly-created mutexes begin in the _unlocked_ state.

       Calls  to  SDL_LockMutex  ()  will  not  return  while  the  mutex  is  locked  by  another  thread.  See
       SDL_TryLockMutex () to attempt to lock without blocking.

       SDL mutexes are reentrant.

RETURN VALUE

       ( SDL_Mutex
        *) Returns the initialized and unlocked mutex  or  NULL  on  failure;  call  SDL_GetError  ()  for  more
       information.

AVAILABILITY

       This function is available since SDL 3.2.0.

SEE ALSO

       (3), SDL_DestroyMutex(3), (3), SDL_LockMutex(3), (3), SDL_TryLockMutex(3), (3), SDL_UnlockMutex(3)