diff options
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxOutputStream.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxOutputStream.html | 119 |
1 files changed, 119 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxOutputStream.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxOutputStream.html new file mode 100644 index 00000000..62ab999c --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxOutputStream.html @@ -0,0 +1,119 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxOutputStream 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>PxOutputStream Class Reference<br> +<small> +[<a class="el" href="group__common.html">Common</a>]</small> +</h1><!-- doxytag: class="PxOutputStream" -->Output stream class for I/O. +<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 PxOutputStream:</div> +<div class="dynsection"> +<p><center><img src="classPxOutputStream__inherit__graph.png" border="0" usemap="#PxOutputStream__inherit__map" alt="Inheritance graph"></center> +<map name="PxOutputStream__inherit__map"> +<area shape="rect" href="classPxDefaultFileOutputStream.html" title="default implementation of a file write stream" alt="PxDefaultFileOutputStream" coords="7,85,172,107"><area shape="rect" href="classPxDefaultMemoryOutputStream.html" title="default implementation of a memory write stream" alt="PxDefaultMemoryOutputStream" coords="196,85,385,107"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxOutputStream-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="classPxOutputStream.html#21b2d0c73d63560533c9e85487224123">write</a> (const void *src, uint32_t count)=0</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="#21b2d0c73d63560533c9e85487224123"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxOutputStream.html#0ae7333d40100aa27d0cc38a13335561">~PxOutputStream</a> ()</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Output stream class for I/O. +<p> +The user needs to supply a <a class="el" href="classPxOutputStream.html" title="Output stream class for I/O.">PxOutputStream</a> implementation to a number of methods to allow the SDK to write data. <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="0ae7333d40100aa27d0cc38a13335561"></a><!-- doxytag: member="PxOutputStream::~PxOutputStream" ref="0ae7333d40100aa27d0cc38a13335561" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxOutputStream::~PxOutputStream </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="21b2d0c73d63560533c9e85487224123"></a><!-- doxytag: member="PxOutputStream::write" ref="21b2d0c73d63560533c9e85487224123" args="(const void *src, uint32_t count)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual uint32_t PxOutputStream::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">uint32_t </td> + <td class="paramname"> <em>count</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> +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>Implemented in <a class="el" href="classPxDefaultMemoryOutputStream.html#b7d49736023500446a317cea1199781c">PxDefaultMemoryOutputStream</a>, and <a class="el" href="classPxDefaultFileOutputStream.html#45786a8e9d0576b5e28fdd67633579f9">PxDefaultFileOutputStream</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> |