devela::_dep::sdl3::sys::mutex

Function SDL_WaitSemaphoreTimeout

pub unsafe extern "C" fn SDL_WaitSemaphoreTimeout(
    sem: *mut SDL_Semaphore,
    timeoutMS: i32,
) -> bool
Available on crate feature dep_sdl3 only.
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 specified time has elapsed. If the call is successful it will atomically decrement the semaphore value.

§Parameters

  • sem: the semaphore to wait on.
  • timeoutMS: the length of the timeout, in milliseconds, or -1 to wait indefinitely.

§Return value

Returns true if the wait succeeds or false if the wait times out.

§Availability

This function is available since SDL 3.2.0.

§See also