From 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 Mon Sep 17 00:00:00 2001 From: git perforce import user Date: Tue, 25 Oct 2016 12:29:14 -0600 Subject: Initial commit: PhysX 3.4.0 Update @ 21294896 APEX 1.4.0 Update @ 21275617 [CL 21300167] --- .../files/classPxDefaultFileInputData.html | 292 +++++++++++++++++++++ 1 file changed, 292 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultFileInputData.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultFileInputData.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultFileInputData.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultFileInputData.html new file mode 100644 index 00000000..9b97b39d --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultFileInputData.html @@ -0,0 +1,292 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxDefaultFileInputData Class Reference + + + + + + + +
+

PxDefaultFileInputData Class Reference
+ +[Extensions] +

default implementation of a file read stream +More... +

+#include <PxDefaultStreams.h> +

+

+Inheritance diagram for PxDefaultFileInputData:
+
+

Inheritance graph
+ +PxInputDataPxInputStream +
[legend]
+
+Collaboration diagram for PxDefaultFileInputData:
+
+

Collaboration graph
+ +PxInputDataPxInputStream +
[legend]
+ +

+List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

 PxDefaultFileInputData (const char *name)
virtual ~PxDefaultFileInputData ()
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

Private Attributes

PxFileHandle mFile
PxU32 mLength
+

Detailed Description

+default implementation of a file read stream +

+

See also:
PxInputData
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + +
PxDefaultFileInputData::PxDefaultFileInputData (const char *  name  ) 
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + +
virtual PxDefaultFileInputData::~PxDefaultFileInputData (  )  [virtual]
+
+
+ +

+ +

+

+

Member Function Documentation

+ +
+
+ + + + + + + + +
virtual PxU32 PxDefaultFileInputData::getLength (  )  const [virtual]
+
+
+ +

+return the length of the input data +

+

Returns:
size in bytes of the input data
+ +

Implements PxInputData.

+ +
+

+ +

+
+ + + + + + + + +
bool PxDefaultFileInputData::isValid (  )  const
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + +
virtual 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] dest the destination address to which the data will be read
[in] count the number of bytes requested
+
+
Returns:
the number of bytes read from the stream.
+ +

Implements PxInputStream.

+ +
+

+ +

+
+ + + + + + + + + +
virtual void 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 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

+ +
+
+ + + + +
PxFileHandle PxDefaultFileInputData::mFile [private]
+
+
+ +

+ +

+

+ +

+
+ + + + +
PxU32 PxDefaultFileInputData::mLength [private]
+
+
+ +

+ +

+

+

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

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