OmniPvdFileReadStreamImpl Class Reference

Inheritance diagram for OmniPvdFileReadStreamImpl:

Collaboration diagram for OmniPvdFileReadStreamImpl:

Public Member Functions
void OMNI_PVD_CALL	setFileName (const char *fileName)
	Sets the file name of the file to read from.
bool OMNI_PVD_CALL	openFile ()
	Opens the file.
bool OMNI_PVD_CALL	closeFile ()
	Closes the file.
uint64_t OMNI_PVD_CALL	readBytes (uint8_t *bytes, 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
char *	mFileName
bool	mFileWasOpened
FILE *	mPFile

Member Function Documentation

closeFile()

bool OMNI_PVD_CALL OmniPvdFileReadStreamImpl::closeFile ( )

virtual

Closes the file.

Returns

True if the file closing was successfull

Implements OmniPvdFileReadStream.

closeStream()

bool OMNI_PVD_CALL OmniPvdFileReadStreamImpl::closeStream ( )

virtual

Closes the read stream.

Returns

True if it succeeded

Implements OmniPvdReadStream.

openFile()

bool OMNI_PVD_CALL OmniPvdFileReadStreamImpl::openFile ( )

virtual

Opens the file.

Returns

True if the file opening was successfull

Implements OmniPvdFileReadStream.

openStream()

bool OMNI_PVD_CALL OmniPvdFileReadStreamImpl::openStream ( )

virtual

Opens the read stream.

Returns

True if it succeeded

Implements OmniPvdReadStream.

readBytes()

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

virtual

Read n bytes from the shared memory buffer.

Parameters

bytes	Reads n bytes into the destination pointer
nbrBytes	The requested number of bytes to read

Returns

The actual number of bytes read

Implements OmniPvdReadStream.

setFileName()

void OMNI_PVD_CALL OmniPvdFileReadStreamImpl::setFileName ( const char *  fileName )

virtual

Sets the file name of the file to read from.

Parameters

fileName

The file name of the file to open

Implements OmniPvdFileReadStream.

skipBytes()

uint64_t OMNI_PVD_CALL OmniPvdFileReadStreamImpl::skipBytes ( const uint64_t  nbrBytes )

virtual

Skip n bytes from the shared memory buffer.

Parameters

nbrBytes

The 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:

• RavEngine/deps/physx/physx/pvdruntime/src/OmniPvdFileReadStreamImpl.h
• RavEngine/deps/physx/physx/pvdruntime/src/OmniPvdFileReadStreamImpl.cpp