NAME¶

SDL_LockProperties - Lock a group of properties.

HEADER FILE¶

Defined in SDL3/SDL_properties.h

SYNOPSIS¶

#include "SDL3/SDL.h"

bool SDL_LockProperties(SDL_PropertiesID props);

DESCRIPTION¶

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.

FUNCTION 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.1.3.

SEE ALSO¶

•(3), SDL_UnlockProperties(3)