devela::_dep::sdl3::sys::everything

Function SDL_LockProperties

pub unsafe extern "C" fn SDL_LockProperties(props: u32) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Lock a group of properties.

Obtain a multi-threaded lock for these properties. Other threads will wait while trying to lock these properties until they are unlocked. Properties must be unlocked before they are destroyed.

The lock is automatically taken when setting individual properties, this function is only needed when you want to set several properties atomically or want to guarantee that properties being queried aren’t freed in another thread.

§Parameters

  • props: the properties to lock.

§Return value

Returns true on success or false on failure; call SDL_GetError() for more information.

§Thread safety

It is safe to call this function from any thread.

§Availability

This function is available since SDL 3.2.0.

§See also