a00182.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.10"/>
  7. <title>0.9.8: GLM_GTX_bit</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  20. <td id="projectalign" style="padding-left: 0.5em;">
  21. <div id="projectname">0.9.8
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.10 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="modules.html"><span>Modules</span></a></li>
  34. <li><a href="files.html"><span>Files</span></a></li>
  35. </ul>
  36. </div>
  37. </div><!-- top -->
  38. <div class="header">
  39. <div class="summary">
  40. <a href="#func-members">Functions</a> </div>
  41. <div class="headertitle">
  42. <div class="title">GLM_GTX_bit<div class="ingroups"><a class="el" href="a00155.html">GTX Extensions (Experimental)</a></div></div> </div>
  43. </div><!--header-->
  44. <div class="contents">
  45. <table class="memberdecls">
  46. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  47. Functions</h2></td></tr>
  48. <tr class="memitem:ga0dcc8fe7c3d3ad60dea409281efa3d05"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
  49. <tr class="memitem:ga0dcc8fe7c3d3ad60dea409281efa3d05"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00182.html#ga0dcc8fe7c3d3ad60dea409281efa3d05">highestBitValue</a> (genIUType Value)</td></tr>
  50. <tr class="separator:ga0dcc8fe7c3d3ad60dea409281efa3d05"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51. <tr class="memitem:ga5eea3a4d429040af13d39a7d7cd84d73"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  52. <tr class="memitem:ga5eea3a4d429040af13d39a7d7cd84d73"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00182.html#ga5eea3a4d429040af13d39a7d7cd84d73">highestBitValue</a> (vecType&lt; T, P &gt; const &amp;value)</td></tr>
  53. <tr class="separator:ga5eea3a4d429040af13d39a7d7cd84d73"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54. <tr class="memitem:ga2ff6568089f3a9b67f5c30918855fc6f"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
  55. <tr class="memitem:ga2ff6568089f3a9b67f5c30918855fc6f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00182.html#ga2ff6568089f3a9b67f5c30918855fc6f">lowestBitValue</a> (genIUType Value)</td></tr>
  56. <tr class="separator:ga2ff6568089f3a9b67f5c30918855fc6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem:ga8cda2459871f574a0aecbe702ac93291"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
  58. <tr class="memitem:ga8cda2459871f574a0aecbe702ac93291"><td class="memTemplItemLeft" align="right" valign="top">GLM_DEPRECATED GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00182.html#ga8cda2459871f574a0aecbe702ac93291">powerOfTwoAbove</a> (genIUType Value)</td></tr>
  59. <tr class="separator:ga8cda2459871f574a0aecbe702ac93291"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. <tr class="memitem:gafe08808a50226b75b50e640a08b32ddc"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  61. <tr class="memitem:gafe08808a50226b75b50e640a08b32ddc"><td class="memTemplItemLeft" align="right" valign="top">GLM_DEPRECATED GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00182.html#gafe08808a50226b75b50e640a08b32ddc">powerOfTwoAbove</a> (vecType&lt; T, P &gt; const &amp;value)</td></tr>
  62. <tr class="separator:gafe08808a50226b75b50e640a08b32ddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:ga3de7df63c589325101a2817a56f8e29d"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
  64. <tr class="memitem:ga3de7df63c589325101a2817a56f8e29d"><td class="memTemplItemLeft" align="right" valign="top">GLM_DEPRECATED GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00182.html#ga3de7df63c589325101a2817a56f8e29d">powerOfTwoBelow</a> (genIUType Value)</td></tr>
  65. <tr class="separator:ga3de7df63c589325101a2817a56f8e29d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:gae33bb1ca2b55846b23a0f0796a679195"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  67. <tr class="memitem:gae33bb1ca2b55846b23a0f0796a679195"><td class="memTemplItemLeft" align="right" valign="top">GLM_DEPRECATED GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00182.html#gae33bb1ca2b55846b23a0f0796a679195">powerOfTwoBelow</a> (vecType&lt; T, P &gt; const &amp;value)</td></tr>
  68. <tr class="separator:gae33bb1ca2b55846b23a0f0796a679195"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:ga5f65973a5d2ea38c719e6a663149ead9"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
  70. <tr class="memitem:ga5f65973a5d2ea38c719e6a663149ead9"><td class="memTemplItemLeft" align="right" valign="top">GLM_DEPRECATED GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00182.html#ga5f65973a5d2ea38c719e6a663149ead9">powerOfTwoNearest</a> (genIUType Value)</td></tr>
  71. <tr class="separator:ga5f65973a5d2ea38c719e6a663149ead9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:ga2d7e85995d097518b8d70cd409bda39e"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  73. <tr class="memitem:ga2d7e85995d097518b8d70cd409bda39e"><td class="memTemplItemLeft" align="right" valign="top">GLM_DEPRECATED GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00182.html#ga2d7e85995d097518b8d70cd409bda39e">powerOfTwoNearest</a> (vecType&lt; T, P &gt; const &amp;value)</td></tr>
  74. <tr class="separator:ga2d7e85995d097518b8d70cd409bda39e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. </table>
  76. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  77. <p>Allow to perform bit operations on integer values. </p>
  78. <p>&lt;<a class="el" href="a00008.html" title="GLM_GTX_bit ">glm/gtx/bit.hpp</a>&gt; need to be included to use these functionalities. </p>
  79. <h2 class="groupheader">Function Documentation</h2>
  80. <a class="anchor" id="ga0dcc8fe7c3d3ad60dea409281efa3d05"></a>
  81. <div class="memitem">
  82. <div class="memproto">
  83. <table class="memname">
  84. <tr>
  85. <td class="memname">GLM_FUNC_DECL genIUType glm::highestBitValue </td>
  86. <td>(</td>
  87. <td class="paramtype">genIUType&#160;</td>
  88. <td class="paramname"><em>Value</em></td><td>)</td>
  89. <td></td>
  90. </tr>
  91. </table>
  92. </div><div class="memdoc">
  93. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00182.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
  94. </div>
  95. </div>
  96. <a class="anchor" id="ga5eea3a4d429040af13d39a7d7cd84d73"></a>
  97. <div class="memitem">
  98. <div class="memproto">
  99. <table class="memname">
  100. <tr>
  101. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::highestBitValue </td>
  102. <td>(</td>
  103. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  104. <td class="paramname"><em>value</em></td><td>)</td>
  105. <td></td>
  106. </tr>
  107. </table>
  108. </div><div class="memdoc">
  109. <p>Find the highest bit set to 1 in a integer variable and return its value. </p>
  110. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00182.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
  111. </div>
  112. </div>
  113. <a class="anchor" id="ga2ff6568089f3a9b67f5c30918855fc6f"></a>
  114. <div class="memitem">
  115. <div class="memproto">
  116. <table class="memname">
  117. <tr>
  118. <td class="memname">GLM_FUNC_DECL genIUType glm::lowestBitValue </td>
  119. <td>(</td>
  120. <td class="paramtype">genIUType&#160;</td>
  121. <td class="paramname"><em>Value</em></td><td>)</td>
  122. <td></td>
  123. </tr>
  124. </table>
  125. </div><div class="memdoc">
  126. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00182.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
  127. </div>
  128. </div>
  129. <a class="anchor" id="ga8cda2459871f574a0aecbe702ac93291"></a>
  130. <div class="memitem">
  131. <div class="memproto">
  132. <table class="memname">
  133. <tr>
  134. <td class="memname">GLM_DEPRECATED GLM_FUNC_DECL genIUType glm::powerOfTwoAbove </td>
  135. <td>(</td>
  136. <td class="paramtype">genIUType&#160;</td>
  137. <td class="paramname"><em>Value</em></td><td>)</td>
  138. <td></td>
  139. </tr>
  140. </table>
  141. </div><div class="memdoc">
  142. <p>Return the power of two number which value is just higher the input value. </p>
  143. <p>Deprecated, use ceilPowerOfTwo from GTC_round instead</p>
  144. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00175.html" title="rounding value to specific boundings ">GLM_GTC_round</a> </dd>
  145. <dd>
  146. <a class="el" href="a00182.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
  147. </div>
  148. </div>
  149. <a class="anchor" id="gafe08808a50226b75b50e640a08b32ddc"></a>
  150. <div class="memitem">
  151. <div class="memproto">
  152. <table class="memname">
  153. <tr>
  154. <td class="memname">GLM_DEPRECATED GLM_FUNC_DECL vecType&lt;T, P&gt; glm::powerOfTwoAbove </td>
  155. <td>(</td>
  156. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  157. <td class="paramname"><em>value</em></td><td>)</td>
  158. <td></td>
  159. </tr>
  160. </table>
  161. </div><div class="memdoc">
  162. <p>Return the power of two number which value is just higher the input value. </p>
  163. <p>Deprecated, use ceilPowerOfTwo from GTC_round instead</p>
  164. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00175.html" title="rounding value to specific boundings ">GLM_GTC_round</a> </dd>
  165. <dd>
  166. <a class="el" href="a00182.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
  167. </div>
  168. </div>
  169. <a class="anchor" id="ga3de7df63c589325101a2817a56f8e29d"></a>
  170. <div class="memitem">
  171. <div class="memproto">
  172. <table class="memname">
  173. <tr>
  174. <td class="memname">GLM_DEPRECATED GLM_FUNC_DECL genIUType glm::powerOfTwoBelow </td>
  175. <td>(</td>
  176. <td class="paramtype">genIUType&#160;</td>
  177. <td class="paramname"><em>Value</em></td><td>)</td>
  178. <td></td>
  179. </tr>
  180. </table>
  181. </div><div class="memdoc">
  182. <p>Return the power of two number which value is just lower the input value. </p>
  183. <p>Deprecated, use floorPowerOfTwo from GTC_round instead</p>
  184. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00175.html" title="rounding value to specific boundings ">GLM_GTC_round</a> </dd>
  185. <dd>
  186. <a class="el" href="a00182.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
  187. </div>
  188. </div>
  189. <a class="anchor" id="gae33bb1ca2b55846b23a0f0796a679195"></a>
  190. <div class="memitem">
  191. <div class="memproto">
  192. <table class="memname">
  193. <tr>
  194. <td class="memname">GLM_DEPRECATED GLM_FUNC_DECL vecType&lt;T, P&gt; glm::powerOfTwoBelow </td>
  195. <td>(</td>
  196. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  197. <td class="paramname"><em>value</em></td><td>)</td>
  198. <td></td>
  199. </tr>
  200. </table>
  201. </div><div class="memdoc">
  202. <p>Return the power of two number which value is just lower the input value. </p>
  203. <p>Deprecated, use floorPowerOfTwo from GTC_round instead</p>
  204. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00175.html" title="rounding value to specific boundings ">GLM_GTC_round</a> </dd>
  205. <dd>
  206. <a class="el" href="a00182.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
  207. </div>
  208. </div>
  209. <a class="anchor" id="ga5f65973a5d2ea38c719e6a663149ead9"></a>
  210. <div class="memitem">
  211. <div class="memproto">
  212. <table class="memname">
  213. <tr>
  214. <td class="memname">GLM_DEPRECATED GLM_FUNC_DECL genIUType glm::powerOfTwoNearest </td>
  215. <td>(</td>
  216. <td class="paramtype">genIUType&#160;</td>
  217. <td class="paramname"><em>Value</em></td><td>)</td>
  218. <td></td>
  219. </tr>
  220. </table>
  221. </div><div class="memdoc">
  222. <p>Return the power of two number which value is the closet to the input value. </p>
  223. <p>Deprecated, use roundPowerOfTwo from GTC_round instead</p>
  224. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00175.html" title="rounding value to specific boundings ">GLM_GTC_round</a> </dd>
  225. <dd>
  226. <a class="el" href="a00182.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
  227. </div>
  228. </div>
  229. <a class="anchor" id="ga2d7e85995d097518b8d70cd409bda39e"></a>
  230. <div class="memitem">
  231. <div class="memproto">
  232. <table class="memname">
  233. <tr>
  234. <td class="memname">GLM_DEPRECATED GLM_FUNC_DECL vecType&lt;T, P&gt; glm::powerOfTwoNearest </td>
  235. <td>(</td>
  236. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  237. <td class="paramname"><em>value</em></td><td>)</td>
  238. <td></td>
  239. </tr>
  240. </table>
  241. </div><div class="memdoc">
  242. <p>Return the power of two number which value is the closet to the input value. </p>
  243. <p>Deprecated, use roundPowerOfTwo from GTC_round instead</p>
  244. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00175.html" title="rounding value to specific boundings ">GLM_GTC_round</a> </dd>
  245. <dd>
  246. <a class="el" href="a00182.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
  247. </div>
  248. </div>
  249. </div><!-- contents -->
  250. <!-- start footer part -->
  251. <hr class="footer"/><address class="footer"><small>
  252. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  253. <img class="footer" src="doxygen.png" alt="doxygen"/>
  254. </a> 1.8.10
  255. </small></address>
  256. </body>
  257. </html>