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] --- .../PhysXAPI/files/classPxBinaryConverter.html | 239 +++++++++++++++++++++ 1 file changed, 239 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/classPxBinaryConverter.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxBinaryConverter.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxBinaryConverter.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxBinaryConverter.html new file mode 100644 index 00000000..f6ef197c --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxBinaryConverter.html @@ -0,0 +1,239 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxBinaryConverter Class Reference + + + + + + + +
+

PxBinaryConverter Class Reference
+ +[Extensions] +

Binary converter for serialized streams. +More... +

+#include <PxBinaryConverter.h> +

+ +

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

Public Member Functions

virtual void release ()=0
 Releases binary converter.
virtual void setReportMode (PxConverterReportMode::Enum mode)=0
 Sets desired report mode.
virtual bool setMetaData (PxInputStream &srcMetaData, PxInputStream &dstMetaData)=0
 Setups source and target meta-data streams.
virtual bool convert (PxInputStream &srcStream, PxU32 srcSize, PxOutputStream &targetStream)=0
 Converts binary stream from source platform to target platform.

Protected Member Functions

 PxBinaryConverter ()
virtual ~PxBinaryConverter ()
+

Detailed Description

+Binary converter for serialized streams. +

+The binary converter class is targeted at converting binary streams from authoring platforms, such as windows, osx or linux to any game runtime platform supported by PhysX. Particularly it is currently not supported to run the converter on a platforms that has an endian mismatch with the platform corresponding to the source binary file and source meta data.

+If you want to use multiple threads for batch conversions, please create one instance of this class for each thread.

+

See also:
PxSerialization.createBinaryConverter
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
PxBinaryConverter::PxBinaryConverter (  )  [inline, protected]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + +
virtual PxBinaryConverter::~PxBinaryConverter (  )  [inline, protected, virtual]
+
+
+ +

+ +

+

+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual bool PxBinaryConverter::convert (PxInputStream &  srcStream,
PxU32  srcSize,
PxOutputStream &  targetStream 
) [pure virtual]
+
+
+ +

+Converts binary stream from source platform to target platform. +

+The converter needs to be configured with source and destination meta data before calling the conversion method. The source meta data needs to correspond to the same platform as the source binary data.

+

Parameters:
+ + + + +
[in] srcStream Source stream
[in] srcSize Number of bytes to convert
[in] targetStream Target stream
+
+
Returns:
True if success
+ +
+

+ +

+
+ + + + + + + + +
virtual void PxBinaryConverter::release (  )  [pure virtual]
+
+
+ +

+Releases binary converter. +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + +
virtual bool PxBinaryConverter::setMetaData (PxInputStream &  srcMetaData,
PxInputStream &  dstMetaData 
) [pure virtual]
+
+
+ +

+Setups source and target meta-data streams. +

+The source meta data provided needs to have the same endianness as the platform the converter is run on. The meta data needs to be set before calling the conversion method.

+

Parameters:
+ + + +
[in] srcMetaData Source platform's meta-data stream
[in] dstMetaData Target platform's meta-data stream
+
+
Returns:
True if success
+ +
+

+ +

+
+ + + + + + + + + +
virtual void PxBinaryConverter::setReportMode (PxConverterReportMode::Enum  mode  )  [pure virtual]
+
+
+ +

+Sets desired report mode. +

+

Parameters:
+ + +
[in] mode Report mode
+
+ +
+

+

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