group__stream__overload.html 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187
  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.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Torque2D Reference: Primitive Type Stream Operation Overloads</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. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr id="projectrow">
  24. <td id="projectalign">
  25. <div id="projectname">Torque2D Reference
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.8 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. </div><!-- top -->
  51. <!-- window showing the filter options -->
  52. <div id="MSearchSelectWindow"
  53. onmouseover="return searchBox.OnSearchSelectShow()"
  54. onmouseout="return searchBox.OnSearchSelectHide()"
  55. onkeydown="return searchBox.OnSearchSelectKey(event)">
  56. </div>
  57. <!-- iframe showing the search results (closed by default) -->
  58. <div id="MSearchResultsWindow">
  59. <div id="MSearchResults">
  60. <div class="SRPage">
  61. <div id="SRIndex">
  62. <div id="SRResults"></div>
  63. <div class="SRStatus" id="Loading">Loading...</div>
  64. <div class="SRStatus" id="Searching">Searching...</div>
  65. <div class="SRStatus" id="NoMatches">No Matches</div>
  66. </div>
  67. </div>
  68. </div>
  69. </div>
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#define-members">Macros</a> </div>
  73. <div class="headertitle"><div class="title">Primitive Type Stream Operation Overloads</div></div>
  74. </div><!--header-->
  75. <div class="contents">
  76. <table class="memberdecls">
  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
  78. Macros</h2></td></tr>
  79. <tr class="memitem:ga55d4e4047dc040cab91539c7d189000c" id="r_ga55d4e4047dc040cab91539c7d189000c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__stream__overload.html#ga55d4e4047dc040cab91539c7d189000c">DECLARE_OVERLOADED_READ</a>(type)</td></tr>
  80. <tr class="separator:ga55d4e4047dc040cab91539c7d189000c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:gad0f87207ae4230934fa31bc659eac85b" id="r_gad0f87207ae4230934fa31bc659eac85b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__stream__overload.html#gad0f87207ae4230934fa31bc659eac85b">DECLARE_OVERLOADED_WRITE</a>(type)</td></tr>
  82. <tr class="separator:gad0f87207ae4230934fa31bc659eac85b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:ga023081d239c600f646f1142949330e15" id="r_ga023081d239c600f646f1142949330e15"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__stream__overload.html#ga023081d239c600f646f1142949330e15">DECLARE_ENDIAN_OVERLOADED_READ</a>(type)</td></tr>
  84. <tr class="separator:ga023081d239c600f646f1142949330e15"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:ga0ac84d066326297d5df8b7d38162c7ca" id="r_ga0ac84d066326297d5df8b7d38162c7ca"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__stream__overload.html#ga0ac84d066326297d5df8b7d38162c7ca">DECLARE_ENDIAN_OVERLOADED_WRITE</a>(type)</td></tr>
  86. <tr class="separator:ga0ac84d066326297d5df8b7d38162c7ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. </table>
  88. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  89. <p>These macros define the read and write functions for all primitive types. </p>
  90. <h2 class="groupheader">Macro Definition Documentation</h2>
  91. <a id="ga023081d239c600f646f1142949330e15" name="ga023081d239c600f646f1142949330e15"></a>
  92. <h2 class="memtitle"><span class="permalink"><a href="#ga023081d239c600f646f1142949330e15">&#9670;&#160;</a></span>DECLARE_ENDIAN_OVERLOADED_READ</h2>
  93. <div class="memitem">
  94. <div class="memproto">
  95. <table class="memname">
  96. <tr>
  97. <td class="memname">#define DECLARE_ENDIAN_OVERLOADED_READ</td>
  98. <td>(</td>
  99. <td class="paramtype">&#160;</td>
  100. <td class="paramname">type</td><td>)</td>
  101. <td></td>
  102. </tr>
  103. </table>
  104. </div><div class="memdoc">
  105. <b>Value:</b><div class="fragment"><div class="line"> <span class="keywordtype">bool</span> read(type* out_read) { \</div>
  106. <div class="line"> type temp; \</div>
  107. <div class="line"> <span class="keywordtype">bool</span> success = read(<span class="keyword">sizeof</span>(type), &amp;temp); \</div>
  108. <div class="line"> *out_read = convertLEndianToHost(temp); \</div>
  109. <div class="line"> <span class="keywordflow">return</span> success; \</div>
  110. <div class="line"> }</div>
  111. </div><!-- fragment -->
  112. </div>
  113. </div>
  114. <a id="ga0ac84d066326297d5df8b7d38162c7ca" name="ga0ac84d066326297d5df8b7d38162c7ca"></a>
  115. <h2 class="memtitle"><span class="permalink"><a href="#ga0ac84d066326297d5df8b7d38162c7ca">&#9670;&#160;</a></span>DECLARE_ENDIAN_OVERLOADED_WRITE</h2>
  116. <div class="memitem">
  117. <div class="memproto">
  118. <table class="memname">
  119. <tr>
  120. <td class="memname">#define DECLARE_ENDIAN_OVERLOADED_WRITE</td>
  121. <td>(</td>
  122. <td class="paramtype">&#160;</td>
  123. <td class="paramname">type</td><td>)</td>
  124. <td></td>
  125. </tr>
  126. </table>
  127. </div><div class="memdoc">
  128. <b>Value:</b><div class="fragment"><div class="line"> <span class="keywordtype">bool</span> write(type in_write) { \</div>
  129. <div class="line"> type temp = convertHostToLEndian(in_write); \</div>
  130. <div class="line"> <span class="keywordflow">return</span> write(<span class="keyword">sizeof</span>(type), &amp;temp); \</div>
  131. <div class="line"> }</div>
  132. </div><!-- fragment -->
  133. </div>
  134. </div>
  135. <a id="ga55d4e4047dc040cab91539c7d189000c" name="ga55d4e4047dc040cab91539c7d189000c"></a>
  136. <h2 class="memtitle"><span class="permalink"><a href="#ga55d4e4047dc040cab91539c7d189000c">&#9670;&#160;</a></span>DECLARE_OVERLOADED_READ</h2>
  137. <div class="memitem">
  138. <div class="memproto">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname">#define DECLARE_OVERLOADED_READ</td>
  142. <td>(</td>
  143. <td class="paramtype">&#160;</td>
  144. <td class="paramname">type</td><td>)</td>
  145. <td></td>
  146. </tr>
  147. </table>
  148. </div><div class="memdoc">
  149. <b>Value:</b><div class="fragment"><div class="line"> <span class="keywordtype">bool</span> read(type* out_read) { \</div>
  150. <div class="line"> <span class="keywordflow">return</span> read(<span class="keyword">sizeof</span>(type), out_read); \</div>
  151. <div class="line"> }</div>
  152. </div><!-- fragment -->
  153. </div>
  154. </div>
  155. <a id="gad0f87207ae4230934fa31bc659eac85b" name="gad0f87207ae4230934fa31bc659eac85b"></a>
  156. <h2 class="memtitle"><span class="permalink"><a href="#gad0f87207ae4230934fa31bc659eac85b">&#9670;&#160;</a></span>DECLARE_OVERLOADED_WRITE</h2>
  157. <div class="memitem">
  158. <div class="memproto">
  159. <table class="memname">
  160. <tr>
  161. <td class="memname">#define DECLARE_OVERLOADED_WRITE</td>
  162. <td>(</td>
  163. <td class="paramtype">&#160;</td>
  164. <td class="paramname">type</td><td>)</td>
  165. <td></td>
  166. </tr>
  167. </table>
  168. </div><div class="memdoc">
  169. <b>Value:</b><div class="fragment"><div class="line"> <span class="keywordtype">bool</span> write(type in_write) { \</div>
  170. <div class="line"> <span class="keywordflow">return</span> write(<span class="keyword">sizeof</span>(type), &amp;in_write); \</div>
  171. <div class="line"> }</div>
  172. </div><!-- fragment -->
  173. </div>
  174. </div>
  175. </div><!-- contents -->
  176. <!-- start footer part -->
  177. <hr class="footer"/><address class="footer"><small>
  178. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
  179. </small></address>
  180. </body>
  181. </html>