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

SDL_WaitCondition

Wait until a condition variable is signaled.

Header File

Syntax

void SDL_WaitCondition(SDL_Condition *cond, SDL_Mutex *mutex);

Function Parameters

SDL_Condition *	cond	the condition variable to wait on.
SDL_Mutex *	mutex	the mutex used to coordinate thread access.

Remarks

This function unlocks the specified mutex and waits for another thread to call SDL_SignalCondition() or SDL_BroadcastCondition() on the condition variable cond. Once the condition variable is signaled, the mutex is re-locked and the function returns.

The mutex must be locked before calling this function. Locking the mutex recursively (more than once) is not supported and leads to undefined behavior.

This function is the equivalent of calling SDL_WaitConditionTimeout() with a time length of -1.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.1.3.