physx::PxDefaultFileInputData Class Reference
default implementation of a file read stream More...
#include <PxDefaultStreams.h>
Inheritance diagram for physx::PxDefaultFileInputData:
Collaboration diagram for physx::PxDefaultFileInputData:
Public Member Functions | |
| PxDefaultFileInputData (const char *name) | |
| virtual | ~PxDefaultFileInputData () |
| virtual PxU32 | read (void *dest, PxU32 count) |
| read from the stream. The number of bytes written may be less than the number requested. | |
| virtual void | seek (PxU32 pos) |
| seek to the given offset from the start of the data. | |
| virtual PxU32 | tell () const |
| return the current offset from the start of the data | |
| virtual PxU32 | getLength () const |
| seek to the given offset from the start of the data. | |
| bool | isValid () const |
Private Attributes | |
| FILE * | mFile |
| PxU32 | mLength |
Detailed Description
default implementation of a file read stream
- See also:
- PxInputData
Constructor & Destructor Documentation
| physx::PxDefaultFileInputData::PxDefaultFileInputData | ( | const char * | name | ) |
| virtual physx::PxDefaultFileInputData::~PxDefaultFileInputData | ( | ) | [virtual] |
Member Function Documentation
| virtual PxU32 physx::PxDefaultFileInputData::getLength | ( | ) | const [virtual] |
seek to the given offset from the start of the data.
- Returns:
- the number of bytes of data in the block.
Implements PxInputData.
| bool physx::PxDefaultFileInputData::isValid | ( | ) | const |
read from the stream. The number of bytes written may be less than the number requested.
- Parameters:
-
[in] dest the destination address to which the data will be written [in] count the number of bytes requested
- Returns:
- the number of bytes read from the stream.
Implements PxInputStream.
| virtual void physx::PxDefaultFileInputData::seek | ( | PxU32 | offset | ) | [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);
Implements PxInputData.
| virtual PxU32 physx::PxDefaultFileInputData::tell | ( | ) | const [virtual] |
return the current offset from the start of the data
- Returns:
- the offset to seek to.
Implements PxInputData.
Member Data Documentation
FILE* physx::PxDefaultFileInputData::mFile [private] |
PxU32 physx::PxDefaultFileInputData::mLength [private] |
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