SDL::AsyncIORef Struct Reference

Semi-safe reference for AsyncIO.

Inheritance diagram for SDL::AsyncIORef:

Collaboration diagram for SDL::AsyncIORef:

Public Member Functions
	AsyncIORef (AsyncIOParam resource)
	Constructs from AsyncIOParam. More...
	AsyncIORef (const AsyncIORef &other)
	Copy constructor.
	~AsyncIORef ()
	Destructor.
Public Member Functions inherited from SDL::AsyncIO
constexpr	AsyncIO ()=default
	Default ctor.
constexpr	AsyncIO (const AsyncIORaw resource)
	Constructs from AsyncIOParam. More...
constexpr	AsyncIO (const AsyncIO &other)=delete
	Copy constructor.
constexpr	AsyncIO (AsyncIO &&other)
	Move constructor.
constexpr	AsyncIO (const AsyncIORef &other)=delete
constexpr	AsyncIO (AsyncIORef &&other)=delete
	AsyncIO (StringParam file, StringParam mode)
	Use this function to create a new AsyncIO object for reading from and/or writing to a named file. More...
	~AsyncIO ()
	Destructor.
AsyncIO &	operator= (AsyncIO other)
	Assignment operator.
constexpr AsyncIORaw	get () const
	Retrieves underlying AsyncIORaw.
constexpr AsyncIORaw	release ()
	Retrieves underlying AsyncIORaw and clear this.
constexpr auto	operator<=> (const AsyncIO &other) const =default
	Comparison.
constexpr bool	operator== (std::nullptr_t _) const
	Comparison.
constexpr	operator bool () const
	Converts to bool.
constexpr	operator AsyncIOParam () const
	Converts to AsyncIOParam.
bool	Close (bool flush, AsyncIOQueueParam queue, void *userdata)
	Close and free any allocated resources for an async I/O object. More...
Sint64	GetSize ()
	Use this function to get the size of the data stream in an AsyncIO. More...
void	Read (void *ptr, Uint64 offset, Uint64 size, AsyncIOQueueParam queue, void *userdata)
	Start an async read. More...
void	Write (void *ptr, Uint64 offset, Uint64 size, AsyncIOQueueParam queue, void *userdata)
	Start an async write. More...

Constructor & Destructor Documentation

AsyncIORef()

SDL::AsyncIORef::AsyncIORef ( AsyncIOParam  resource )

inline

Parameters

resource

a AsyncIORaw or AsyncIO.

This does not takes ownership!

---

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

• SDL3pp/SDL3pp_asyncio.h