Function sdl2_sys::SDL_SemTryWait

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

See if a semaphore has a positive value and decrement it if it does.

This function checks to see if the semaphore pointed to by sem has a positive value and atomically decrements the semaphore value if it does. If the semaphore doesn’t have a positive value, the function immediately returns SDL_MUTEX_TIMEDOUT.

\param sem the semaphore to wait on \returns 0 if the wait succeeds, SDL_MUTEX_TIMEDOUT if the wait would block, 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_SemValue \sa SDL_SemWait \sa SDL_SemWaitTimeout