OmniPvdFileWriteStream Class Reference

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

#include <OmniPvdFileWriteStream.h>

Inheritance diagram for OmniPvdFileWriteStream:

Collaboration diagram for OmniPvdFileWriteStream:

Public Member Functions
virtual void OMNI_PVD_CALL	setFileName (const char *fileName)=0
	Sets the file name of the file to write to.
virtual bool OMNI_PVD_CALL	openFile ()=0
	Opens the file.
virtual bool OMNI_PVD_CALL	closeFile ()=0
	Closes the file.
Public Member Functions inherited from OmniPvdWriteStream
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 file write stream.

Used to set the filename, opening and closing it.

Member Function Documentation

closeFile()

virtual bool OMNI_PVD_CALL OmniPvdFileWriteStream::closeFile ( )

pure virtual

Closes the file.

Returns

True if the file closing was successfull

Implemented in OmniPvdFileWriteStreamImpl.

openFile()

virtual bool OMNI_PVD_CALL OmniPvdFileWriteStream::openFile ( )

pure virtual

Opens the file.

Returns

True if the file opening was successfull

Implemented in OmniPvdFileWriteStreamImpl.

setFileName()

virtual void OMNI_PVD_CALL OmniPvdFileWriteStream::setFileName ( const char *  fileName )

pure virtual

Sets the file name of the file to write to.

Parameters

fileName

The file name of the file to open

Implemented in OmniPvdFileWriteStreamImpl.

---

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

• RavEngine/deps/physx/physx/pvdruntime/include/OmniPvdFileWriteStream.h