Function sdl2_sys::SDL_SemWait

source ·
pub unsafe extern "C" fn SDL_SemWait(sem: *mut SDL_sem) -> c_int
Expand description

Wait until a semaphore has a positive value and then decrements it.

This function suspends the calling thread until either the semaphore pointed to by sem has a positive value or the call is interrupted by a signal or error. If the call is successful it will atomically decrement the semaphore value.

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

\param sem the semaphore wait on \returns 0 on success 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_CreateSemaphore \sa SDL_DestroySemaphore \sa SDL_SemPost \sa SDL_SemTryWait \sa SDL_SemValue \sa SDL_SemWait \sa SDL_SemWaitTimeout