OmniPvdFileWriteStreamImpl Class Reference

Inheritance diagram for OmniPvdFileWriteStreamImpl:

Collaboration diagram for OmniPvdFileWriteStreamImpl:

Public Member Functions
void OMNI_PVD_CALL	setFileName (const char *fileName)
	Sets the file name of the file to write to.
bool OMNI_PVD_CALL	openFile ()
	Opens the file.
bool OMNI_PVD_CALL	closeFile ()
	Closes the file.
uint64_t OMNI_PVD_CALL	writeBytes (const uint8_t *bytes, const uint64_t nbrBytes)
	Write n bytes to the shared memory buffer.
bool OMNI_PVD_CALL	flush ()
	Flushes the writes.
bool OMNI_PVD_CALL	openStream ()
	Opens the stream.
bool OMNI_PVD_CALL	closeStream ()
	Closes the stream.

Public Attributes
char *	mFileName
bool	mFileWasOpened
FILE *	mPFile

Member Function Documentation

closeFile()

bool OMNI_PVD_CALL OmniPvdFileWriteStreamImpl::closeFile ( )

virtual

Closes the file.

Returns

True if the file closing was successfull

Implements OmniPvdFileWriteStream.

closeStream()

bool OMNI_PVD_CALL OmniPvdFileWriteStreamImpl::closeStream ( )

virtual

Closes the stream.

Returns

The success of the operation

Implements OmniPvdWriteStream.

flush()

bool OMNI_PVD_CALL OmniPvdFileWriteStreamImpl::flush ( )

virtual

Flushes the writes.

Returns

The success of the operation

Implements OmniPvdWriteStream.

openFile()

bool OMNI_PVD_CALL OmniPvdFileWriteStreamImpl::openFile ( )

virtual

Opens the file.

Returns

True if the file opening was successfull

Implements OmniPvdFileWriteStream.

openStream()

bool OMNI_PVD_CALL OmniPvdFileWriteStreamImpl::openStream ( )

virtual

Opens the stream.

Returns

The success of the operation

Implements OmniPvdWriteStream.

setFileName()

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

virtual

Sets the file name of the file to write to.

Parameters

fileName

The file name of the file to open

Implements OmniPvdFileWriteStream.

writeBytes()

uint64_t OMNI_PVD_CALL OmniPvdFileWriteStreamImpl::writeBytes ( const uint8_t *  bytes, const uint64_t  nbrBytes  )

virtual

Write n bytes to the shared memory buffer.

Parameters

bytes	pointer to the bytes to write
nbrBytes	The requested number of bytes to write

Returns

The actual number of bytes written

Implements OmniPvdWriteStream.

---

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

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