SDL::ConditionRef Struct Reference

Semi-safe reference for Condition.

Inheritance diagram for SDL::ConditionRef:

Collaboration diagram for SDL::ConditionRef:

Public Member Functions
	ConditionRef (ConditionParam resource)
	Constructs from ConditionParam. More...
	ConditionRef (const ConditionRef &other)
	Copy constructor.
	~ConditionRef ()
	Destructor.
Public Member Functions inherited from SDL::Condition
constexpr	Condition (const ConditionRaw resource)
	Constructs from ConditionParam. More...
constexpr	Condition (const Condition &other)=delete
	Copy constructor.
constexpr	Condition (Condition &&other)
	Move constructor.
constexpr	Condition (const ConditionRef &other)=delete
constexpr	Condition (ConditionRef &&other)=delete
	Condition ()
	Create a condition variable. More...
	~Condition ()
	Destructor.
Condition &	operator= (Condition other)
	Assignment operator.
constexpr ConditionRaw	get () const
	Retrieves underlying ConditionRaw.
constexpr ConditionRaw	release ()
	Retrieves underlying ConditionRaw and clear this.
constexpr auto	operator<=> (const Condition &other) const =default
	Comparison.
constexpr bool	operator== (std::nullptr_t _) const
	Comparison.
constexpr	operator bool () const
	Converts to bool.
constexpr	operator ConditionParam () const
	Converts to ConditionParam.
void	Destroy ()
	Destroy a condition variable. More...
void	Signal ()
	Restart one of the threads that are waiting on the condition variable. More...
void	Broadcast ()
	Restart all threads that are waiting on the condition variable. More...
void	Wait (MutexParam mutex)
	Wait until a condition variable is signaled. More...
bool	WaitTimeout (MutexParam mutex, std::chrono::milliseconds timeout)
	Wait until a condition variable is signaled or a certain time has passed. More...

Constructor & Destructor Documentation

ConditionRef()

SDL::ConditionRef::ConditionRef ( ConditionParam  resource )

inline

Parameters

resource

a ConditionRaw or Condition.

This does not takes ownership!

---

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

• SDL3pp/SDL3pp_mutex.h