(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_LockMutex

Lock the mutex.

Header File

Syntax

void SDL_LockMutex(SDL_Mutex *mutex);

Function Parameters

SDL_Mutex *

mutex

the mutex to lock.

Remarks

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.

Version

This function is available since SDL 3.1.3.