diff options
| author | git perforce import user <a@b> | 2016-10-25 12:29:14 -0600 |
|---|---|---|
| committer | Sheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees> | 2016-10-25 18:56:37 -0500 |
| commit | 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch) | |
| tree | fa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PhysX_3.4/Documentation/PhysXAPI/files/classPxInputData.html | |
| download | physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip | |
Initial commit:
PhysX 3.4.0 Update @ 21294896
APEX 1.4.0 Update @ 21275617
[CL 21300167]
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxInputData.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxInputData.html | 169 |
1 files changed, 169 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxInputData.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxInputData.html new file mode 100644 index 00000000..cb664028 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxInputData.html @@ -0,0 +1,169 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxInputData 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>PxInputData Class Reference<br> +<small> +[<a class="el" href="group__common.html">Common</a>]</small> +</h1><!-- doxytag: class="PxInputData" --><!-- doxytag: inherits="PxInputStream" -->Input data class for I/O which provides random read access. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxIO_8h-source.html">PxIO.h</a>></code> +<p> +<div class="dynheader"> +Inheritance diagram for PxInputData:</div> +<div class="dynsection"> +<p><center><img src="classPxInputData__inherit__graph.png" border="0" usemap="#PxInputData__inherit__map" alt="Inheritance graph"></center> +<map name="PxInputData__inherit__map"> +<area shape="rect" href="classPxDefaultFileInputData.html" title="default implementation of a file read stream" alt="PxDefaultFileInputData" coords="7,154,148,176"><area shape="rect" href="classPxDefaultMemoryInputData.html" title="default implementation of a memory read stream" alt="PxDefaultMemoryInputData" coords="172,154,337,176"><area shape="rect" href="classPxInputStream.html" title="Input stream class for I/O." alt="PxInputStream" coords="119,16,212,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxInputData:</div> +<div class="dynsection"> +<p><center><img src="classPxInputData__coll__graph.png" border="0" usemap="#PxInputData__coll__map" alt="Collaboration graph"></center> +<map name="PxInputData__coll__map"> +<area shape="rect" href="classPxInputStream.html" title="Input stream class for I/O." alt="PxInputStream" coords="7,16,100,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxInputData-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 uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxInputData.html#bab049ab736da6c5880426f3d977698b">getLength</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">return the length of the input data <a href="#bab049ab736da6c5880426f3d977698b"></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="classPxInputData.html#c80d55021a6bae02a1cc64d27a98c575">seek</a> (uint32_t offset)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">seek to the given offset from the start of the data. <a href="#c80d55021a6bae02a1cc64d27a98c575"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxInputData.html#5ce54bcfb43ca0e9dd22bf15fcf75cab">tell</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">return the current offset from the start of the data <a href="#5ce54bcfb43ca0e9dd22bf15fcf75cab"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxInputData.html#e82db2806183495ecc5b22adc3386b3a">~PxInputData</a> ()</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Input data class for I/O which provides random read access. +<p> +The user needs to supply a <a class="el" href="classPxInputData.html" title="Input data class for I/O which provides random read access.">PxInputData</a> implementation to a number of methods to allow the SDK to read data. <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="e82db2806183495ecc5b22adc3386b3a"></a><!-- doxytag: member="PxInputData::~PxInputData" ref="e82db2806183495ecc5b22adc3386b3a" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxInputData::~PxInputData </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="bab049ab736da6c5880426f3d977698b"></a><!-- doxytag: member="PxInputData::getLength" ref="bab049ab736da6c5880426f3d977698b" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual uint32_t PxInputData::getLength </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +return the length of the input data +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>size in bytes of the input data </dd></dl> + +<p>Implemented in <a class="el" href="classPxDefaultMemoryInputData.html#5eaf7235ef71a21076d7fd3e9c1217d8">PxDefaultMemoryInputData</a>, and <a class="el" href="classPxDefaultFileInputData.html#a62b6c699d8f741f52e105a44a5ffe2a">PxDefaultFileInputData</a>.</p> + +</div> +</div><p> +<a class="anchor" name="c80d55021a6bae02a1cc64d27a98c575"></a><!-- doxytag: member="PxInputData::seek" ref="c80d55021a6bae02a1cc64d27a98c575" args="(uint32_t offset)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxInputData::seek </td> + <td>(</td> + <td class="paramtype">uint32_t </td> + <td class="paramname"> <em>offset</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +seek to the given offset from the start of the 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>offset</em> </td><td>the offset to seek to. If greater than the length of the data, this call is equivalent to seek(length); </td></tr> + </table> +</dl> + +<p>Implemented in <a class="el" href="classPxDefaultMemoryInputData.html#7344d413c8bdf97731fd63d06ba26b54">PxDefaultMemoryInputData</a>, and <a class="el" href="classPxDefaultFileInputData.html#234ab504e8d281b6e0319e40dcac7c4d">PxDefaultFileInputData</a>.</p> + +</div> +</div><p> +<a class="anchor" name="5ce54bcfb43ca0e9dd22bf15fcf75cab"></a><!-- doxytag: member="PxInputData::tell" ref="5ce54bcfb43ca0e9dd22bf15fcf75cab" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual uint32_t PxInputData::tell </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +return the current offset from the start of the data +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>the offset to seek to. </dd></dl> + +<p>Implemented in <a class="el" href="classPxDefaultMemoryInputData.html#b1cfdfea691176a7ba377a2ce5892c3b">PxDefaultMemoryInputData</a>, and <a class="el" href="classPxDefaultFileInputData.html#d2f00723bda0098239c4b8201c6812d3">PxDefaultFileInputData</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxIO_8h-source.html">PxIO.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> |