sdlLockProperties function

bool sdlLockProperties(int props)

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.

\param props the properties to lock. \returns true on success or false on failure; call SDL_GetError() for more information.

\threadsafety It is safe to call this function from any thread.

\since This function is available since SDL 3.1.3.

\sa SDL_UnlockProperties

extern SDL_DECLSPEC bool SDLCALL SDL_LockProperties(SDL_PropertiesID props)

Implementation

bool sdlLockProperties(int props) {
  final sdlLockPropertiesLookupFunction = libSdl3.lookupFunction<
      Uint8 Function(Uint32 props),
      int Function(int props)>('SDL_LockProperties');
  return sdlLockPropertiesLookupFunction(props) == 1;
}