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/classPxDefaultMemoryInputData.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/classPxDefaultMemoryInputData.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultMemoryInputData.html | 276 |
1 files changed, 276 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultMemoryInputData.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultMemoryInputData.html new file mode 100644 index 00000000..c9cb3380 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultMemoryInputData.html @@ -0,0 +1,276 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxDefaultMemoryInputData 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>PxDefaultMemoryInputData Class Reference<br> +<small> +[<a class="el" href="group__extensions.html">Extensions</a>]</small> +</h1><!-- doxytag: class="PxDefaultMemoryInputData" --><!-- doxytag: inherits="PxInputData" -->default implementation of a memory read stream +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxDefaultStreams_8h-source.html">PxDefaultStreams.h</a>></code> +<p> +<div class="dynheader"> +Inheritance diagram for PxDefaultMemoryInputData:</div> +<div class="dynsection"> +<p><center><img src="classPxDefaultMemoryInputData__inherit__graph.png" border="0" usemap="#PxDefaultMemoryInputData__inherit__map" alt="Inheritance graph"></center> +<map name="PxDefaultMemoryInputData__inherit__map"> +<area shape="rect" href="classPxInputData.html" title="Input data class for I/O which provides random read access." alt="PxInputData" coords="49,85,129,106"><area shape="rect" href="classPxInputStream.html" title="Input stream class for I/O." alt="PxInputStream" coords="43,16,136,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxDefaultMemoryInputData:</div> +<div class="dynsection"> +<p><center><img src="classPxDefaultMemoryInputData__coll__graph.png" border="0" usemap="#PxDefaultMemoryInputData__coll__map" alt="Collaboration graph"></center> +<map name="PxDefaultMemoryInputData__coll__map"> +<area shape="rect" href="classPxInputData.html" title="Input data class for I/O which provides random read access." alt="PxInputData" coords="49,85,129,106"><area shape="rect" href="classPxInputStream.html" title="Input stream class for I/O." alt="PxInputStream" coords="43,16,136,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxDefaultMemoryInputData-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultMemoryInputData.html#c8fb2f18c72eeac8eddcd2e018705de4">PxDefaultMemoryInputData</a> (PxU8 *data, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> length)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultMemoryInputData.html#f668db47bc18351643ae6a78820d014c">read</a> (void *dest, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> count)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">read from the stream. The number of bytes read may be less than the number requested. <a href="#f668db47bc18351643ae6a78820d014c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultMemoryInputData.html#5eaf7235ef71a21076d7fd3e9c1217d8">getLength</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">return the length of the input data <a href="#5eaf7235ef71a21076d7fd3e9c1217d8"></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="classPxDefaultMemoryInputData.html#7344d413c8bdf97731fd63d06ba26b54">seek</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> pos)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">seek to the given offset from the start of the data. <a href="#7344d413c8bdf97731fd63d06ba26b54"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultMemoryInputData.html#b1cfdfea691176a7ba377a2ce5892c3b">tell</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">return the current offset from the start of the data <a href="#b1cfdfea691176a7ba377a2ce5892c3b"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultMemoryInputData.html#5d64ba75b217d982a1b8b589c0231977">mSize</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">const PxU8 * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultMemoryInputData.html#247c643f455325808808536711001d8e">mData</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultMemoryInputData.html#7d0fc8bcea095380c4fc2fc8af51510f">mPos</a></td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +default implementation of a memory read stream +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxInputData.html" title="Input data class for I/O which provides random read access.">PxInputData</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="c8fb2f18c72eeac8eddcd2e018705de4"></a><!-- doxytag: member="PxDefaultMemoryInputData::PxDefaultMemoryInputData" ref="c8fb2f18c72eeac8eddcd2e018705de4" args="(PxU8 *data, PxU32 length)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxDefaultMemoryInputData::PxDefaultMemoryInputData </td> + <td>(</td> + <td class="paramtype">PxU8 * </td> + <td class="paramname"> <em>data</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>length</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="5eaf7235ef71a21076d7fd3e9c1217d8"></a><!-- doxytag: member="PxDefaultMemoryInputData::getLength" ref="5eaf7235ef71a21076d7fd3e9c1217d8" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxDefaultMemoryInputData::getLength </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [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>Implements <a class="el" href="classPxInputData.html#bab049ab736da6c5880426f3d977698b">PxInputData</a>.</p> + +</div> +</div><p> +<a class="anchor" name="f668db47bc18351643ae6a78820d014c"></a><!-- doxytag: member="PxDefaultMemoryInputData::read" ref="f668db47bc18351643ae6a78820d014c" args="(void *dest, PxU32 count)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxDefaultMemoryInputData::read </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>dest</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>count</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +read from the stream. The number of bytes read may be less than the number requested. +<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>dest</em> </td><td>the destination address to which the data will be read </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>count</em> </td><td>the number of bytes requested</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of bytes read from the stream. </dd></dl> + +<p>Implements <a class="el" href="classPxInputStream.html#74fdc1e5af87577e7cc13cc99894b2b3">PxInputStream</a>.</p> + +</div> +</div><p> +<a class="anchor" name="7344d413c8bdf97731fd63d06ba26b54"></a><!-- doxytag: member="PxDefaultMemoryInputData::seek" ref="7344d413c8bdf97731fd63d06ba26b54" args="(PxU32 pos)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxDefaultMemoryInputData::seek </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>offset</em> </td> + <td> ) </td> + <td><code> [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>Implements <a class="el" href="classPxInputData.html#c80d55021a6bae02a1cc64d27a98c575">PxInputData</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b1cfdfea691176a7ba377a2ce5892c3b"></a><!-- doxytag: member="PxDefaultMemoryInputData::tell" ref="b1cfdfea691176a7ba377a2ce5892c3b" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxDefaultMemoryInputData::tell </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [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>Implements <a class="el" href="classPxInputData.html#5ce54bcfb43ca0e9dd22bf15fcf75cab">PxInputData</a>.</p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="247c643f455325808808536711001d8e"></a><!-- doxytag: member="PxDefaultMemoryInputData::mData" ref="247c643f455325808808536711001d8e" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const PxU8* <a class="el" href="classPxDefaultMemoryInputData.html#247c643f455325808808536711001d8e">PxDefaultMemoryInputData::mData</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="7d0fc8bcea095380c4fc2fc8af51510f"></a><!-- doxytag: member="PxDefaultMemoryInputData::mPos" ref="7d0fc8bcea095380c4fc2fc8af51510f" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxDefaultMemoryInputData.html#7d0fc8bcea095380c4fc2fc8af51510f">PxDefaultMemoryInputData::mPos</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="5d64ba75b217d982a1b8b589c0231977"></a><!-- doxytag: member="PxDefaultMemoryInputData::mSize" ref="5d64ba75b217d982a1b8b589c0231977" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxDefaultMemoryInputData.html#5d64ba75b217d982a1b8b589c0231977">PxDefaultMemoryInputData::mSize</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxDefaultStreams_8h-source.html">PxDefaultStreams.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> |