Inheritance diagram for physx::general_PxIOStream2::PxFileBufferBase:

Collaboration diagram for physx::general_PxIOStream2::PxFileBufferBase:

Public Member Functions
	PxFileBufferBase (const char *fileName, OpenMode mode)

virtual void	close ()
	Close the stream.

virtual SeekType	isSeekable (void) const

virtual uint32_t	read (void *buffer, uint32_t size)
	Reads from the stream into a buffer.

virtual uint32_t	peek (void *buffer, uint32_t size)
	Reads from the stream into a buffer but does not advance the read location.

virtual uint32_t	write (const void *buffer, uint32_t size)
	Writes a buffer of memory to the stream.

virtual uint32_t	tellRead (void) const
	Reports the current stream location read aqccess.

virtual uint32_t	tellWrite (void) const
	Reports the current stream location for write access.

virtual uint32_t	seekRead (uint32_t loc)
	Seeks the stream to a particular location for reading.

virtual uint32_t	seekWrite (uint32_t loc)
	Seeks the stream to a particular location for writing.

virtual void	flush (void)
	Causes any temporarily cached data to be flushed to the stream.

virtual OpenMode	getOpenMode (void) const

virtual uint32_t	getFileLength (void) const

Public Member Functions inherited from physx::general_PxIOStream2::PxFileBuf
	PxFileBuf (EndianMode mode=ENDIAN_LITTLE)

bool	isOpen (void) const

void	setEndianMode (EndianMode e)

EndianMode	getEndianMode (void) const

void	release (void)

PX_INLINE void	swap2Bytes (void *_data) const

PX_INLINE void	swap4Bytes (void *_data) const

PX_INLINE void	swap8Bytes (void *_data) const

PX_INLINE void	storeDword (uint32_t v)

PX_INLINE void	storeFloat (float v)

PX_INLINE void	storeDouble (double v)

PX_INLINE void	storeByte (uint8_t b)

PX_INLINE void	storeWord (uint16_t w)

uint8_t	readByte (void)

uint16_t	readWord (void)

uint32_t	readDword (void)

float	readFloat (void)

double	readDouble (void)

Additional Inherited Members
Public Types inherited from physx::general_PxIOStream2::PxFileBuf
enum	EndianMode { ENDIAN_NONE = 0 , ENDIAN_BIG = 1 , ENDIAN_LITTLE = 2 }

enum	OpenMode { OPEN_FILE_NOT_FOUND , OPEN_READ_ONLY , OPEN_WRITE_ONLY , OPEN_READ_WRITE_NEW , OPEN_READ_WRITE_EXISTING }

enum	SeekType { SEEKABLE_NO = 0 , SEEKABLE_READ = 0x1 , SEEKABLE_WRITE = 0x2 , SEEKABLE_READWRITE = 0x3 }

Static Public Member Functions inherited from physx::general_PxIOStream2::PxFileBuf
static PX_INLINE bool	isBigEndian ()

Static Public Attributes inherited from physx::general_PxIOStream2::PxFileBuf
static const uint32_t	STREAM_SEEK_END =0xFFFFFFFF
	Declares a constant to seek to the end of the stream.

Member Function Documentation

◆ close()

virtual void physx::general_PxIOStream2::PxFileBufferBase::close ( void )

inlinevirtual

Close the stream.

Reimplemented from physx::general_PxIOStream2::PxFileBuf.

◆ flush()

virtual void physx::general_PxIOStream2::PxFileBufferBase::flush ( void )

inlinevirtual

Causes any temporarily cached data to be flushed to the stream.

Implements physx::general_PxIOStream2::PxFileBuf.

◆ getFileLength()

virtual uint32_t physx::general_PxIOStream2::PxFileBufferBase::getFileLength ( void ) const

inlinevirtual

Implements physx::general_PxIOStream2::PxFileBuf.

◆ getOpenMode()

virtual OpenMode physx::general_PxIOStream2::PxFileBufferBase::getOpenMode ( void ) const

inlinevirtual

Implements physx::general_PxIOStream2::PxFileBuf.

◆ isSeekable()

virtual SeekType physx::general_PxIOStream2::PxFileBufferBase::isSeekable ( void ) const

inlinevirtual

Implements physx::general_PxIOStream2::PxFileBuf.

◆ peek()

virtual uint32_t physx::general_PxIOStream2::PxFileBufferBase::peek	(	void *	mem,
		uint32_t	len
	)

inlinevirtual

Reads from the stream into a buffer but does not advance the read location.

Parameters

[out]	mem	The buffer to read the stream into.
[in]	len	The number of bytes to stream into the buffer

Returns: Returns the actual number of bytes read. If not equal to the length requested, then reached end of stream.

Implements physx::general_PxIOStream2::PxFileBuf.

◆ read()

virtual uint32_t physx::general_PxIOStream2::PxFileBufferBase::read	(	void *	mem,
		uint32_t	len
	)

inlinevirtual

Reads from the stream into a buffer.

Parameters

[out]	mem	The buffer to read the stream into.
[in]	len	The number of bytes to stream into the buffer

Returns: Returns the actual number of bytes read. If not equal to the length requested, then reached end of stream.

Implements physx::general_PxIOStream2::PxFileBuf.

◆ seekRead()

virtual uint32_t physx::general_PxIOStream2::PxFileBufferBase::seekRead ( uint32_t loc )

inlinevirtual

Seeks the stream to a particular location for reading.

If the location passed exceeds the length of the stream, then it will seek to the end. Returns the location it ended up at (useful if you seek to the end) to get the file position

Implements physx::general_PxIOStream2::PxFileBuf.

◆ seekWrite()

virtual uint32_t physx::general_PxIOStream2::PxFileBufferBase::seekWrite ( uint32_t loc )

inlinevirtual

Seeks the stream to a particular location for writing.

If the location passed exceeds the length of the stream, then it will seek to the end. Returns the location it ended up at (useful if you seek to the end) to get the file position

Implements physx::general_PxIOStream2::PxFileBuf.

◆ tellRead()

virtual uint32_t physx::general_PxIOStream2::PxFileBufferBase::tellRead ( void ) const

inlinevirtual

Reports the current stream location read aqccess.

Returns: Returns the current stream read location.

Implements physx::general_PxIOStream2::PxFileBuf.

◆ tellWrite()

virtual uint32_t physx::general_PxIOStream2::PxFileBufferBase::tellWrite ( void ) const

inlinevirtual

Reports the current stream location for write access.

Returns: Returns the current stream write location.

Implements physx::general_PxIOStream2::PxFileBuf.

◆ write()

virtual uint32_t physx::general_PxIOStream2::PxFileBufferBase::write	(	const void *	mem,
		uint32_t	len
	)

inlinevirtual

Writes a buffer of memory to the stream.

Parameters

[in]	mem	The address of a buffer of memory to send to the stream.
[in]	len	The number of bytes to send to the stream.

Returns: Returns the actual number of bytes sent to the stream. If not equal to the length specific, then the stream is full or unable to write for some reason.

Implements physx::general_PxIOStream2::PxFileBuf.

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

RavEngine/deps/physx/physx/source/filebuf/include/PsFileBuffer.h

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ close()

◆ flush()

◆ getFileLength()

◆ getOpenMode()

◆ isSeekable()

◆ peek()

◆ read()

◆ seekRead()

◆ seekWrite()

◆ tellRead()

◆ tellWrite()

◆ write()