devela::_dep::sdl3::sys::mutex

Function SDL_WaitCondition

pub unsafe extern "C" fn SDL_WaitCondition(
    cond: *mut SDL_Condition,
    mutex: *mut SDL_Mutex,
)
Available on crate feature dep_sdl3 only.
Expand description

Wait until a condition variable is signaled.

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.

§Parameters

  • cond: the condition variable to wait on.
  • mutex: the mutex used to coordinate thread access.

§Thread safety

It is safe to call this function from any thread.

§Availability

This function is available since SDL 3.2.0.

§See also