Lock the mutex.
int SDL_LockMutex(SDL_Mutex *mutex) SDL_ACQUIRE(mutex);| mutex | the mutex to lock |
Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.
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 is available since SDL 3.0.0.
int status;
SDL_mutex *mutex;
mutex = SDL_CreateMutex();
if (!mutex) {
SDL_LogError(SDL_LOG_CATEGORY_APPLICATION, "Couldn't create mutex\n");
return;
}
status = SDL_LockMutex(mutex);
if (status == 0) {
SDL_Log("Locked mutex\n");
SDL_UnlockMutex(mutex);
} else {
SDL_LogError(SDL_LOG_CATEGORY_APPLICATION, "Couldn't lock mutex\n");
}
SDL_DestroyMutex(mutex);