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/classPxDefaultMemoryOutputStream.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/classPxDefaultMemoryOutputStream.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultMemoryOutputStream.html | 306 |
1 files changed, 306 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultMemoryOutputStream.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultMemoryOutputStream.html new file mode 100644 index 00000000..de3789a8 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultMemoryOutputStream.html @@ -0,0 +1,306 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxDefaultMemoryOutputStream 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>PxDefaultMemoryOutputStream Class Reference<br> +<small> +[<a class="el" href="group__extensions.html">Extensions</a>]</small> +</h1><!-- doxytag: class="PxDefaultMemoryOutputStream" --><!-- doxytag: inherits="PxOutputStream" -->default implementation of a memory write 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 PxDefaultMemoryOutputStream:</div> +<div class="dynsection"> +<p><center><img src="classPxDefaultMemoryOutputStream__inherit__graph.png" border="0" usemap="#PxDefaultMemoryOutputStream__inherit__map" alt="Inheritance graph"></center> +<map name="PxDefaultMemoryOutputStream__inherit__map"> +<area shape="rect" href="classPxOutputStream.html" title="Output stream class for I/O." alt="PxOutputStream" coords="49,16,153,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxDefaultMemoryOutputStream:</div> +<div class="dynsection"> +<p><center><img src="classPxDefaultMemoryOutputStream__coll__graph.png" border="0" usemap="#PxDefaultMemoryOutputStream__coll__map" alt="Collaboration graph"></center> +<map name="PxDefaultMemoryOutputStream__coll__map"> +<area shape="rect" href="classPxOutputStream.html" title="Output stream class for I/O." alt="PxOutputStream" coords="7,16,111,37"><area shape="rect" href="classPxAllocatorCallback.html" title="Abstract base class for an application defined memory allocator that can be used..." alt="PxAllocatorCallback" coords="135,16,257,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxDefaultMemoryOutputStream-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="classPxDefaultMemoryOutputStream.html#8d2f97d7f4f7a06f86459125eff5f906">PxDefaultMemoryOutputStream</a> (<a class="el" href="classPxAllocatorCallback.html">PxAllocatorCallback</a> &allocator=PxGetFoundation().getAllocatorCallback())</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultMemoryOutputStream.html#501c7dba2d56b002bd2ecc0fdd4c6692">~PxDefaultMemoryOutputStream</a> ()</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="classPxDefaultMemoryOutputStream.html#b7d49736023500446a317cea1199781c">write</a> (const void *src, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> count)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">write to the stream. The number of bytes written may be less than the number sent. <a href="#b7d49736023500446a317cea1199781c"></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="classPxDefaultMemoryOutputStream.html#e23aaf88551ab3d85ca27390b86fdfea">getSize</a> () const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxU8 * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultMemoryOutputStream.html#ac3810ed0a79753c8a57a1e2e2100429">getData</a> () const </td></tr> + +<tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultMemoryOutputStream.html#b614a4132e87957445a54f88f8c6dd95">PxDefaultMemoryOutputStream</a> (const <a class="el" href="classPxDefaultMemoryOutputStream.html">PxDefaultMemoryOutputStream</a> &)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxDefaultMemoryOutputStream.html">PxDefaultMemoryOutputStream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultMemoryOutputStream.html#f324822d2b0d254c8755c3d96dd1fc15">operator=</a> (const <a class="el" href="classPxDefaultMemoryOutputStream.html">PxDefaultMemoryOutputStream</a> &)</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="classPxAllocatorCallback.html">PxAllocatorCallback</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultMemoryOutputStream.html#3d8f2f29dc441c1b94589c055217d643">mAllocator</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxU8 * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultMemoryOutputStream.html#e25764087eea2b0f40ef2a558a2cee8e">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="classPxDefaultMemoryOutputStream.html#b9abe9444842678e7876d065ee7213da">mSize</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="classPxDefaultMemoryOutputStream.html#1ccd0013c878d056cb78867d76c1ee6f">mCapacity</a></td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +default implementation of a memory write stream +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxOutputStream.html" title="Output stream class for I/O.">PxOutputStream</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="8d2f97d7f4f7a06f86459125eff5f906"></a><!-- doxytag: member="PxDefaultMemoryOutputStream::PxDefaultMemoryOutputStream" ref="8d2f97d7f4f7a06f86459125eff5f906" args="(PxAllocatorCallback &allocator=PxGetFoundation().getAllocatorCallback())" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxDefaultMemoryOutputStream::PxDefaultMemoryOutputStream </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxAllocatorCallback.html">PxAllocatorCallback</a> & </td> + <td class="paramname"> <em>allocator</em> = <code>PxGetFoundation().getAllocatorCallback()</code> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="501c7dba2d56b002bd2ecc0fdd4c6692"></a><!-- doxytag: member="PxDefaultMemoryOutputStream::~PxDefaultMemoryOutputStream" ref="501c7dba2d56b002bd2ecc0fdd4c6692" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxDefaultMemoryOutputStream::~PxDefaultMemoryOutputStream </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="b614a4132e87957445a54f88f8c6dd95"></a><!-- doxytag: member="PxDefaultMemoryOutputStream::PxDefaultMemoryOutputStream" ref="b614a4132e87957445a54f88f8c6dd95" args="(const PxDefaultMemoryOutputStream &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxDefaultMemoryOutputStream::PxDefaultMemoryOutputStream </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxDefaultMemoryOutputStream.html">PxDefaultMemoryOutputStream</a> & </td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="ac3810ed0a79753c8a57a1e2e2100429"></a><!-- doxytag: member="PxDefaultMemoryOutputStream::getData" ref="ac3810ed0a79753c8a57a1e2e2100429" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxU8* PxDefaultMemoryOutputStream::getData </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="e23aaf88551ab3d85ca27390b86fdfea"></a><!-- doxytag: member="PxDefaultMemoryOutputStream::getSize" ref="e23aaf88551ab3d85ca27390b86fdfea" 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> PxDefaultMemoryOutputStream::getSize </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="f324822d2b0d254c8755c3d96dd1fc15"></a><!-- doxytag: member="PxDefaultMemoryOutputStream::operator=" ref="f324822d2b0d254c8755c3d96dd1fc15" args="(const PxDefaultMemoryOutputStream &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxDefaultMemoryOutputStream.html">PxDefaultMemoryOutputStream</a>& PxDefaultMemoryOutputStream::operator= </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxDefaultMemoryOutputStream.html">PxDefaultMemoryOutputStream</a> & </td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="b7d49736023500446a317cea1199781c"></a><!-- doxytag: member="PxDefaultMemoryOutputStream::write" ref="b7d49736023500446a317cea1199781c" args="(const void *src, 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> PxDefaultMemoryOutputStream::write </td> + <td>(</td> + <td class="paramtype">const void * </td> + <td class="paramname"> <em>src</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> +write to the stream. The number of bytes written may be less than the number sent. +<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>src</em> </td><td>the destination address from which the data will be written </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>count</em> </td><td>the number of bytes to be written</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of bytes written to the stream by this call. </dd></dl> + +<p>Implements <a class="el" href="classPxOutputStream.html#21b2d0c73d63560533c9e85487224123">PxOutputStream</a>.</p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="3d8f2f29dc441c1b94589c055217d643"></a><!-- doxytag: member="PxDefaultMemoryOutputStream::mAllocator" ref="3d8f2f29dc441c1b94589c055217d643" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxAllocatorCallback.html">PxAllocatorCallback</a>& <a class="el" href="classPxDefaultMemoryOutputStream.html#3d8f2f29dc441c1b94589c055217d643">PxDefaultMemoryOutputStream::mAllocator</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="1ccd0013c878d056cb78867d76c1ee6f"></a><!-- doxytag: member="PxDefaultMemoryOutputStream::mCapacity" ref="1ccd0013c878d056cb78867d76c1ee6f" 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="classPxDefaultMemoryOutputStream.html#1ccd0013c878d056cb78867d76c1ee6f">PxDefaultMemoryOutputStream::mCapacity</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="e25764087eea2b0f40ef2a558a2cee8e"></a><!-- doxytag: member="PxDefaultMemoryOutputStream::mData" ref="e25764087eea2b0f40ef2a558a2cee8e" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxU8* <a class="el" href="classPxDefaultMemoryOutputStream.html#e25764087eea2b0f40ef2a558a2cee8e">PxDefaultMemoryOutputStream::mData</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="b9abe9444842678e7876d065ee7213da"></a><!-- doxytag: member="PxDefaultMemoryOutputStream::mSize" ref="b9abe9444842678e7876d065ee7213da" 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="classPxDefaultMemoryOutputStream.html#b9abe9444842678e7876d065ee7213da">PxDefaultMemoryOutputStream::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> |