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/classPxDefaultFileOutputStream.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/classPxDefaultFileOutputStream.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultFileOutputStream.html | 189 |
1 files changed, 189 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultFileOutputStream.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultFileOutputStream.html new file mode 100644 index 00000000..6e8da9e2 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxDefaultFileOutputStream.html @@ -0,0 +1,189 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxDefaultFileOutputStream 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>PxDefaultFileOutputStream Class Reference<br> +<small> +[<a class="el" href="group__extensions.html">Extensions</a>]</small> +</h1><!-- doxytag: class="PxDefaultFileOutputStream" --><!-- doxytag: inherits="PxOutputStream" -->default implementation of a file 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 PxDefaultFileOutputStream:</div> +<div class="dynsection"> +<p><center><img src="classPxDefaultFileOutputStream__inherit__graph.png" border="0" usemap="#PxDefaultFileOutputStream__inherit__map" alt="Inheritance graph"></center> +<map name="PxDefaultFileOutputStream__inherit__map"> +<area shape="rect" href="classPxOutputStream.html" title="Output stream class for I/O." alt="PxOutputStream" coords="37,16,141,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxDefaultFileOutputStream:</div> +<div class="dynsection"> +<p><center><img src="classPxDefaultFileOutputStream__coll__graph.png" border="0" usemap="#PxDefaultFileOutputStream__coll__map" alt="Collaboration graph"></center> +<map name="PxDefaultFileOutputStream__coll__map"> +<area shape="rect" href="classPxOutputStream.html" title="Output stream class for I/O." alt="PxOutputStream" coords="37,16,141,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxDefaultFileOutputStream-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="classPxDefaultFileOutputStream.html#add35e22bcb4df88ea5a0f688b836cdb">PxDefaultFileOutputStream</a> (const char *name)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultFileOutputStream.html#d25e313493fb0deea69efd4189a44196">~PxDefaultFileOutputStream</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="classPxDefaultFileOutputStream.html#45786a8e9d0576b5e28fdd67633579f9">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="#45786a8e9d0576b5e28fdd67633579f9"></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="classPxDefaultFileOutputStream.html#46036cddd7aaad0dad24396c53c79c64">isValid</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="group__extensions.html#g8e55355887d57086f097b0248b7ea768">PxFileHandle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultFileOutputStream.html#62b7a48dbf016209274ca69a8da382a3">mFile</a></td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +default implementation of a file 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="add35e22bcb4df88ea5a0f688b836cdb"></a><!-- doxytag: member="PxDefaultFileOutputStream::PxDefaultFileOutputStream" ref="add35e22bcb4df88ea5a0f688b836cdb" args="(const char *name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxDefaultFileOutputStream::PxDefaultFileOutputStream </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>name</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="d25e313493fb0deea69efd4189a44196"></a><!-- doxytag: member="PxDefaultFileOutputStream::~PxDefaultFileOutputStream" ref="d25e313493fb0deea69efd4189a44196" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxDefaultFileOutputStream::~PxDefaultFileOutputStream </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="46036cddd7aaad0dad24396c53c79c64"></a><!-- doxytag: member="PxDefaultFileOutputStream::isValid" ref="46036cddd7aaad0dad24396c53c79c64" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxDefaultFileOutputStream::isValid </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="45786a8e9d0576b5e28fdd67633579f9"></a><!-- doxytag: member="PxDefaultFileOutputStream::write" ref="45786a8e9d0576b5e28fdd67633579f9" 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> PxDefaultFileOutputStream::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="62b7a48dbf016209274ca69a8da382a3"></a><!-- doxytag: member="PxDefaultFileOutputStream::mFile" ref="62b7a48dbf016209274ca69a8da382a3" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__extensions.html#g8e55355887d57086f097b0248b7ea768">PxFileHandle</a> <a class="el" href="classPxDefaultFileOutputStream.html#62b7a48dbf016209274ca69a8da382a3">PxDefaultFileOutputStream::mFile</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> |