SDL::PropertiesLock Class Reference

Lock a group of properties. More...

Public Member Functions
	PropertiesLock (PropertiesRef resource)
	Lock a group of properties.
	PropertiesLock (const PropertiesLock &other)=delete
	Copy constructor.
	PropertiesLock (PropertiesLock &&other) noexcept
	Move constructor.
	~PropertiesLock ()
	Unlock a group of properties.
PropertiesLock &	operator= (const PropertiesLock &other)=delete
PropertiesLock &	operator= (PropertiesLock &&other) noexcept
	Assignment operator.
constexpr	operator bool () const
	True if not locked.
void	reset ()
	Unlock a group of properties.
PropertiesRef	resource () const
	Get the reference to locked resource.
void	release ()
	Releases the lock without unlocking.

Detailed 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.

Returns

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

Thread safety:

It is safe to call this function from any thread.

Since

This function is available since SDL 3.2.0.

See also

Properties.Unlock

Constructor & Destructor Documentation

~PropertiesLock()

SDL::PropertiesLock::~PropertiesLock ( )

inline

Unlock a group of properties.

Thread safety:

It is safe to call this function from any thread.

Since

This function is available since SDL 3.2.0.

See also

Properties.Lock

---

The documentation for this class was generated from the following file:

• SDL3pp/SDL3pp_properties.h