PhysX SDK 3.2 API Reference: PxInputData Class Reference

PhysX SDK 3.2 API

PxInputData Class Reference
[Common]

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

#include <PxIO.h>

Inheritance diagram for PxInputData:
Collaboration diagram for PxInputData:

List of all members.


Public Member Functions

virtual PxU32 getLength () const =0
 seek to the given offset from the start of the data.
virtual void seek (PxU32 offset)=0
 seek to the given offset from the start of the data.
virtual PxU32 tell () const =0
 return the current offset from the start of the data
virtual ~PxInputData ()

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

virtual PxInputData::~PxInputData (  )  [inline, virtual]


Member Function Documentation

virtual PxU32 PxInputData::getLength (  )  const [pure virtual]

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

Returns:
the number of bytes of data in the block.

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

virtual void PxInputData::seek ( PxU32  offset  )  [pure virtual]

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

Parameters:
[in] offset the 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.

virtual PxU32 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 file:



Copyright © 2008-2012 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com