Monado OpenXR Runtime
IOBuffer Class Reference
Inheritance diagram for IOBuffer:
Collaboration diagram for IOBuffer:

Public Member Functions

vr::EIOBufferError Open (const char *pchPath, vr::EIOBufferMode mode, uint32_t unElementSize, uint32_t unElements, vr::IOBufferHandle_t *pulBuffer) override
 opens an existing or creates a new IOBuffer of unSize bytes More...
 
vr::EIOBufferError Close (vr::IOBufferHandle_t ulBuffer) override
 closes a previously opened or created buffer More...
 
vr::EIOBufferError Read (vr::IOBufferHandle_t ulBuffer, void *pDst, uint32_t unBytes, uint32_t *punRead) override
 reads up to unBytes from buffer into *pDst, returning number of bytes read in *punRead More...
 
vr::EIOBufferError Write (vr::IOBufferHandle_t ulBuffer, void *pSrc, uint32_t unBytes) override
 writes unBytes of data from *pSrc into a buffer. More...
 
vr::PropertyContainerHandle_t PropertyContainer (vr::IOBufferHandle_t ulBuffer) override
 retrieves the property container of an buffer. More...
 
bool HasReaders (vr::IOBufferHandle_t ulBuffer) override
 inexpensively checks for readers to allow writers to fast-fail potentially expensive copies and writes. More...
 

Member Function Documentation

◆ Close()

vr::EIOBufferError IOBuffer::Close ( vr::IOBufferHandle_t  ulBuffer)
override

closes a previously opened or created buffer

◆ HasReaders()

bool IOBuffer::HasReaders ( vr::IOBufferHandle_t  ulBuffer)
override

inexpensively checks for readers to allow writers to fast-fail potentially expensive copies and writes.

◆ Open()

vr::EIOBufferError IOBuffer::Open ( const char *  pchPath,
vr::EIOBufferMode  mode,
uint32_t  unElementSize,
uint32_t  unElements,
vr::IOBufferHandle_t *  pulBuffer 
)
override

opens an existing or creates a new IOBuffer of unSize bytes

◆ PropertyContainer()

vr::PropertyContainerHandle_t IOBuffer::PropertyContainer ( vr::IOBufferHandle_t  ulBuffer)
override

retrieves the property container of an buffer.

◆ Read()

vr::EIOBufferError IOBuffer::Read ( vr::IOBufferHandle_t  ulBuffer,
void *  pDst,
uint32_t  unBytes,
uint32_t *  punRead 
)
override

reads up to unBytes from buffer into *pDst, returning number of bytes read in *punRead

◆ Write()

vr::EIOBufferError IOBuffer::Write ( vr::IOBufferHandle_t  ulBuffer,
void *  pSrc,
uint32_t  unBytes 
)
override

writes unBytes of data from *pSrc into a buffer.


The documentation for this class was generated from the following files: