RavEngine
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OmniPvdWriteStream Class Referenceabstract

Used to abstract a memory write stream. More...

#include <OmniPvdWriteStream.h>

Inheritance diagram for OmniPvdWriteStream:
[legend]

Public Member Functions

virtual uint64_t OMNI_PVD_CALL writeBytes (const uint8_t *bytes, const uint64_t nbrBytes)=0
 Write n bytes to the shared memory buffer.
 
virtual bool OMNI_PVD_CALL flush ()=0
 Flushes the writes.
 
virtual bool OMNI_PVD_CALL openStream ()=0
 Opens the stream.
 
virtual bool OMNI_PVD_CALL closeStream ()=0
 Closes the stream.
 

Detailed Description

Used to abstract a memory write stream.

Allows to write bytes as well as open/close the stream.

Member Function Documentation

◆ closeStream()

virtual bool OMNI_PVD_CALL OmniPvdWriteStream::closeStream ( )
pure virtual

Closes the stream.

Returns
The success of the operation

Implemented in OmniPvdFileWriteStreamImpl, and OmniPvdMemoryWriteStreamImpl.

◆ flush()

virtual bool OMNI_PVD_CALL OmniPvdWriteStream::flush ( )
pure virtual

Flushes the writes.

Returns
The success of the operation

Implemented in OmniPvdFileWriteStreamImpl, and OmniPvdMemoryWriteStreamImpl.

◆ openStream()

virtual bool OMNI_PVD_CALL OmniPvdWriteStream::openStream ( )
pure virtual

Opens the stream.

Returns
The success of the operation

Implemented in OmniPvdFileWriteStreamImpl, and OmniPvdMemoryWriteStreamImpl.

◆ writeBytes()

virtual uint64_t OMNI_PVD_CALL OmniPvdWriteStream::writeBytes ( const uint8_t *  bytes,
const uint64_t  nbrBytes 
)
pure virtual

Write n bytes to the shared memory buffer.

Parameters
bytespointer to the bytes to write
nbrBytesThe requested number of bytes to write
Returns
The actual number of bytes written

Implemented in OmniPvdFileWriteStreamImpl, and OmniPvdMemoryWriteStreamImpl.

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