SDL3pp
A slim C++ wrapper for SDL3
Loading...
Searching...
No Matches
Public Member Functions | List of all members
SDL::SemaphoreRef Struct Reference

Semi-safe reference for Semaphore.

Inheritance diagram for SDL::SemaphoreRef:
Inheritance graph
[legend]
Collaboration diagram for SDL::SemaphoreRef:
Collaboration graph
[legend]

Public Member Functions

 SemaphoreRef (SemaphoreParam resource)
 Constructs from SemaphoreParam. More...
 
 SemaphoreRef (const SemaphoreRef &other)
 Copy constructor.
 
 ~SemaphoreRef ()
 Destructor.
 
- Public Member Functions inherited from SDL::Semaphore
constexpr Semaphore ()=default
 Default ctor.
 
constexpr Semaphore (const SemaphoreRaw resource)
 Constructs from SemaphoreParam. More...
 
constexpr Semaphore (const Semaphore &other)=delete
 Copy constructor.
 
constexpr Semaphore (Semaphore &&other)
 Move constructor.
 
constexpr Semaphore (const SemaphoreRef &other)=delete
 
constexpr Semaphore (SemaphoreRef &&other)=delete
 
 Semaphore (Uint32 initial_value)
 Create a semaphore. More...
 
 ~Semaphore ()
 Destructor.
 
Semaphoreoperator= (Semaphore other)
 Assignment operator.
 
constexpr SemaphoreRaw get () const
 Retrieves underlying SemaphoreRaw.
 
constexpr SemaphoreRaw release ()
 Retrieves underlying SemaphoreRaw and clear this.
 
constexpr auto operator<=> (const Semaphore &other) const =default
 Comparison.
 
constexpr bool operator== (std::nullptr_t _) const
 Comparison.
 
constexpr operator bool () const
 Converts to bool.
 
constexpr operator SemaphoreParam () const
 Converts to SemaphoreParam.
 
void Destroy ()
 Destroy a semaphore. More...
 
void Wait ()
 Wait until a semaphore has a positive value and then decrements it. More...
 
bool TryWait ()
 See if a semaphore has a positive value and decrement it if it does. More...
 
bool WaitTimeout (std::chrono::milliseconds timeout)
 Wait until a semaphore has a positive value and then decrements it. More...
 
void Signal ()
 Atomically increment a semaphore's value and wake waiting threads. More...
 
Uint32 GetValue () const
 Get the current value of a semaphore. More...
 

Constructor & Destructor Documentation

◆ SemaphoreRef()

SDL::SemaphoreRef::SemaphoreRef ( SemaphoreParam  resource)
inline
Parameters
resourcea SemaphoreRaw or Semaphore.

This does not takes ownership!


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