RavEngine
Loading...
Searching...
No Matches
OmniPvdMemoryReadStreamImpl Class Reference
Inheritance diagram for OmniPvdMemoryReadStreamImpl:
[legend]
Collaboration diagram for OmniPvdMemoryReadStreamImpl:
[legend]

Public Member Functions

uint64_t OMNI_PVD_CALL readBytes (uint8_t *destination, const uint64_t nbrBytes)
 Read n bytes from the shared memory buffer.
 
uint64_t OMNI_PVD_CALL skipBytes (const uint64_t nbrBytes)
 Skip n bytes from the shared memory buffer.
 
bool OMNI_PVD_CALL openStream ()
 Opens the read stream.
 
bool OMNI_PVD_CALL closeStream ()
 Closes the read stream.
 

Public Attributes

OmniPvdMemoryStreamImpl * mMemoryStream
 

Member Function Documentation

◆ closeStream()

bool OMNI_PVD_CALL OmniPvdMemoryReadStreamImpl::closeStream ( )
virtual

Closes the read stream.

Returns
True if it succeeded

Implements OmniPvdReadStream.

◆ openStream()

bool OMNI_PVD_CALL OmniPvdMemoryReadStreamImpl::openStream ( )
virtual

Opens the read stream.

Returns
True if it succeeded

Implements OmniPvdReadStream.

◆ readBytes()

uint64_t OMNI_PVD_CALL OmniPvdMemoryReadStreamImpl::readBytes ( uint8_t *  bytes,
const uint64_t  nbrBytes 
)
virtual

Read n bytes from the shared memory buffer.

Parameters
bytesReads n bytes into the destination pointer
nbrBytesThe requested number of bytes to read
Returns
The actual number of bytes read

Implements OmniPvdReadStream.

◆ skipBytes()

uint64_t OMNI_PVD_CALL OmniPvdMemoryReadStreamImpl::skipBytes ( const uint64_t  nbrBytes)
virtual

Skip n bytes from the shared memory buffer.

Parameters
nbrBytesThe requested number of bytes to skip
Returns
The actual number of bytes skipped

Implements OmniPvdReadStream.


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