SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_WaitCondition

Wait until a condition variable is signaled.

Header File

Defined in <SDL3/SDL_mutex.h>

Syntax

int 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.

Return Value

(int) Returns 0 when it is signaled or a negative error code on failure; call SDL_GetError() for more information.

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.0.0.

See Also


CategoryAPI, CategoryAPIFunction, CategoryMutex


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.