RavEngine
Loading...
Searching...
No Matches
physx::PxInputData Class Referenceabstract

Input data class for I/O which provides random read access. More...

#include <PxIO.h>

Inheritance diagram for physx::PxInputData:
[legend]
Collaboration diagram for physx::PxInputData:
[legend]

Public Member Functions

virtual uint32_t getLength () const =0
 return the length of the input data
 
virtual void seek (uint32_t offset)=0
 seek to the given offset from the start of the data.
 
virtual uint32_t tell () const =0
 return the current offset from the start of the data
 
virtual uint32_t getLength () const =0
 return the length of the input data
 
virtual void seek (uint32_t offset)=0
 seek to the given offset from the start of the data.
 
virtual uint32_t tell () const =0
 return the current offset from the start of the data
 
- Public Member Functions inherited from physx::PxInputStream
virtual uint32_t read (void *dest, uint32_t count)=0
 read from the stream. The number of bytes read may be less than the number requested.
 
virtual uint32_t read (void *dest, uint32_t count)=0
 read from the stream. The number of bytes read may be less than the number requested.
 

Detailed Description

Input data class for I/O which provides random read access.

The user needs to supply a PxInputData implementation to a number of methods to allow the SDK to read data.

Member Function Documentation

◆ getLength() [1/2]

virtual uint32_t physx::PxInputData::getLength ( ) const
pure virtual

return the length of the input data

Returns
size in bytes of the input data

Implemented in physx::PxDefaultMemoryInputData, and physx::PxDefaultFileInputData.

◆ getLength() [2/2]

virtual uint32_t physx::PxInputData::getLength ( ) const
pure virtual

return the length of the input data

Returns
size in bytes of the input data

Implemented in physx::PxDefaultMemoryInputData, and physx::PxDefaultFileInputData.

◆ seek() [1/2]

virtual void physx::PxInputData::seek ( uint32_t  offset)
pure virtual

seek to the given offset from the start of the data.

Parameters
[in]offsetthe offset to seek to. If greater than the length of the data, this call is equivalent to seek(length);

Implemented in physx::PxDefaultMemoryInputData, and physx::PxDefaultFileInputData.

◆ seek() [2/2]

virtual void physx::PxInputData::seek ( uint32_t  offset)
pure virtual

seek to the given offset from the start of the data.

Parameters
[in]offsetthe offset to seek to. If greater than the length of the data, this call is equivalent to seek(length);

Implemented in physx::PxDefaultMemoryInputData, and physx::PxDefaultFileInputData.

◆ tell() [1/2]

virtual uint32_t physx::PxInputData::tell ( ) const
pure virtual

return the current offset from the start of the data

Returns
the offset to seek to.

Implemented in physx::PxDefaultMemoryInputData, and physx::PxDefaultFileInputData.

◆ tell() [2/2]

virtual uint32_t physx::PxInputData::tell ( ) const
pure virtual

return the current offset from the start of the data

Returns
the offset to seek to.

Implemented in physx::PxDefaultMemoryInputData, and physx::PxDefaultFileInputData.


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