diff options
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxFileBuf.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxFileBuf.html | 1004 |
1 files changed, 1004 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxFileBuf.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxFileBuf.html new file mode 100644 index 00000000..cb051301 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxFileBuf.html @@ -0,0 +1,1004 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxFileBuf 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>PxFileBuf Class Reference<br> +<small> +[<a class="el" href="group__foundation.html">Foundation</a>]</small> +</h1><!-- doxytag: class="PxFileBuf" -->Callback class for data serialization. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxFileBuf_8h-source.html">PxFileBuf.h</a>></code> +<p> + +<p> +<a href="classPxFileBuf-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 Types</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#17a9f8dcf7aeed5221f78ad2c785d122">EndianMode</a> { <br> + <a class="el" href="classPxFileBuf.html#17a9f8dcf7aeed5221f78ad2c785d122e9ca3a0e3b5d5a01c8526820e7c0ad29">ENDIAN_NONE</a> = 0, +<br> + <a class="el" href="classPxFileBuf.html#17a9f8dcf7aeed5221f78ad2c785d122250430fabf897a0a7215e927d90e804b">ENDIAN_BIG</a> = 1, +<br> + <a class="el" href="classPxFileBuf.html#17a9f8dcf7aeed5221f78ad2c785d1222ee31c8801eca6be180984790a83e29d">ENDIAN_LITTLE</a> = 2 +<br> + }</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#d90517c9062bd9c4f76c4f4b30cb8979">OpenMode</a> { <br> + <a class="el" href="classPxFileBuf.html#d90517c9062bd9c4f76c4f4b30cb897919f34fe662c01159bfc09b648b5b16cb">OPEN_FILE_NOT_FOUND</a>, +<br> + <a class="el" href="classPxFileBuf.html#d90517c9062bd9c4f76c4f4b30cb89798f05c34eecefaa76501a85ec4b0452a7">OPEN_READ_ONLY</a>, +<br> + <a class="el" href="classPxFileBuf.html#d90517c9062bd9c4f76c4f4b30cb8979b61521c34c90359331a05fb41ec8d481">OPEN_WRITE_ONLY</a>, +<br> + <a class="el" href="classPxFileBuf.html#d90517c9062bd9c4f76c4f4b30cb8979dea409bf3c24a9986d810b638652e759">OPEN_READ_WRITE_NEW</a>, +<br> + <a class="el" href="classPxFileBuf.html#d90517c9062bd9c4f76c4f4b30cb8979ddd857cb3d835234fd152a63f8501bcd">OPEN_READ_WRITE_EXISTING</a> +<br> + }</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#2442abc9fb9f4ff32fd191176a68dd7e">SeekType</a> { <br> + <a class="el" href="classPxFileBuf.html#2442abc9fb9f4ff32fd191176a68dd7e9a8656c41bea2287273ac71836425843">SEEKABLE_NO</a> = 0, +<br> + <a class="el" href="classPxFileBuf.html#2442abc9fb9f4ff32fd191176a68dd7ebecbf374e20587df095cb58179d586ea">SEEKABLE_READ</a> = 0x1, +<br> + <a class="el" href="classPxFileBuf.html#2442abc9fb9f4ff32fd191176a68dd7e73a929448a6bb5382f36ef56227d38c6">SEEKABLE_WRITE</a> = 0x2, +<br> + <a class="el" href="classPxFileBuf.html#2442abc9fb9f4ff32fd191176a68dd7e44122534caabc00563b8ecf22b5dfb8b">SEEKABLE_READWRITE</a> = 0x3 +<br> + }</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="classPxFileBuf.html#e46af0c1492c02d53ed1488361b5c7d6">PxFileBuf</a> (<a class="el" href="classPxFileBuf.html#17a9f8dcf7aeed5221f78ad2c785d122">EndianMode</a> mode=ENDIAN_LITTLE)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#99b5918f6ae9142a7a440c64055d419e">~PxFileBuf</a> (void)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxFileBuf.html#d90517c9062bd9c4f76c4f4b30cb8979">OpenMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#4cf7383163c096e2439b8c7cad9b8b77">getOpenMode</a> (void) const =0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#a48032ce922c102b5fe1d6defde7327d">isOpen</a> (void) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxFileBuf.html#2442abc9fb9f4ff32fd191176a68dd7e">SeekType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#2e8f911440f08c021f7a8a2e7303479f">isSeekable</a> (void) const =0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#f72ea9fc1222848db164855a3d8f8b70">setEndianMode</a> (<a class="el" href="classPxFileBuf.html#17a9f8dcf7aeed5221f78ad2c785d122">EndianMode</a> e)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxFileBuf.html#17a9f8dcf7aeed5221f78ad2c785d122">EndianMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#b4ed3ad02b31b227c3d6f250aba56f79">getEndianMode</a> (void) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#7b48571dd85bcdcb138fe8f000596921">getFileLength</a> (void) const =0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#e706ac6909e4fe16db22cbe1ca2dc53d">seekRead</a> (uint32_t loc)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Seeks the stream to a particular location for reading. <a href="#e706ac6909e4fe16db22cbe1ca2dc53d"></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="classPxFileBuf.html#7fab04894cb6b2c4440e87ca33d66340">seekWrite</a> (uint32_t loc)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Seeks the stream to a particular location for writing. <a href="#7fab04894cb6b2c4440e87ca33d66340"></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="classPxFileBuf.html#e95878d923a94bcaf3181164bcfc8a3f">read</a> (void *mem, uint32_t len)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads from the stream into a buffer. <a href="#e95878d923a94bcaf3181164bcfc8a3f"></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="classPxFileBuf.html#63e0abac3fa4cf71760142dd7088ef36">peek</a> (void *mem, uint32_t len)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads from the stream into a buffer but does not advance the read location. <a href="#63e0abac3fa4cf71760142dd7088ef36"></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="classPxFileBuf.html#28cf8048c35fbad96bd0ddf07daebbb6">write</a> (const void *mem, uint32_t len)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes a buffer of memory to the stream. <a href="#28cf8048c35fbad96bd0ddf07daebbb6"></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="classPxFileBuf.html#b9fe8c3cc65c200c567ae5136a235b0c">tellRead</a> (void) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Reports the current stream location read aqccess. <a href="#b9fe8c3cc65c200c567ae5136a235b0c"></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="classPxFileBuf.html#986d2a728e77c789dd2edb58bc965963">tellWrite</a> (void) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Reports the current stream location for write access. <a href="#986d2a728e77c789dd2edb58bc965963"></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="classPxFileBuf.html#7c923528768b05d87a40a9d33ab22397">flush</a> (void)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Causes any temporarily cached data to be flushed to the stream. <a href="#7c923528768b05d87a40a9d33ab22397"></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="classPxFileBuf.html#19a8aa14b29743084e9d8f8e983151ce">close</a> (void)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the stream. <a href="#19a8aa14b29743084e9d8f8e983151ce"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#29883e06738c0d08d7ec102a9259e0ff">release</a> (void)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#8f7aef54d065c1251bc729c32e898a9a">swap2Bytes</a> (void *_data) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#d3bec920f93f851d420875d3572db866">swap4Bytes</a> (void *_data) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#c26c76c0c790270716291cab5e29599f">swap8Bytes</a> (void *_data) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#c4522927d2ddb0af751443de8292cf84">storeDword</a> (uint32_t v)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#598346fa996f55e3e195cb5b5df86faa">storeFloat</a> (float v)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#24b58be8fbcfdb159411494cc6ff89c9">storeDouble</a> (double v)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#a050d73be42f3e7179374c5e91841392">storeByte</a> (uint8_t b)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#b37c7194f8a6728802b75f487b878499">storeWord</a> (uint16_t w)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#ceee4e153b50d05f28332f9996c6e94c">readByte</a> (void)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#be4421a263b5e3c60c81f5e0068bc863">readWord</a> (void)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#13cf0e0a8635da5e6b068489dee322a2">readDword</a> (void)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#9725184b0e5aaa962e04c490be374f97">readFloat</a> (void)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#de3c04f414a5d170b679c9731495f099">readDouble</a> (void)</td></tr> + +<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static PX_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#96838a3d29b0b91d2046b0aa4381eca6">isBigEndian</a> ()</td></tr> + +<tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static const uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#47cf6bed5f9dca3628f4b61fc6ec6eb8">STREAM_SEEK_END</a> = 0xFFFFFFFF</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Declares a constant to seek to the end of the stream. <a href="#47cf6bed5f9dca3628f4b61fc6ec6eb8"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#96cf617a20d1a36eee3e75557f7cd5c0">mEndianSwap</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxFileBuf.html#17a9f8dcf7aeed5221f78ad2c785d122">EndianMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxFileBuf.html#ca5971c98389434b3a37847a110cbfc3">mEndianMode</a></td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Callback class for data serialization. +<p> +The user needs to supply an <a class="el" href="classPxFileBuf.html" title="Callback class for data serialization.">PxFileBuf</a> implementation to a number of methods to allow the SDK to read or write chunks of binary data. This allows flexibility for the source/destination of the data. For example the <a class="el" href="classPxFileBuf.html" title="Callback class for data serialization.">PxFileBuf</a> could store data in a file, memory buffer or custom file format.<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>It is the users responsibility to ensure that the data is written to the appropriate offset. </dd></dl> +<hr><h2>Member Enumeration Documentation</h2> +<a class="anchor" name="17a9f8dcf7aeed5221f78ad2c785d122"></a><!-- doxytag: member="PxFileBuf::EndianMode" ref="17a9f8dcf7aeed5221f78ad2c785d122" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classPxFileBuf.html#17a9f8dcf7aeed5221f78ad2c785d122">PxFileBuf::EndianMode</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +<dl compact><dt><b>Enumerator: </b></dt><dd> +<table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" name="17a9f8dcf7aeed5221f78ad2c785d122e9ca3a0e3b5d5a01c8526820e7c0ad29"></a><!-- doxytag: member="ENDIAN_NONE" ref="17a9f8dcf7aeed5221f78ad2c785d122e9ca3a0e3b5d5a01c8526820e7c0ad29" args="" -->ENDIAN_NONE</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="17a9f8dcf7aeed5221f78ad2c785d122250430fabf897a0a7215e927d90e804b"></a><!-- doxytag: member="ENDIAN_BIG" ref="17a9f8dcf7aeed5221f78ad2c785d122250430fabf897a0a7215e927d90e804b" args="" -->ENDIAN_BIG</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="17a9f8dcf7aeed5221f78ad2c785d1222ee31c8801eca6be180984790a83e29d"></a><!-- doxytag: member="ENDIAN_LITTLE" ref="17a9f8dcf7aeed5221f78ad2c785d1222ee31c8801eca6be180984790a83e29d" args="" -->ENDIAN_LITTLE</em> </td><td> +</td></tr> +</table> +</dl> + +</div> +</div><p> +<a class="anchor" name="d90517c9062bd9c4f76c4f4b30cb8979"></a><!-- doxytag: member="PxFileBuf::OpenMode" ref="d90517c9062bd9c4f76c4f4b30cb8979" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classPxFileBuf.html#d90517c9062bd9c4f76c4f4b30cb8979">PxFileBuf::OpenMode</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +<dl compact><dt><b>Enumerator: </b></dt><dd> +<table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" name="d90517c9062bd9c4f76c4f4b30cb897919f34fe662c01159bfc09b648b5b16cb"></a><!-- doxytag: member="OPEN_FILE_NOT_FOUND" ref="d90517c9062bd9c4f76c4f4b30cb897919f34fe662c01159bfc09b648b5b16cb" args="" -->OPEN_FILE_NOT_FOUND</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="d90517c9062bd9c4f76c4f4b30cb89798f05c34eecefaa76501a85ec4b0452a7"></a><!-- doxytag: member="OPEN_READ_ONLY" ref="d90517c9062bd9c4f76c4f4b30cb89798f05c34eecefaa76501a85ec4b0452a7" args="" -->OPEN_READ_ONLY</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="d90517c9062bd9c4f76c4f4b30cb8979b61521c34c90359331a05fb41ec8d481"></a><!-- doxytag: member="OPEN_WRITE_ONLY" ref="d90517c9062bd9c4f76c4f4b30cb8979b61521c34c90359331a05fb41ec8d481" args="" -->OPEN_WRITE_ONLY</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="d90517c9062bd9c4f76c4f4b30cb8979dea409bf3c24a9986d810b638652e759"></a><!-- doxytag: member="OPEN_READ_WRITE_NEW" ref="d90517c9062bd9c4f76c4f4b30cb8979dea409bf3c24a9986d810b638652e759" args="" -->OPEN_READ_WRITE_NEW</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="d90517c9062bd9c4f76c4f4b30cb8979ddd857cb3d835234fd152a63f8501bcd"></a><!-- doxytag: member="OPEN_READ_WRITE_EXISTING" ref="d90517c9062bd9c4f76c4f4b30cb8979ddd857cb3d835234fd152a63f8501bcd" args="" -->OPEN_READ_WRITE_EXISTING</em> </td><td> +</td></tr> +</table> +</dl> + +</div> +</div><p> +<a class="anchor" name="2442abc9fb9f4ff32fd191176a68dd7e"></a><!-- doxytag: member="PxFileBuf::SeekType" ref="2442abc9fb9f4ff32fd191176a68dd7e" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classPxFileBuf.html#2442abc9fb9f4ff32fd191176a68dd7e">PxFileBuf::SeekType</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +<dl compact><dt><b>Enumerator: </b></dt><dd> +<table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" name="2442abc9fb9f4ff32fd191176a68dd7e9a8656c41bea2287273ac71836425843"></a><!-- doxytag: member="SEEKABLE_NO" ref="2442abc9fb9f4ff32fd191176a68dd7e9a8656c41bea2287273ac71836425843" args="" -->SEEKABLE_NO</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="2442abc9fb9f4ff32fd191176a68dd7ebecbf374e20587df095cb58179d586ea"></a><!-- doxytag: member="SEEKABLE_READ" ref="2442abc9fb9f4ff32fd191176a68dd7ebecbf374e20587df095cb58179d586ea" args="" -->SEEKABLE_READ</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="2442abc9fb9f4ff32fd191176a68dd7e73a929448a6bb5382f36ef56227d38c6"></a><!-- doxytag: member="SEEKABLE_WRITE" ref="2442abc9fb9f4ff32fd191176a68dd7e73a929448a6bb5382f36ef56227d38c6" args="" -->SEEKABLE_WRITE</em> </td><td> +</td></tr> +<tr><td valign="top"><em><a class="anchor" name="2442abc9fb9f4ff32fd191176a68dd7e44122534caabc00563b8ecf22b5dfb8b"></a><!-- doxytag: member="SEEKABLE_READWRITE" ref="2442abc9fb9f4ff32fd191176a68dd7e44122534caabc00563b8ecf22b5dfb8b" args="" -->SEEKABLE_READWRITE</em> </td><td> +</td></tr> +</table> +</dl> + +</div> +</div><p> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="e46af0c1492c02d53ed1488361b5c7d6"></a><!-- doxytag: member="PxFileBuf::PxFileBuf" ref="e46af0c1492c02d53ed1488361b5c7d6" args="(EndianMode mode=ENDIAN_LITTLE)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxFileBuf::PxFileBuf </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxFileBuf.html#17a9f8dcf7aeed5221f78ad2c785d122">EndianMode</a> </td> + <td class="paramname"> <em>mode</em> = <code>ENDIAN_LITTLE</code> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="99b5918f6ae9142a7a440c64055d419e"></a><!-- doxytag: member="PxFileBuf::~PxFileBuf" ref="99b5918f6ae9142a7a440c64055d419e" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxFileBuf::~PxFileBuf </td> + <td>(</td> + <td class="paramtype">void </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="19a8aa14b29743084e9d8f8e983151ce"></a><!-- doxytag: member="PxFileBuf::close" ref="19a8aa14b29743084e9d8f8e983151ce" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxFileBuf::close </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Close the stream. +<p> + +</div> +</div><p> +<a class="anchor" name="7c923528768b05d87a40a9d33ab22397"></a><!-- doxytag: member="PxFileBuf::flush" ref="7c923528768b05d87a40a9d33ab22397" args="(void)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxFileBuf::flush </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Causes any temporarily cached data to be flushed to the stream. +<p> + +</div> +</div><p> +<a class="anchor" name="b4ed3ad02b31b227c3d6f250aba56f79"></a><!-- doxytag: member="PxFileBuf::getEndianMode" ref="b4ed3ad02b31b227c3d6f250aba56f79" args="(void) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxFileBuf.html#17a9f8dcf7aeed5221f78ad2c785d122">EndianMode</a> PxFileBuf::getEndianMode </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="7b48571dd85bcdcb138fe8f000596921"></a><!-- doxytag: member="PxFileBuf::getFileLength" ref="7b48571dd85bcdcb138fe8f000596921" args="(void) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual uint32_t PxFileBuf::getFileLength </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="4cf7383163c096e2439b8c7cad9b8b77"></a><!-- doxytag: member="PxFileBuf::getOpenMode" ref="4cf7383163c096e2439b8c7cad9b8b77" args="(void) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxFileBuf.html#d90517c9062bd9c4f76c4f4b30cb8979">OpenMode</a> PxFileBuf::getOpenMode </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="96838a3d29b0b91d2046b0aa4381eca6"></a><!-- doxytag: member="PxFileBuf::isBigEndian" ref="96838a3d29b0b91d2046b0aa4381eca6" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static PX_INLINE bool PxFileBuf::isBigEndian </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline, static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="a48032ce922c102b5fe1d6defde7327d"></a><!-- doxytag: member="PxFileBuf::isOpen" ref="a48032ce922c102b5fe1d6defde7327d" args="(void) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool PxFileBuf::isOpen </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="2e8f911440f08c021f7a8a2e7303479f"></a><!-- doxytag: member="PxFileBuf::isSeekable" ref="2e8f911440f08c021f7a8a2e7303479f" args="(void) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxFileBuf.html#2442abc9fb9f4ff32fd191176a68dd7e">SeekType</a> PxFileBuf::isSeekable </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="63e0abac3fa4cf71760142dd7088ef36"></a><!-- doxytag: member="PxFileBuf::peek" ref="63e0abac3fa4cf71760142dd7088ef36" args="(void *mem, uint32_t len)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual uint32_t PxFileBuf::peek </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>mem</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"> <em>len</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> +Reads from the stream into a buffer but does not advance the read location. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>mem</em> </td><td>The buffer to read the stream into. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>len</em> </td><td>The number of bytes to stream into the buffer</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns the actual number of bytes read. If not equal to the length requested, then reached end of stream. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="e95878d923a94bcaf3181164bcfc8a3f"></a><!-- doxytag: member="PxFileBuf::read" ref="e95878d923a94bcaf3181164bcfc8a3f" args="(void *mem, uint32_t len)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual uint32_t PxFileBuf::read </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>mem</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"> <em>len</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> +Reads from the stream into a buffer. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>mem</em> </td><td>The buffer to read the stream into. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>len</em> </td><td>The number of bytes to stream into the buffer</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns the actual number of bytes read. If not equal to the length requested, then reached end of stream. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="ceee4e153b50d05f28332f9996c6e94c"></a><!-- doxytag: member="PxFileBuf::readByte" ref="ceee4e153b50d05f28332f9996c6e94c" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">uint8_t PxFileBuf::readByte </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="de3c04f414a5d170b679c9731495f099"></a><!-- doxytag: member="PxFileBuf::readDouble" ref="de3c04f414a5d170b679c9731495f099" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">double PxFileBuf::readDouble </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="13cf0e0a8635da5e6b068489dee322a2"></a><!-- doxytag: member="PxFileBuf::readDword" ref="13cf0e0a8635da5e6b068489dee322a2" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">uint32_t PxFileBuf::readDword </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="9725184b0e5aaa962e04c490be374f97"></a><!-- doxytag: member="PxFileBuf::readFloat" ref="9725184b0e5aaa962e04c490be374f97" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">float PxFileBuf::readFloat </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="be4421a263b5e3c60c81f5e0068bc863"></a><!-- doxytag: member="PxFileBuf::readWord" ref="be4421a263b5e3c60c81f5e0068bc863" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">uint16_t PxFileBuf::readWord </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="29883e06738c0d08d7ec102a9259e0ff"></a><!-- doxytag: member="PxFileBuf::release" ref="29883e06738c0d08d7ec102a9259e0ff" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PxFileBuf::release </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="e706ac6909e4fe16db22cbe1ca2dc53d"></a><!-- doxytag: member="PxFileBuf::seekRead" ref="e706ac6909e4fe16db22cbe1ca2dc53d" args="(uint32_t loc)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual uint32_t PxFileBuf::seekRead </td> + <td>(</td> + <td class="paramtype">uint32_t </td> + <td class="paramname"> <em>loc</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Seeks the stream to a particular location for reading. +<p> +If the location passed exceeds the length of the stream, then it will seek to the end. Returns the location it ended up at (useful if you seek to the end) to get the file position +</div> +</div><p> +<a class="anchor" name="7fab04894cb6b2c4440e87ca33d66340"></a><!-- doxytag: member="PxFileBuf::seekWrite" ref="7fab04894cb6b2c4440e87ca33d66340" args="(uint32_t loc)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual uint32_t PxFileBuf::seekWrite </td> + <td>(</td> + <td class="paramtype">uint32_t </td> + <td class="paramname"> <em>loc</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Seeks the stream to a particular location for writing. +<p> +If the location passed exceeds the length of the stream, then it will seek to the end. Returns the location it ended up at (useful if you seek to the end) to get the file position +</div> +</div><p> +<a class="anchor" name="f72ea9fc1222848db164855a3d8f8b70"></a><!-- doxytag: member="PxFileBuf::setEndianMode" ref="f72ea9fc1222848db164855a3d8f8b70" args="(EndianMode e)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void PxFileBuf::setEndianMode </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxFileBuf.html#17a9f8dcf7aeed5221f78ad2c785d122">EndianMode</a> </td> + <td class="paramname"> <em>e</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="a050d73be42f3e7179374c5e91841392"></a><!-- doxytag: member="PxFileBuf::storeByte" ref="a050d73be42f3e7179374c5e91841392" args="(uint8_t b)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE void PxFileBuf::storeByte </td> + <td>(</td> + <td class="paramtype">uint8_t </td> + <td class="paramname"> <em>b</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="24b58be8fbcfdb159411494cc6ff89c9"></a><!-- doxytag: member="PxFileBuf::storeDouble" ref="24b58be8fbcfdb159411494cc6ff89c9" args="(double v)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE void PxFileBuf::storeDouble </td> + <td>(</td> + <td class="paramtype">double </td> + <td class="paramname"> <em>v</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="c4522927d2ddb0af751443de8292cf84"></a><!-- doxytag: member="PxFileBuf::storeDword" ref="c4522927d2ddb0af751443de8292cf84" args="(uint32_t v)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE void PxFileBuf::storeDword </td> + <td>(</td> + <td class="paramtype">uint32_t </td> + <td class="paramname"> <em>v</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="598346fa996f55e3e195cb5b5df86faa"></a><!-- doxytag: member="PxFileBuf::storeFloat" ref="598346fa996f55e3e195cb5b5df86faa" args="(float v)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE void PxFileBuf::storeFloat </td> + <td>(</td> + <td class="paramtype">float </td> + <td class="paramname"> <em>v</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="b37c7194f8a6728802b75f487b878499"></a><!-- doxytag: member="PxFileBuf::storeWord" ref="b37c7194f8a6728802b75f487b878499" args="(uint16_t w)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE void PxFileBuf::storeWord </td> + <td>(</td> + <td class="paramtype">uint16_t </td> + <td class="paramname"> <em>w</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="8f7aef54d065c1251bc729c32e898a9a"></a><!-- doxytag: member="PxFileBuf::swap2Bytes" ref="8f7aef54d065c1251bc729c32e898a9a" args="(void *_data) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE void PxFileBuf::swap2Bytes </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>_data</em> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="d3bec920f93f851d420875d3572db866"></a><!-- doxytag: member="PxFileBuf::swap4Bytes" ref="d3bec920f93f851d420875d3572db866" args="(void *_data) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE void PxFileBuf::swap4Bytes </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>_data</em> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="c26c76c0c790270716291cab5e29599f"></a><!-- doxytag: member="PxFileBuf::swap8Bytes" ref="c26c76c0c790270716291cab5e29599f" args="(void *_data) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE void PxFileBuf::swap8Bytes </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>_data</em> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="b9fe8c3cc65c200c567ae5136a235b0c"></a><!-- doxytag: member="PxFileBuf::tellRead" ref="b9fe8c3cc65c200c567ae5136a235b0c" args="(void) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual uint32_t PxFileBuf::tellRead </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Reports the current stream location read aqccess. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns the current stream read location. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="986d2a728e77c789dd2edb58bc965963"></a><!-- doxytag: member="PxFileBuf::tellWrite" ref="986d2a728e77c789dd2edb58bc965963" args="(void) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual uint32_t PxFileBuf::tellWrite </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Reports the current stream location for write access. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns the current stream write location. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="28cf8048c35fbad96bd0ddf07daebbb6"></a><!-- doxytag: member="PxFileBuf::write" ref="28cf8048c35fbad96bd0ddf07daebbb6" args="(const void *mem, uint32_t len)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual uint32_t PxFileBuf::write </td> + <td>(</td> + <td class="paramtype">const void * </td> + <td class="paramname"> <em>mem</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"> <em>len</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> +Writes a buffer of memory to the stream. +<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>mem</em> </td><td>The address of a buffer of memory to send to the stream. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>len</em> </td><td>The number of bytes to send to the stream.</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns the actual number of bytes sent to the stream. If not equal to the length specific, then the stream is full or unable to write for some reason. </dd></dl> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="ca5971c98389434b3a37847a110cbfc3"></a><!-- doxytag: member="PxFileBuf::mEndianMode" ref="ca5971c98389434b3a37847a110cbfc3" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxFileBuf.html#17a9f8dcf7aeed5221f78ad2c785d122">EndianMode</a> <a class="el" href="classPxFileBuf.html#ca5971c98389434b3a37847a110cbfc3">PxFileBuf::mEndianMode</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="96cf617a20d1a36eee3e75557f7cd5c0"></a><!-- doxytag: member="PxFileBuf::mEndianSwap" ref="96cf617a20d1a36eee3e75557f7cd5c0" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool <a class="el" href="classPxFileBuf.html#96cf617a20d1a36eee3e75557f7cd5c0">PxFileBuf::mEndianSwap</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="47cf6bed5f9dca3628f4b61fc6ec6eb8"></a><!-- doxytag: member="PxFileBuf::STREAM_SEEK_END" ref="47cf6bed5f9dca3628f4b61fc6ec6eb8" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const uint32_t <a class="el" href="classPxFileBuf.html#47cf6bed5f9dca3628f4b61fc6ec6eb8">PxFileBuf::STREAM_SEEK_END</a> = 0xFFFFFFFF<code> [static]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Declares a constant to seek to the end of the stream. +<p> +Does not support streams longer than 32 bits +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxFileBuf_8h-source.html">PxFileBuf.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> |