Function sdl2_sys::SDL_CondWait

pub unsafe extern "C" fn SDL_CondWait(
    cond: *mut SDL_cond,
    mutex: *mut SDL_mutex,
) -> c_int

Wait until a condition variable is signaled.

This function unlocks the specified mutex and waits for another thread to call SDL_CondSignal() or SDL_CondBroadcast() 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.

This function is the equivalent of calling SDL_CondWaitTimeout() with a time length of SDL_MUTEX_MAXWAIT.

\param cond the condition variable to wait on \param mutex the mutex used to coordinate thread access \returns 0 when it is signaled or a negative error code on failure; call SDL_GetError() for more information.

\since This function is available since SDL 2.0.0.

\sa SDL_CondBroadcast \sa SDL_CondSignal \sa SDL_CondWaitTimeout \sa SDL_CreateCond \sa SDL_DestroyCond