Scroll to navigation

SDL_CondWaitTimeout(3) SDL3 FUNCTIONS SDL_CondWaitTimeout(3)

NAME

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

SYNOPSIS

#include "SDL3/SDL.h"
int SDL_CondWaitTimeout(SDL_cond *cond,
                        SDL_mutex *mutex, Sint32 timeoutMS);

DESCRIPTION

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. Locking the mutex recursively (more than once) is not supported and leads to undefined behavior.

FUNCTION PARAMETERS

the condition variable to wait on
the mutex used to coordinate thread access
the maximum time to wait, in milliseconds, or SDL_MUTEX_MAXWAIT to wait indefinitely

RETURN VALUE

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.

AVAILABILITY

This function is available since SDL 3.0.0.

SEE ALSO

SDL_CondBroadcast(3), SDL_CondSignal(3), SDL_CondWait(3), SDL_CreateCond(3), SDL_DestroyCond(3)

SDL 3.0.0 SDL