RavEngine
Loading...
Searching...
No Matches
Public Member Functions | List of all members
physx::PxDefaultFileInputData Class Reference

default implementation of a file read stream More...

#include <PxDefaultStreams.h>

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

Public Member Functions

 PxDefaultFileInputData (const char *name)
 
virtual PxU32 read (void *dest, PxU32 count)
 read from the stream. The number of bytes read 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
 return the length of the input data
 
bool isValid () const
 

Detailed Description

default implementation of a file read stream

See also
PxInputData

Member Function Documentation

◆ getLength()

PxU32 PxDefaultFileInputData::getLength ( ) const
virtual

return the length of the input data

Returns
size in bytes of the input data

Implements physx::PxInputData.

◆ read()

PxU32 PxDefaultFileInputData::read ( void *  dest,
PxU32  count 
)
virtual

read from the stream. The number of bytes read may be less than the number requested.

Parameters
[in]destthe destination address to which the data will be read
[in]countthe number of bytes requested
Returns
the number of bytes read from the stream.

Implements physx::PxInputStream.

◆ seek()

void PxDefaultFileInputData::seek ( PxU32  offset)
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);

Implements physx::PxInputData.

◆ tell()

PxU32 PxDefaultFileInputData::tell ( ) const
virtual

return the current offset from the start of the data

Returns
the offset to seek to.

Implements physx::PxInputData.

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