PxInputData Class Referenceabstract

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

#include <PxIO.h>

Inheritance diagram for PxInputData:
Collaboration diagram for PxInputData:

Public Member Functions

virtual uint32_t getLength () const =0
 return the length of the input data More...
 
virtual void seek (uint32_t offset)=0
 seek to the given offset from the start of the data. More...
 
virtual uint32_t tell () const =0
 return the current offset from the start of the data More...
 
virtual ~PxInputData ()
 
- Public Member Functions inherited from 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. More...
 
virtual ~PxInputStream ()
 

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.

Constructor & Destructor Documentation

◆ ~PxInputData()

virtual PxInputData::~PxInputData ( )
inlinevirtual

Member Function Documentation

◆ getLength()

virtual uint32_t PxInputData::getLength ( ) const
pure virtual

return the length of the input data

Returns
size in bytes of the input data

Implemented in PxDefaultFileInputData, and PxDefaultMemoryInputData.

◆ seek()

virtual void 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 PxDefaultFileInputData, and PxDefaultMemoryInputData.

◆ tell()

virtual uint32_t PxInputData::tell ( ) const
pure virtual

return the current offset from the start of the data

Returns
the offset to seek to.

Implemented in PxDefaultFileInputData, and PxDefaultMemoryInputData.


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