diff options
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxBinaryConverter.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxBinaryConverter.html | 239 |
1 files changed, 239 insertions, 0 deletions
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 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxBinaryConverter Class Reference</title> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <LINK HREF="NVIDIA.css" REL="stylesheet" TYPE="text/css"> + </head> + + <body bgcolor="#FFFFFF"> + <div id="header"> + <hr class="first"> + <img alt="" src="images/PhysXlogo.png" align="middle"> <br> + <center> + <a class="qindex" href="main.html">Main Page</a> + <a class="qindex" href="hierarchy.html">Class Hierarchy</a> + <a class="qindex" href="annotated.html">Compound List</a> + <a class="qindex" href="functions.html">Compound Members</a> + </center> + <hr class="second"> + </div> +<!-- Generated by Doxygen 1.5.8 --> +<div class="contents"> +<h1>PxBinaryConverter Class Reference<br> +<small> +[<a class="el" href="group__extensions.html">Extensions</a>]</small> +</h1><!-- doxytag: class="PxBinaryConverter" -->Binary converter for serialized streams. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxBinaryConverter_8h-source.html">PxBinaryConverter.h</a>></code> +<p> + +<p> +<a href="classPxBinaryConverter-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBinaryConverter.html#c45504933db13e78c7dd12e68fab304f">release</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Releases binary converter. <a href="#c45504933db13e78c7dd12e68fab304f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBinaryConverter.html#ba26eda3b46071eca65fa38cabee2a09">setReportMode</a> (<a class="el" href="structPxConverterReportMode.html#abe051209d39df379f39bbe45bf4f1a3">PxConverterReportMode::Enum</a> mode)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets desired report mode. <a href="#ba26eda3b46071eca65fa38cabee2a09"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBinaryConverter.html#475c6a6dc11b63b3570f2fc5d21b5c0e">setMetaData</a> (<a class="el" href="classPxInputStream.html">PxInputStream</a> &srcMetaData, <a class="el" href="classPxInputStream.html">PxInputStream</a> &dstMetaData)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Setups source and target meta-data streams. <a href="#475c6a6dc11b63b3570f2fc5d21b5c0e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBinaryConverter.html#9890d7f61fceb47d154e203291cd08fd">convert</a> (<a class="el" href="classPxInputStream.html">PxInputStream</a> &srcStream, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> srcSize, <a class="el" href="classPxOutputStream.html">PxOutputStream</a> &targetStream)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts binary stream from source platform to target platform. <a href="#9890d7f61fceb47d154e203291cd08fd"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBinaryConverter.html#76e9b36969e46ef131f22d2d95aa31cb">PxBinaryConverter</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBinaryConverter.html#30333f47d0897b3728442e915eaaba81">~PxBinaryConverter</a> ()</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Binary converter for serialized streams. +<p> +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.<p> +If you want to use multiple threads for batch conversions, please create one instance of this class for each thread.<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxSerialization.html#9014b476bfd9e3e9bc7ea755df232bfd" title="Creates binary converter for re-targeting binary-serialized data.">PxSerialization.createBinaryConverter</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="76e9b36969e46ef131f22d2d95aa31cb"></a><!-- doxytag: member="PxBinaryConverter::PxBinaryConverter" ref="76e9b36969e46ef131f22d2d95aa31cb" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxBinaryConverter::PxBinaryConverter </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline, protected]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="30333f47d0897b3728442e915eaaba81"></a><!-- doxytag: member="PxBinaryConverter::~PxBinaryConverter" ref="30333f47d0897b3728442e915eaaba81" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxBinaryConverter::~PxBinaryConverter </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline, protected, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="9890d7f61fceb47d154e203291cd08fd"></a><!-- doxytag: member="PxBinaryConverter::convert" ref="9890d7f61fceb47d154e203291cd08fd" args="(PxInputStream &srcStream, PxU32 srcSize, PxOutputStream &targetStream)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxBinaryConverter::convert </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxInputStream.html">PxInputStream</a> & </td> + <td class="paramname"> <em>srcStream</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>srcSize</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxOutputStream.html">PxOutputStream</a> & </td> + <td class="paramname"> <em>targetStream</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Converts binary stream from source platform to target platform. +<p> +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.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>srcStream</em> </td><td>Source stream </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>srcSize</em> </td><td>Number of bytes to convert </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>targetStream</em> </td><td>Target stream</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if success </dd></dl> + +</div> +</div><p> +<a class="anchor" name="c45504933db13e78c7dd12e68fab304f"></a><!-- doxytag: member="PxBinaryConverter::release" ref="c45504933db13e78c7dd12e68fab304f" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxBinaryConverter::release </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Releases binary converter. +<p> + +</div> +</div><p> +<a class="anchor" name="475c6a6dc11b63b3570f2fc5d21b5c0e"></a><!-- doxytag: member="PxBinaryConverter::setMetaData" ref="475c6a6dc11b63b3570f2fc5d21b5c0e" args="(PxInputStream &srcMetaData, PxInputStream &dstMetaData)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxBinaryConverter::setMetaData </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxInputStream.html">PxInputStream</a> & </td> + <td class="paramname"> <em>srcMetaData</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxInputStream.html">PxInputStream</a> & </td> + <td class="paramname"> <em>dstMetaData</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Setups source and target meta-data streams. +<p> +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.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>srcMetaData</em> </td><td>Source platform's meta-data stream </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>dstMetaData</em> </td><td>Target platform's meta-data stream</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if success </dd></dl> + +</div> +</div><p> +<a class="anchor" name="ba26eda3b46071eca65fa38cabee2a09"></a><!-- doxytag: member="PxBinaryConverter::setReportMode" ref="ba26eda3b46071eca65fa38cabee2a09" args="(PxConverterReportMode::Enum mode)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxBinaryConverter::setReportMode </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structPxConverterReportMode.html#abe051209d39df379f39bbe45bf4f1a3">PxConverterReportMode::Enum</a> </td> + <td class="paramname"> <em>mode</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets desired report mode. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>mode</em> </td><td>Report mode </td></tr> + </table> +</dl> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxBinaryConverter_8h-source.html">PxBinaryConverter.h</a></ul> +</div> + +<hr style="width: 100%; height: 2px;"><br> +Copyright © 2008-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a> +</body> +</html> |