SDL::Mutex Struct Reference

Handle to an owned mutex. More...

Inheritance diagram for SDL::Mutex:

Public Member Functions
void	Destroy ()
	Destroy a mutex created with Mutex.Create().
MutexShared	share ()
	Move this mutex into a MutexShared.
constexpr	ResourceUnique (std::nullptr_t=nullptr)
	Default constructor.
constexpr	ResourceUnique (base::value_type value, DELETER deleter={})
	Constructs from raw type.
constexpr	ResourceUnique (ResourceUnique &&other)
	Move constructor.
	ResourceUnique (const ResourceUnique &other)=delete
Public Member Functions inherited from SDL::ResourceUnique< MutexRef >
constexpr	ResourceUnique (std::nullptr_t=nullptr)
	Default constructor.
constexpr	ResourceUnique (base::value_type value, DefaultDeleter< MutexRef > deleter={})
	Constructs from raw type.
constexpr	ResourceUnique (ResourceUnique &&other)
	Move constructor.
	ResourceUnique (const ResourceUnique &other)=delete
	~ResourceUnique ()
	Destructor.
constexpr ResourceUnique &	operator= (ResourceUnique other)
	Assignment operator.
void	reset ()
	Resets the value, destroying the resource if not nullptr.
Public Member Functions inherited from SDL::ResourceOwnerBase< RESOURCE, DELETER >
RESOURCE	release ()
	Returns reference and reset this.
Public Member Functions inherited from SDL::ResourcePtrBase< RESOURCE >
constexpr	operator bool () const
	Check if not null.
constexpr bool	operator== (const ResourcePtrBase &other) const
	Comparison.
constexpr bool	operator== (std::nullptr_t) const
	Comparison.
constexpr bool	operator== (std::nullopt_t) const
	Comparison.
constexpr reference	operator* () const
	Gets reference.
constexpr const reference *	operator-> () const
	Gets addressable reference.
constexpr reference *	operator-> ()
	Gets addressable reference.
reference	get () const
	Get reference.

Static Public Member Functions
static Mutex	Create ()
	Create a new mutex.

Additional Inherited Members
Public Types inherited from SDL::ResourceOwnerBase< RESOURCE, DELETER >
using	deleter = DELETER
	The deleter type.
Public Types inherited from SDL::ResourcePtrBase< RESOURCE >
using	reference = RESOURCE
	The reference resource type.
using	value_type = typename reference::value_type
	The raw resource type.
Protected Member Functions inherited from SDL::ResourceOwnerBase< RESOURCE, DELETER >
constexpr	ResourceOwnerBase (base::value_type value={}, DELETER deleter={})
	Constructs from raw type.
void	free ()
	Frees resource.
Protected Member Functions inherited from SDL::ResourcePtrBase< RESOURCE >
constexpr	ResourcePtrBase (value_type value={})
	Constructs from raw type.
reference &	get ()
	Get reference.

Detailed Description

Category:

Resource

See also

MutexRef

Member Function Documentation

Create()

static Mutex SDL::Mutex::Create ( )

inlinestatic

All newly-created mutexes begin in the unlocked state.

Calls to MutexRef.Lock() will not return while the mutex is locked by another thread. See MutexRef.TryLock() to attempt to lock without blocking.

SDL mutexes are reentrant.

Returns

the initialized and unlocked mutex or nullptr on failure; call GetError() for more information.

Since

This function is available since SDL 3.2.0.

See also

Mutex.Destroy

MutexRef.Lock

MutexRef.TryLock

MutexRef.Unlock

Destroy()

void SDL::Mutex::Destroy ( )

inline

This function must be called on any mutex that is no longer needed. Failure to destroy a mutex will result in a system memory or resource leak. While it is safe to destroy a mutex that is unlocked, it is not safe to attempt to destroy a locked mutex, and may result in undefined behavior depending on the platform.

Since

This function is available since SDL 3.2.0.

See also

Mutex.Create

---

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

• SDL3pp/SDL3pp_mutex.h