class_stream_out.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.12.0"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Jolt Physics: StreamOut Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="clipboard.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript" src="resize.js"></script>
  17. <script type="text/javascript" src="cookie.js"></script>
  18. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  19. <script type="text/javascript" src="search/searchdata.js"></script>
  20. <script type="text/javascript" src="search/search.js"></script>
  21. <script type="text/x-mathjax-config">
  22. MathJax.Hub.Config({
  23. extensions: ["tex2jax.js"],
  24. jax: ["input/TeX","output/HTML-CSS"],
  25. });
  26. </script>
  27. <script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
  28. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  29. </head>
  30. <body>
  31. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  32. <div id="titlearea">
  33. <table cellspacing="0" cellpadding="0">
  34. <tbody>
  35. <tr id="projectrow">
  36. <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  37. <td id="projectalign">
  38. <div id="projectname">Jolt Physics
  39. </div>
  40. <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  41. </td>
  42. </tr>
  43. </tbody>
  44. </table>
  45. </div>
  46. <!-- end header part -->
  47. <!-- Generated by Doxygen 1.12.0 -->
  48. <script type="text/javascript">
  49. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  50. var searchBox = new SearchBox("searchBox", "search/",'.html');
  51. /* @license-end */
  52. </script>
  53. <script type="text/javascript">
  54. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  55. $(function() { codefold.init(0); });
  56. /* @license-end */
  57. </script>
  58. <script type="text/javascript" src="menudata.js"></script>
  59. <script type="text/javascript" src="menu.js"></script>
  60. <script type="text/javascript">
  61. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  62. $(function() {
  63. initMenu('',true,false,'search.php','Search',true);
  64. $(function() { init_search(); });
  65. });
  66. /* @license-end */
  67. </script>
  68. <div id="main-nav"></div>
  69. </div><!-- top -->
  70. <div id="side-nav" class="ui-resizable side-nav-resizable">
  71. <div id="nav-tree">
  72. <div id="nav-tree-contents">
  73. <div id="nav-sync" class="sync"></div>
  74. </div>
  75. </div>
  76. <div id="splitbar" style="-moz-user-select:none;"
  77. class="ui-resizable-handle">
  78. </div>
  79. </div>
  80. <script type="text/javascript">
  81. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  82. $(function(){initNavTree('class_stream_out.html',''); initResizable(true); });
  83. /* @license-end */
  84. </script>
  85. <div id="doc-content">
  86. <!-- window showing the filter options -->
  87. <div id="MSearchSelectWindow"
  88. onmouseover="return searchBox.OnSearchSelectShow()"
  89. onmouseout="return searchBox.OnSearchSelectHide()"
  90. onkeydown="return searchBox.OnSearchSelectKey(event)">
  91. </div>
  92. <!-- iframe showing the search results (closed by default) -->
  93. <div id="MSearchResultsWindow">
  94. <div id="MSearchResults">
  95. <div class="SRPage">
  96. <div id="SRIndex">
  97. <div id="SRResults"></div>
  98. <div class="SRStatus" id="Loading">Loading...</div>
  99. <div class="SRStatus" id="Searching">Searching...</div>
  100. <div class="SRStatus" id="NoMatches">No Matches</div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="header">
  106. <div class="summary">
  107. <a href="#pub-methods">Public Member Functions</a> &#124;
  108. <a href="class_stream_out-members.html">List of all members</a> </div>
  109. <div class="headertitle"><div class="title">StreamOut Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <p>Simple binary output stream.
  113. <a href="#details">More...</a></p>
  114. <p><code>#include &lt;<a class="el" href="_stream_out_8h_source.html">StreamOut.h</a>&gt;</code></p>
  115. <div class="dynheader">
  116. Inheritance diagram for StreamOut:</div>
  117. <div class="dyncontent">
  118. <div class="center">
  119. <img src="class_stream_out.png" usemap="#StreamOut_map" alt=""/>
  120. <map id="StreamOut_map" name="StreamOut_map">
  121. <area href="class_non_copyable.html" title="Class that makes another class non-copyable. Usage: Inherit from NonCopyable." alt="NonCopyable" shape="rect" coords="65,0,185,24"/>
  122. <area href="class_state_recorder.html" alt="StateRecorder" shape="rect" coords="0,112,120,136"/>
  123. <area href="class_stream_out_wrapper.html" title="Wrapper around std::ostream." alt="StreamOutWrapper" shape="rect" coords="130,112,250,136"/>
  124. <area href="class_state_recorder_impl.html" title="Implementation of the StateRecorder class that uses a stringstream as underlying store and that imple..." alt="StateRecorderImpl" shape="rect" coords="0,168,120,192"/>
  125. </map>
  126. </div></div>
  127. <table class="memberdecls">
  128. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  129. Public Member Functions</h2></td></tr>
  130. <tr class="memitem:aed2cfe74214f89965cb640ac9d1bbb8d" id="r_aed2cfe74214f89965cb640ac9d1bbb8d"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aed2cfe74214f89965cb640ac9d1bbb8d">~StreamOut</a> ()=default</td></tr>
  131. <tr class="memdesc:aed2cfe74214f89965cb640ac9d1bbb8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor. <br /></td></tr>
  132. <tr class="separator:aed2cfe74214f89965cb640ac9d1bbb8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:aa80bff3216178ef392693f1997803d99" id="r_aa80bff3216178ef392693f1997803d99"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa80bff3216178ef392693f1997803d99">WriteBytes</a> (const void *inData, size_t inNumBytes)=0</td></tr>
  134. <tr class="memdesc:aa80bff3216178ef392693f1997803d99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a string of bytes to the binary stream. <br /></td></tr>
  135. <tr class="separator:aa80bff3216178ef392693f1997803d99"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a30c9fa2d50a64c0da4d6dc5ae614e756" id="r_a30c9fa2d50a64c0da4d6dc5ae614e756"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a30c9fa2d50a64c0da4d6dc5ae614e756">IsFailed</a> () const =0</td></tr>
  137. <tr class="memdesc:a30c9fa2d50a64c0da4d6dc5ae614e756"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if there was an IO failure. <br /></td></tr>
  138. <tr class="separator:a30c9fa2d50a64c0da4d6dc5ae614e756"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a879dce6c6c6ca5e63835fe61cc745966" id="r_a879dce6c6c6ca5e63835fe61cc745966"><td class="memTemplParams" colspan="2">template&lt;class T , std::enable_if_t&lt; std::is_trivially_copyable_v&lt; T &gt;, bool &gt; = true&gt; </td></tr>
  140. <tr class="memitem:a879dce6c6c6ca5e63835fe61cc745966"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a879dce6c6c6ca5e63835fe61cc745966">Write</a> (const T &amp;inT)</td></tr>
  141. <tr class="memdesc:a879dce6c6c6ca5e63835fe61cc745966"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a primitive (e.g. float, int, etc.) to the binary stream. <br /></td></tr>
  142. <tr class="separator:a879dce6c6c6ca5e63835fe61cc745966"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a8e42be27dba5676379ba723df9171c4f" id="r_a8e42be27dba5676379ba723df9171c4f"><td class="memTemplParams" colspan="2">template&lt;class T , class A , std::enable_if_t&lt; std::is_trivially_copyable_v&lt; T &gt;, bool &gt; = true&gt; </td></tr>
  144. <tr class="memitem:a8e42be27dba5676379ba723df9171c4f"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a8e42be27dba5676379ba723df9171c4f">Write</a> (const <a class="el" href="class_array.html">Array</a>&lt; T, A &gt; &amp;inT)</td></tr>
  145. <tr class="memdesc:a8e42be27dba5676379ba723df9171c4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a vector of primitives to the binary stream. <br /></td></tr>
  146. <tr class="separator:a8e42be27dba5676379ba723df9171c4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:ae1b1f7fee2bcf46896c198ff13eabf10" id="r_ae1b1f7fee2bcf46896c198ff13eabf10"><td class="memTemplParams" colspan="2">template&lt;class Type , class Traits , class Allocator &gt; </td></tr>
  148. <tr class="memitem:ae1b1f7fee2bcf46896c198ff13eabf10"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ae1b1f7fee2bcf46896c198ff13eabf10">Write</a> (const std::basic_string&lt; Type, Traits, Allocator &gt; &amp;inString)</td></tr>
  149. <tr class="memdesc:ae1b1f7fee2bcf46896c198ff13eabf10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a string to the binary stream (writes the number of characters and then the characters) <br /></td></tr>
  150. <tr class="separator:ae1b1f7fee2bcf46896c198ff13eabf10"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:a29fc4077677e5c0fea89194178326684" id="r_a29fc4077677e5c0fea89194178326684"><td class="memTemplParams" colspan="2">template&lt;class T , class A , typename F &gt; </td></tr>
  152. <tr class="memitem:a29fc4077677e5c0fea89194178326684"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a29fc4077677e5c0fea89194178326684">Write</a> (const <a class="el" href="class_array.html">Array</a>&lt; T, A &gt; &amp;inT, const F &amp;inWriteElement)</td></tr>
  153. <tr class="memdesc:a29fc4077677e5c0fea89194178326684"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a vector of primitives to the binary stream using a custom write function. <br /></td></tr>
  154. <tr class="separator:a29fc4077677e5c0fea89194178326684"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:a067f43db7805fa22f5ffefbefac23b13" id="r_a067f43db7805fa22f5ffefbefac23b13"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a067f43db7805fa22f5ffefbefac23b13">Write</a> (const <a class="el" href="class_vec3.html">Vec3</a> &amp;inVec)</td></tr>
  156. <tr class="memdesc:a067f43db7805fa22f5ffefbefac23b13"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a <a class="el" href="class_vec3.html">Vec3</a> (don't write W) <br /></td></tr>
  157. <tr class="separator:a067f43db7805fa22f5ffefbefac23b13"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:a5c9dec0ec5fb4af10a3258f03fa99bb1" id="r_a5c9dec0ec5fb4af10a3258f03fa99bb1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5c9dec0ec5fb4af10a3258f03fa99bb1">Write</a> (const <a class="el" href="class_d_vec3.html">DVec3</a> &amp;inVec)</td></tr>
  159. <tr class="memdesc:a5c9dec0ec5fb4af10a3258f03fa99bb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a <a class="el" href="class_d_vec3.html">DVec3</a> (don't write W) <br /></td></tr>
  160. <tr class="separator:a5c9dec0ec5fb4af10a3258f03fa99bb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:a076687e0453908f83336761c13b75f19" id="r_a076687e0453908f83336761c13b75f19"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a076687e0453908f83336761c13b75f19">Write</a> (const <a class="el" href="class_d_mat44.html">DMat44</a> &amp;inVec)</td></tr>
  162. <tr class="memdesc:a076687e0453908f83336761c13b75f19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a <a class="el" href="class_d_mat44.html" title="Holds a 4x4 matrix of floats with the last column consisting of doubles.">DMat44</a> (don't write W component of translation) <br /></td></tr>
  163. <tr class="separator:a076687e0453908f83336761c13b75f19"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="inherit_header pub_methods_class_non_copyable"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_non_copyable')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_non_copyable.html">NonCopyable</a></td></tr>
  165. <tr class="memitem:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable" id="r_a809b6e4ade7ae32f6d248f2a3b783d45"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a809b6e4ade7ae32f6d248f2a3b783d45">NonCopyable</a> ()=default</td></tr>
  166. <tr class="separator:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <tr class="memitem:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable" id="r_a501d34ffcc34b30de6d541887a901057"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a501d34ffcc34b30de6d541887a901057">NonCopyable</a> (const <a class="el" href="class_non_copyable.html">NonCopyable</a> &amp;)=delete</td></tr>
  168. <tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <tr class="memitem:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable" id="r_aaf9b12dcaae80c9d304df7a941d4e21f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#aaf9b12dcaae80c9d304df7a941d4e21f">operator=</a> (const <a class="el" href="class_non_copyable.html">NonCopyable</a> &amp;)=delete</td></tr>
  170. <tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  171. </table>
  172. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  173. <div class="textblock"><p>Simple binary output stream. </p>
  174. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  175. <a id="aed2cfe74214f89965cb640ac9d1bbb8d" name="aed2cfe74214f89965cb640ac9d1bbb8d"></a>
  176. <h2 class="memtitle"><span class="permalink"><a href="#aed2cfe74214f89965cb640ac9d1bbb8d">&#9670;&#160;</a></span>~StreamOut()</h2>
  177. <div class="memitem">
  178. <div class="memproto">
  179. <table class="mlabels">
  180. <tr>
  181. <td class="mlabels-left">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname">virtual StreamOut::~StreamOut </td>
  185. <td>(</td>
  186. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  187. <td></td>
  188. </tr>
  189. </table>
  190. </td>
  191. <td class="mlabels-right">
  192. <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
  193. </tr>
  194. </table>
  195. </div><div class="memdoc">
  196. <p>Virtual destructor. </p>
  197. </div>
  198. </div>
  199. <h2 class="groupheader">Member Function Documentation</h2>
  200. <a id="a30c9fa2d50a64c0da4d6dc5ae614e756" name="a30c9fa2d50a64c0da4d6dc5ae614e756"></a>
  201. <h2 class="memtitle"><span class="permalink"><a href="#a30c9fa2d50a64c0da4d6dc5ae614e756">&#9670;&#160;</a></span>IsFailed()</h2>
  202. <div class="memitem">
  203. <div class="memproto">
  204. <table class="mlabels">
  205. <tr>
  206. <td class="mlabels-left">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">virtual bool StreamOut::IsFailed </td>
  210. <td>(</td>
  211. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  212. <td> const</td>
  213. </tr>
  214. </table>
  215. </td>
  216. <td class="mlabels-right">
  217. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. <p>Returns true if there was an IO failure. </p>
  222. <p>Implemented in <a class="el" href="class_state_recorder_impl.html#a30053c8a2baa5e3cb4e5e26c37afda05">StateRecorderImpl</a>, and <a class="el" href="class_stream_out_wrapper.html#a2da7c93d54165f7cbab4678fe83abb32">StreamOutWrapper</a>.</p>
  223. </div>
  224. </div>
  225. <a id="a8e42be27dba5676379ba723df9171c4f" name="a8e42be27dba5676379ba723df9171c4f"></a>
  226. <h2 class="memtitle"><span class="permalink"><a href="#a8e42be27dba5676379ba723df9171c4f">&#9670;&#160;</a></span>Write() <span class="overload">[1/7]</span></h2>
  227. <div class="memitem">
  228. <div class="memproto">
  229. <div class="memtemplate">
  230. template&lt;class T , class A , std::enable_if_t&lt; std::is_trivially_copyable_v&lt; T &gt;, bool &gt; = true&gt; </div>
  231. <table class="mlabels">
  232. <tr>
  233. <td class="mlabels-left">
  234. <table class="memname">
  235. <tr>
  236. <td class="memname">void StreamOut::Write </td>
  237. <td>(</td>
  238. <td class="paramtype">const <a class="el" href="class_array.html">Array</a>&lt; T, A &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>inT</em></span></td><td>)</td>
  239. <td></td>
  240. </tr>
  241. </table>
  242. </td>
  243. <td class="mlabels-right">
  244. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  245. </tr>
  246. </table>
  247. </div><div class="memdoc">
  248. <p>Write a vector of primitives to the binary stream. </p>
  249. </div>
  250. </div>
  251. <a id="a29fc4077677e5c0fea89194178326684" name="a29fc4077677e5c0fea89194178326684"></a>
  252. <h2 class="memtitle"><span class="permalink"><a href="#a29fc4077677e5c0fea89194178326684">&#9670;&#160;</a></span>Write() <span class="overload">[2/7]</span></h2>
  253. <div class="memitem">
  254. <div class="memproto">
  255. <div class="memtemplate">
  256. template&lt;class T , class A , typename F &gt; </div>
  257. <table class="mlabels">
  258. <tr>
  259. <td class="mlabels-left">
  260. <table class="memname">
  261. <tr>
  262. <td class="memname">void StreamOut::Write </td>
  263. <td>(</td>
  264. <td class="paramtype">const <a class="el" href="class_array.html">Array</a>&lt; T, A &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>inT</em></span>, </td>
  265. </tr>
  266. <tr>
  267. <td class="paramkey"></td>
  268. <td></td>
  269. <td class="paramtype">const F &amp;</td> <td class="paramname"><span class="paramname"><em>inWriteElement</em></span>&#160;)</td>
  270. </tr>
  271. </table>
  272. </td>
  273. <td class="mlabels-right">
  274. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  275. </tr>
  276. </table>
  277. </div><div class="memdoc">
  278. <p>Write a vector of primitives to the binary stream using a custom write function. </p>
  279. </div>
  280. </div>
  281. <a id="a076687e0453908f83336761c13b75f19" name="a076687e0453908f83336761c13b75f19"></a>
  282. <h2 class="memtitle"><span class="permalink"><a href="#a076687e0453908f83336761c13b75f19">&#9670;&#160;</a></span>Write() <span class="overload">[3/7]</span></h2>
  283. <div class="memitem">
  284. <div class="memproto">
  285. <table class="mlabels">
  286. <tr>
  287. <td class="mlabels-left">
  288. <table class="memname">
  289. <tr>
  290. <td class="memname">void StreamOut::Write </td>
  291. <td>(</td>
  292. <td class="paramtype">const <a class="el" href="class_d_mat44.html">DMat44</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inVec</em></span></td><td>)</td>
  293. <td></td>
  294. </tr>
  295. </table>
  296. </td>
  297. <td class="mlabels-right">
  298. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  299. </tr>
  300. </table>
  301. </div><div class="memdoc">
  302. <p>Write a <a class="el" href="class_d_mat44.html" title="Holds a 4x4 matrix of floats with the last column consisting of doubles.">DMat44</a> (don't write W component of translation) </p>
  303. </div>
  304. </div>
  305. <a id="a5c9dec0ec5fb4af10a3258f03fa99bb1" name="a5c9dec0ec5fb4af10a3258f03fa99bb1"></a>
  306. <h2 class="memtitle"><span class="permalink"><a href="#a5c9dec0ec5fb4af10a3258f03fa99bb1">&#9670;&#160;</a></span>Write() <span class="overload">[4/7]</span></h2>
  307. <div class="memitem">
  308. <div class="memproto">
  309. <table class="mlabels">
  310. <tr>
  311. <td class="mlabels-left">
  312. <table class="memname">
  313. <tr>
  314. <td class="memname">void StreamOut::Write </td>
  315. <td>(</td>
  316. <td class="paramtype">const <a class="el" href="class_d_vec3.html">DVec3</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inVec</em></span></td><td>)</td>
  317. <td></td>
  318. </tr>
  319. </table>
  320. </td>
  321. <td class="mlabels-right">
  322. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  323. </tr>
  324. </table>
  325. </div><div class="memdoc">
  326. <p>Write a <a class="el" href="class_d_vec3.html">DVec3</a> (don't write W) </p>
  327. </div>
  328. </div>
  329. <a id="ae1b1f7fee2bcf46896c198ff13eabf10" name="ae1b1f7fee2bcf46896c198ff13eabf10"></a>
  330. <h2 class="memtitle"><span class="permalink"><a href="#ae1b1f7fee2bcf46896c198ff13eabf10">&#9670;&#160;</a></span>Write() <span class="overload">[5/7]</span></h2>
  331. <div class="memitem">
  332. <div class="memproto">
  333. <div class="memtemplate">
  334. template&lt;class Type , class Traits , class Allocator &gt; </div>
  335. <table class="mlabels">
  336. <tr>
  337. <td class="mlabels-left">
  338. <table class="memname">
  339. <tr>
  340. <td class="memname">void StreamOut::Write </td>
  341. <td>(</td>
  342. <td class="paramtype">const std::basic_string&lt; Type, Traits, Allocator &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>inString</em></span></td><td>)</td>
  343. <td></td>
  344. </tr>
  345. </table>
  346. </td>
  347. <td class="mlabels-right">
  348. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  349. </tr>
  350. </table>
  351. </div><div class="memdoc">
  352. <p>Write a string to the binary stream (writes the number of characters and then the characters) </p>
  353. </div>
  354. </div>
  355. <a id="a879dce6c6c6ca5e63835fe61cc745966" name="a879dce6c6c6ca5e63835fe61cc745966"></a>
  356. <h2 class="memtitle"><span class="permalink"><a href="#a879dce6c6c6ca5e63835fe61cc745966">&#9670;&#160;</a></span>Write() <span class="overload">[6/7]</span></h2>
  357. <div class="memitem">
  358. <div class="memproto">
  359. <div class="memtemplate">
  360. template&lt;class T , std::enable_if_t&lt; std::is_trivially_copyable_v&lt; T &gt;, bool &gt; = true&gt; </div>
  361. <table class="mlabels">
  362. <tr>
  363. <td class="mlabels-left">
  364. <table class="memname">
  365. <tr>
  366. <td class="memname">void StreamOut::Write </td>
  367. <td>(</td>
  368. <td class="paramtype">const T &amp;</td> <td class="paramname"><span class="paramname"><em>inT</em></span></td><td>)</td>
  369. <td></td>
  370. </tr>
  371. </table>
  372. </td>
  373. <td class="mlabels-right">
  374. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  375. </tr>
  376. </table>
  377. </div><div class="memdoc">
  378. <p>Write a primitive (e.g. float, int, etc.) to the binary stream. </p>
  379. </div>
  380. </div>
  381. <a id="a067f43db7805fa22f5ffefbefac23b13" name="a067f43db7805fa22f5ffefbefac23b13"></a>
  382. <h2 class="memtitle"><span class="permalink"><a href="#a067f43db7805fa22f5ffefbefac23b13">&#9670;&#160;</a></span>Write() <span class="overload">[7/7]</span></h2>
  383. <div class="memitem">
  384. <div class="memproto">
  385. <table class="mlabels">
  386. <tr>
  387. <td class="mlabels-left">
  388. <table class="memname">
  389. <tr>
  390. <td class="memname">void StreamOut::Write </td>
  391. <td>(</td>
  392. <td class="paramtype">const <a class="el" href="class_vec3.html">Vec3</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inVec</em></span></td><td>)</td>
  393. <td></td>
  394. </tr>
  395. </table>
  396. </td>
  397. <td class="mlabels-right">
  398. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  399. </tr>
  400. </table>
  401. </div><div class="memdoc">
  402. <p>Write a <a class="el" href="class_vec3.html">Vec3</a> (don't write W) </p>
  403. </div>
  404. </div>
  405. <a id="aa80bff3216178ef392693f1997803d99" name="aa80bff3216178ef392693f1997803d99"></a>
  406. <h2 class="memtitle"><span class="permalink"><a href="#aa80bff3216178ef392693f1997803d99">&#9670;&#160;</a></span>WriteBytes()</h2>
  407. <div class="memitem">
  408. <div class="memproto">
  409. <table class="mlabels">
  410. <tr>
  411. <td class="mlabels-left">
  412. <table class="memname">
  413. <tr>
  414. <td class="memname">virtual void StreamOut::WriteBytes </td>
  415. <td>(</td>
  416. <td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>inData</em></span>, </td>
  417. </tr>
  418. <tr>
  419. <td class="paramkey"></td>
  420. <td></td>
  421. <td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>inNumBytes</em></span>&#160;)</td>
  422. </tr>
  423. </table>
  424. </td>
  425. <td class="mlabels-right">
  426. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  427. </tr>
  428. </table>
  429. </div><div class="memdoc">
  430. <p>Write a string of bytes to the binary stream. </p>
  431. <p>Implemented in <a class="el" href="class_state_recorder_impl.html#acb747a3036d744b372bc5c5ec5fda143">StateRecorderImpl</a>, and <a class="el" href="class_stream_out_wrapper.html#a9021148d55d478d1431b9196e96c8125">StreamOutWrapper</a>.</p>
  432. </div>
  433. </div>
  434. <hr/>The documentation for this class was generated from the following file:<ul>
  435. <li>Jolt/Core/<a class="el" href="_stream_out_8h_source.html">StreamOut.h</a></li>
  436. </ul>
  437. </div><!-- contents -->
  438. </div><!-- doc-content -->
  439. <!-- start footer part -->
  440. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  441. <ul>
  442. <li class="navelem"><a class="el" href="class_stream_out.html">StreamOut</a></li>
  443. <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
  444. </ul>
  445. </div>
  446. </body>
  447. </html>