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

Semi-safe reference for AsyncIOQueue.

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

Public Member Functions

 AsyncIOQueueRef (AsyncIOQueueParam resource)
 Constructs from AsyncIOQueueParam. More...
 
 AsyncIOQueueRef (const AsyncIOQueueRef &other)
 Copy constructor.
 
 ~AsyncIOQueueRef ()
 Destructor.
 
- Public Member Functions inherited from SDL::AsyncIOQueue
constexpr AsyncIOQueue (const AsyncIOQueueRaw resource)
 Constructs from AsyncIOQueueParam. More...
 
constexpr AsyncIOQueue (const AsyncIOQueue &other)=delete
 Copy constructor.
 
constexpr AsyncIOQueue (AsyncIOQueue &&other)
 Move constructor.
 
constexpr AsyncIOQueue (const AsyncIOQueueRef &other)=delete
 
constexpr AsyncIOQueue (AsyncIOQueueRef &&other)=delete
 
 AsyncIOQueue ()
 Create a task queue for tracking multiple I/O operations. More...
 
 ~AsyncIOQueue ()
 Destructor.
 
AsyncIOQueueoperator= (AsyncIOQueue other)
 Assignment operator.
 
constexpr AsyncIOQueueRaw get () const
 Retrieves underlying AsyncIOQueueRaw.
 
constexpr AsyncIOQueueRaw release ()
 Retrieves underlying AsyncIOQueueRaw and clear this.
 
constexpr auto operator<=> (const AsyncIOQueue &other) const =default
 Comparison.
 
constexpr bool operator== (std::nullptr_t _) const
 Comparison.
 
constexpr operator bool () const
 Converts to bool.
 
constexpr operator AsyncIOQueueParam () const
 Converts to AsyncIOQueueParam.
 
void Destroy ()
 Destroy a previously-created async I/O task queue. More...
 
std::optional< AsyncIOOutcomeGetResult ()
 Query an async I/O task queue for completed tasks. More...
 
std::optional< AsyncIOOutcomeWaitResult (Milliseconds timeout)
 Block until an async I/O task queue has a completed task. More...
 
std::optional< AsyncIOOutcomeWaitResult ()
 Block until an async I/O task queue has a completed task. More...
 
void Signal ()
 Wake up any threads that are blocking in AsyncIOQueue.WaitResult(). More...
 

Constructor & Destructor Documentation

◆ AsyncIOQueueRef()

SDL::AsyncIOQueueRef::AsyncIOQueueRef ( AsyncIOQueueParam  resource)
inline
Parameters
resourcea AsyncIOQueueRaw or AsyncIOQueue.

This does not takes ownership!


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