Function sdl2_sys::SDL_CondWaitTimeout

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

Wait until a condition variable is signaled or a certain time has passed.

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

The mutex must be locked before calling this function.

\param cond the condition variable to wait on \param mutex the mutex used to coordinate thread access \param ms the maximum time to wait, in milliseconds, or SDL_MUTEX_MAXWAIT to wait indefinitely \returns 0 if the condition variable is signaled, SDL_MUTEX_TIMEDOUT if the condition is not signaled in the allotted time, 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_CondWait \sa SDL_CreateCond \sa SDL_DestroyCond