Function sdl2_sys::SDL_CreateMutex

source ·
pub unsafe extern "C" fn SDL_CreateMutex() -> *mut SDL_mutex
Expand description

Create a new mutex.

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.

\returns the initialized and unlocked mutex or NULL on failure; call SDL_GetError() for more information.

\since This function is available since SDL 2.0.0.

\sa SDL_DestroyMutex \sa SDL_LockMutex \sa SDL_TryLockMutex \sa SDL_UnlockMutex