SDL_CreateMutex(3)

SDL_CreateMutex3

Create a new mutex.

Usage

#include "SDL3/SDL.h"

SDL_Mutex * SDL_CreateMutex(void);

Header file

Defined in SDL3/SDL_mutex.h

Overview

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.

Releases

12 releases since Debian 3.0 (Woody); the text changed 2 times.

  1. 3.0–5.0
  2. 6.0–12
  3. 13

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.