class_bit_tables.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266
  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: BitTables 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. <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. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <div id="MSearchResults">
  59. <div class="SRPage">
  60. <div id="SRIndex">
  61. <div id="SRResults"></div>
  62. <div class="SRStatus" id="Loading">Loading...</div>
  63. <div class="SRStatus" id="Searching">Searching...</div>
  64. <div class="SRStatus" id="NoMatches">No Matches</div>
  65. </div>
  66. </div>
  67. </div>
  68. </div>
  69. </div><!-- top -->
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#pub-methods">Public Member Functions</a> &#124;
  73. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  74. <a href="class_bit_tables-members.html">List of all members</a> </div>
  75. <div class="headertitle"><div class="title">BitTables Class Reference</div></div>
  76. </div><!--header-->
  77. <div class="contents">
  78. <p><code>#include &lt;bitTables.h&gt;</code></p>
  79. <table class="memberdecls">
  80. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  81. Public Member Functions</h2></td></tr>
  82. <tr class="memitem:af6823845764cec5b0f558338ee00cfd4" id="r_af6823845764cec5b0f558338ee00cfd4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bit_tables.html#af6823845764cec5b0f558338ee00cfd4">BitTables</a> ()</td></tr>
  83. <tr class="separator:af6823845764cec5b0f558338ee00cfd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. </table><table class="memberdecls">
  85. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
  86. Static Public Member Functions</h2></td></tr>
  87. <tr class="memitem:ae9528278c80fb4088b1ed7c6dbf41247" id="r_ae9528278c80fb4088b1ed7c6dbf41247"><td class="memItemLeft" align="right" valign="top">static const S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bit_tables.html#ae9528278c80fb4088b1ed7c6dbf41247">numOn</a> (U8 b)</td></tr>
  88. <tr class="memdesc:ae9528278c80fb4088b1ed7c6dbf41247"><td class="mdescLeft">&#160;</td><td class="mdescRight">How many bits are on? <br /></td></tr>
  89. <tr class="separator:ae9528278c80fb4088b1ed7c6dbf41247"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:ad23aa12c4bfe93788f32d170c9e6217a" id="r_ad23aa12c4bfe93788f32d170c9e6217a"><td class="memItemLeft" align="right" valign="top">static const S8 *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bit_tables.html#ad23aa12c4bfe93788f32d170c9e6217a">whichOn</a> (U8 b)</td></tr>
  91. <tr class="memdesc:ad23aa12c4bfe93788f32d170c9e6217a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to 8 S8's, which are set according to which bits are set in the passed value. <br /></td></tr>
  92. <tr class="separator:ad23aa12c4bfe93788f32d170c9e6217a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:acc30b44b7de05a53a7d07ef226fa6ba0" id="r_acc30b44b7de05a53a7d07ef226fa6ba0"><td class="memItemLeft" align="right" valign="top">static const S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bit_tables.html#acc30b44b7de05a53a7d07ef226fa6ba0">highBit</a> (U8 b)</td></tr>
  94. <tr class="separator:acc30b44b7de05a53a7d07ef226fa6ba0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a5b095ad647db31bfb745111171ff2445" id="r_a5b095ad647db31bfb745111171ff2445"><td class="memItemLeft" align="right" valign="top">static S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bit_tables.html#a5b095ad647db31bfb745111171ff2445">getPower16</a> (U16 x)</td></tr>
  96. <tr class="separator:a5b095ad647db31bfb745111171ff2445"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a9570f9bc09a629801d1e6db9f9b539f7" id="r_a9570f9bc09a629801d1e6db9f9b539f7"><td class="memItemLeft" align="right" valign="top">static S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bit_tables.html#a9570f9bc09a629801d1e6db9f9b539f7">getPower32</a> (U32 x)</td></tr>
  98. <tr class="separator:a9570f9bc09a629801d1e6db9f9b539f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. </table>
  100. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  101. <a id="af6823845764cec5b0f558338ee00cfd4" name="af6823845764cec5b0f558338ee00cfd4"></a>
  102. <h2 class="memtitle"><span class="permalink"><a href="#af6823845764cec5b0f558338ee00cfd4">&#9670;&#160;</a></span>BitTables()</h2>
  103. <div class="memitem">
  104. <div class="memproto">
  105. <table class="memname">
  106. <tr>
  107. <td class="memname"><a class="el" href="class_bit_tables.html">BitTables</a> </td>
  108. <td>(</td>
  109. <td class="paramname"></td><td>)</td>
  110. <td></td>
  111. </tr>
  112. </table>
  113. </div><div class="memdoc">
  114. </div>
  115. </div>
  116. <h2 class="groupheader">Member Function Documentation</h2>
  117. <a id="a5b095ad647db31bfb745111171ff2445" name="a5b095ad647db31bfb745111171ff2445"></a>
  118. <h2 class="memtitle"><span class="permalink"><a href="#a5b095ad647db31bfb745111171ff2445">&#9670;&#160;</a></span>getPower16()</h2>
  119. <div class="memitem">
  120. <div class="memproto">
  121. <table class="mlabels">
  122. <tr>
  123. <td class="mlabels-left">
  124. <table class="memname">
  125. <tr>
  126. <td class="memname">static S32 getPower16 </td>
  127. <td>(</td>
  128. <td class="paramtype">U16&#160;</td>
  129. <td class="paramname"><em>x</em></td><td>)</td>
  130. <td></td>
  131. </tr>
  132. </table>
  133. </td>
  134. <td class="mlabels-right">
  135. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  136. </tr>
  137. </table>
  138. </div><div class="memdoc">
  139. </div>
  140. </div>
  141. <a id="a9570f9bc09a629801d1e6db9f9b539f7" name="a9570f9bc09a629801d1e6db9f9b539f7"></a>
  142. <h2 class="memtitle"><span class="permalink"><a href="#a9570f9bc09a629801d1e6db9f9b539f7">&#9670;&#160;</a></span>getPower32()</h2>
  143. <div class="memitem">
  144. <div class="memproto">
  145. <table class="mlabels">
  146. <tr>
  147. <td class="mlabels-left">
  148. <table class="memname">
  149. <tr>
  150. <td class="memname">static S32 getPower32 </td>
  151. <td>(</td>
  152. <td class="paramtype">U32&#160;</td>
  153. <td class="paramname"><em>x</em></td><td>)</td>
  154. <td></td>
  155. </tr>
  156. </table>
  157. </td>
  158. <td class="mlabels-right">
  159. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  160. </tr>
  161. </table>
  162. </div><div class="memdoc">
  163. </div>
  164. </div>
  165. <a id="acc30b44b7de05a53a7d07ef226fa6ba0" name="acc30b44b7de05a53a7d07ef226fa6ba0"></a>
  166. <h2 class="memtitle"><span class="permalink"><a href="#acc30b44b7de05a53a7d07ef226fa6ba0">&#9670;&#160;</a></span>highBit()</h2>
  167. <div class="memitem">
  168. <div class="memproto">
  169. <table class="mlabels">
  170. <tr>
  171. <td class="mlabels-left">
  172. <table class="memname">
  173. <tr>
  174. <td class="memname">static const S32 highBit </td>
  175. <td>(</td>
  176. <td class="paramtype">U8&#160;</td>
  177. <td class="paramname"><em>b</em></td><td>)</td>
  178. <td></td>
  179. </tr>
  180. </table>
  181. </td>
  182. <td class="mlabels-right">
  183. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  184. </tr>
  185. </table>
  186. </div><div class="memdoc">
  187. </div>
  188. </div>
  189. <a id="ae9528278c80fb4088b1ed7c6dbf41247" name="ae9528278c80fb4088b1ed7c6dbf41247"></a>
  190. <h2 class="memtitle"><span class="permalink"><a href="#ae9528278c80fb4088b1ed7c6dbf41247">&#9670;&#160;</a></span>numOn()</h2>
  191. <div class="memitem">
  192. <div class="memproto">
  193. <table class="mlabels">
  194. <tr>
  195. <td class="mlabels-left">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname">static const S32 numOn </td>
  199. <td>(</td>
  200. <td class="paramtype">U8&#160;</td>
  201. <td class="paramname"><em>b</em></td><td>)</td>
  202. <td></td>
  203. </tr>
  204. </table>
  205. </td>
  206. <td class="mlabels-right">
  207. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  208. </tr>
  209. </table>
  210. </div><div class="memdoc">
  211. <p>How many bits are on? </p>
  212. </div>
  213. </div>
  214. <a id="ad23aa12c4bfe93788f32d170c9e6217a" name="ad23aa12c4bfe93788f32d170c9e6217a"></a>
  215. <h2 class="memtitle"><span class="permalink"><a href="#ad23aa12c4bfe93788f32d170c9e6217a">&#9670;&#160;</a></span>whichOn()</h2>
  216. <div class="memitem">
  217. <div class="memproto">
  218. <table class="mlabels">
  219. <tr>
  220. <td class="mlabels-left">
  221. <table class="memname">
  222. <tr>
  223. <td class="memname">static const S8 * whichOn </td>
  224. <td>(</td>
  225. <td class="paramtype">U8&#160;</td>
  226. <td class="paramname"><em>b</em></td><td>)</td>
  227. <td></td>
  228. </tr>
  229. </table>
  230. </td>
  231. <td class="mlabels-right">
  232. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  233. </tr>
  234. </table>
  235. </div><div class="memdoc">
  236. <p>Return a pointer to 8 S8's, which are set according to which bits are set in the passed value. </p>
  237. </div>
  238. </div>
  239. <hr/>The documentation for this class was generated from the following files:<ul>
  240. <li>collection/<b>bitTables.h</b></li>
  241. <li>collection/<b>bitTables.cc</b></li>
  242. </ul>
  243. </div><!-- contents -->
  244. <!-- start footer part -->
  245. <hr class="footer"/><address class="footer"><small>
  246. 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
  247. </small></address>
  248. </body>
  249. </html>