a00184.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321
  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.9 API documenation: 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="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">0.9.9 API documenation
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.10 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="modules.html"><span>Modules</span></a></li>
  42. <li><a href="files.html"><span>Files</span></a></li>
  43. <li>
  44. <div id="MSearchBox" class="MSearchBoxInactive">
  45. <span class="left">
  46. <img id="MSearchSelect" src="search/mag_sel.png"
  47. onmouseover="return searchBox.OnSearchSelectShow()"
  48. onmouseout="return searchBox.OnSearchSelectHide()"
  49. alt=""/>
  50. <input type="text" id="MSearchField" value="Search" accesskey="S"
  51. onfocus="searchBox.OnSearchFieldFocus(true)"
  52. onblur="searchBox.OnSearchFieldFocus(false)"
  53. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  54. </span><span class="right">
  55. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  56. </span>
  57. </div>
  58. </li>
  59. </ul>
  60. </div>
  61. </div><!-- top -->
  62. <!-- window showing the filter options -->
  63. <div id="MSearchSelectWindow"
  64. onmouseover="return searchBox.OnSearchSelectShow()"
  65. onmouseout="return searchBox.OnSearchSelectHide()"
  66. onkeydown="return searchBox.OnSearchSelectKey(event)">
  67. </div>
  68. <!-- iframe showing the search results (closed by default) -->
  69. <div id="MSearchResultsWindow">
  70. <iframe src="javascript:void(0)" frameborder="0"
  71. name="MSearchResults" id="MSearchResults">
  72. </iframe>
  73. </div>
  74. <div class="header">
  75. <div class="summary">
  76. <a href="#func-members">Functions</a> </div>
  77. <div class="headertitle">
  78. <div class="title">GLM_GTX_bit<div class="ingroups"><a class="el" href="a00157.html">GTX Extensions (Experimental)</a></div></div> </div>
  79. </div><!--header-->
  80. <div class="contents">
  81. <p>Allow to perform bit operations on integer values.
  82. <a href="#details">More...</a></p>
  83. <table class="memberdecls">
  84. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  85. Functions</h2></td></tr>
  86. <tr class="memitem:ga0dcc8fe7c3d3ad60dea409281efa3d05"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
  87. <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="a00184.html#ga0dcc8fe7c3d3ad60dea409281efa3d05">highestBitValue</a> (genIUType Value)</td></tr>
  88. <tr class="separator:ga0dcc8fe7c3d3ad60dea409281efa3d05"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:ga7b559ec55e7ec4103c63d877df4594b5"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier P&gt; </td></tr>
  90. <tr class="memitem:ga7b559ec55e7ec4103c63d877df4594b5"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00184.html#ga7b559ec55e7ec4103c63d877df4594b5">highestBitValue</a> (vec&lt; L, T, P &gt; const &amp;value)</td></tr>
  91. <tr class="memdesc:ga7b559ec55e7ec4103c63d877df4594b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the highest bit set to 1 in a integer variable and return its value. <a href="a00184.html#ga7b559ec55e7ec4103c63d877df4594b5">More...</a><br /></td></tr>
  92. <tr class="separator:ga7b559ec55e7ec4103c63d877df4594b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:ga2ff6568089f3a9b67f5c30918855fc6f"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
  94. <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="a00184.html#ga2ff6568089f3a9b67f5c30918855fc6f">lowestBitValue</a> (genIUType Value)</td></tr>
  95. <tr class="separator:ga2ff6568089f3a9b67f5c30918855fc6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:ga8cda2459871f574a0aecbe702ac93291"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
  97. <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="a00184.html#ga8cda2459871f574a0aecbe702ac93291">powerOfTwoAbove</a> (genIUType Value)</td></tr>
  98. <tr class="memdesc:ga8cda2459871f574a0aecbe702ac93291"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the power of two number which value is just higher the input value. <a href="a00184.html#ga8cda2459871f574a0aecbe702ac93291">More...</a><br /></td></tr>
  99. <tr class="separator:ga8cda2459871f574a0aecbe702ac93291"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:ga75b5b40b975d346033e26b11b0b77300"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier P&gt; </td></tr>
  101. <tr class="memitem:ga75b5b40b975d346033e26b11b0b77300"><td class="memTemplItemLeft" align="right" valign="top">GLM_DEPRECATED GLM_FUNC_DECL vec&lt; L, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00184.html#ga75b5b40b975d346033e26b11b0b77300">powerOfTwoAbove</a> (vec&lt; L, T, P &gt; const &amp;value)</td></tr>
  102. <tr class="memdesc:ga75b5b40b975d346033e26b11b0b77300"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the power of two number which value is just higher the input value. <a href="a00184.html#ga75b5b40b975d346033e26b11b0b77300">More...</a><br /></td></tr>
  103. <tr class="separator:ga75b5b40b975d346033e26b11b0b77300"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:ga3de7df63c589325101a2817a56f8e29d"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
  105. <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="a00184.html#ga3de7df63c589325101a2817a56f8e29d">powerOfTwoBelow</a> (genIUType Value)</td></tr>
  106. <tr class="memdesc:ga3de7df63c589325101a2817a56f8e29d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the power of two number which value is just lower the input value. <a href="a00184.html#ga3de7df63c589325101a2817a56f8e29d">More...</a><br /></td></tr>
  107. <tr class="separator:ga3de7df63c589325101a2817a56f8e29d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:ga736d1ab1b4ad53a8e5f67692949ce164"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier P&gt; </td></tr>
  109. <tr class="memitem:ga736d1ab1b4ad53a8e5f67692949ce164"><td class="memTemplItemLeft" align="right" valign="top">GLM_DEPRECATED GLM_FUNC_DECL vec&lt; L, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00184.html#ga736d1ab1b4ad53a8e5f67692949ce164">powerOfTwoBelow</a> (vec&lt; L, T, P &gt; const &amp;value)</td></tr>
  110. <tr class="memdesc:ga736d1ab1b4ad53a8e5f67692949ce164"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the power of two number which value is just lower the input value. <a href="a00184.html#ga736d1ab1b4ad53a8e5f67692949ce164">More...</a><br /></td></tr>
  111. <tr class="separator:ga736d1ab1b4ad53a8e5f67692949ce164"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:ga5f65973a5d2ea38c719e6a663149ead9"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
  113. <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="a00184.html#ga5f65973a5d2ea38c719e6a663149ead9">powerOfTwoNearest</a> (genIUType Value)</td></tr>
  114. <tr class="memdesc:ga5f65973a5d2ea38c719e6a663149ead9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the power of two number which value is the closet to the input value. <a href="a00184.html#ga5f65973a5d2ea38c719e6a663149ead9">More...</a><br /></td></tr>
  115. <tr class="separator:ga5f65973a5d2ea38c719e6a663149ead9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:ga68d3ae1b89171e649b827c7d74dcde57"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier P&gt; </td></tr>
  117. <tr class="memitem:ga68d3ae1b89171e649b827c7d74dcde57"><td class="memTemplItemLeft" align="right" valign="top">GLM_DEPRECATED GLM_FUNC_DECL vec&lt; L, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00184.html#ga68d3ae1b89171e649b827c7d74dcde57">powerOfTwoNearest</a> (vec&lt; L, T, P &gt; const &amp;value)</td></tr>
  118. <tr class="memdesc:ga68d3ae1b89171e649b827c7d74dcde57"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the power of two number which value is the closet to the input value. <a href="a00184.html#ga68d3ae1b89171e649b827c7d74dcde57">More...</a><br /></td></tr>
  119. <tr class="separator:ga68d3ae1b89171e649b827c7d74dcde57"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. </table>
  121. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  122. <p>Allow to perform bit operations on integer values. </p>
  123. <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>
  124. <h2 class="groupheader">Function Documentation</h2>
  125. <a class="anchor" id="ga0dcc8fe7c3d3ad60dea409281efa3d05"></a>
  126. <div class="memitem">
  127. <div class="memproto">
  128. <table class="memname">
  129. <tr>
  130. <td class="memname">GLM_FUNC_DECL genIUType glm::highestBitValue </td>
  131. <td>(</td>
  132. <td class="paramtype">genIUType&#160;</td>
  133. <td class="paramname"><em>Value</em></td><td>)</td>
  134. <td></td>
  135. </tr>
  136. </table>
  137. </div><div class="memdoc">
  138. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00184.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
  139. </div>
  140. </div>
  141. <a class="anchor" id="ga7b559ec55e7ec4103c63d877df4594b5"></a>
  142. <div class="memitem">
  143. <div class="memproto">
  144. <table class="memname">
  145. <tr>
  146. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, P&gt; glm::highestBitValue </td>
  147. <td>(</td>
  148. <td class="paramtype">vec&lt; L, T, P &gt; const &amp;&#160;</td>
  149. <td class="paramname"><em>value</em></td><td>)</td>
  150. <td></td>
  151. </tr>
  152. </table>
  153. </div><div class="memdoc">
  154. <p>Find the highest bit set to 1 in a integer variable and return its value. </p>
  155. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00184.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
  156. </div>
  157. </div>
  158. <a class="anchor" id="ga2ff6568089f3a9b67f5c30918855fc6f"></a>
  159. <div class="memitem">
  160. <div class="memproto">
  161. <table class="memname">
  162. <tr>
  163. <td class="memname">GLM_FUNC_DECL genIUType glm::lowestBitValue </td>
  164. <td>(</td>
  165. <td class="paramtype">genIUType&#160;</td>
  166. <td class="paramname"><em>Value</em></td><td>)</td>
  167. <td></td>
  168. </tr>
  169. </table>
  170. </div><div class="memdoc">
  171. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00184.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
  172. </div>
  173. </div>
  174. <a class="anchor" id="ga8cda2459871f574a0aecbe702ac93291"></a>
  175. <div class="memitem">
  176. <div class="memproto">
  177. <table class="memname">
  178. <tr>
  179. <td class="memname">GLM_DEPRECATED GLM_FUNC_DECL genIUType glm::powerOfTwoAbove </td>
  180. <td>(</td>
  181. <td class="paramtype">genIUType&#160;</td>
  182. <td class="paramname"><em>Value</em></td><td>)</td>
  183. <td></td>
  184. </tr>
  185. </table>
  186. </div><div class="memdoc">
  187. <p>Return the power of two number which value is just higher the input value. </p>
  188. <p>Deprecated, use ceilPowerOfTwo from GTC_round instead</p>
  189. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00177.html" title="rounding value to specific boundings ">GLM_GTC_round</a> </dd>
  190. <dd>
  191. <a class="el" href="a00184.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
  192. </div>
  193. </div>
  194. <a class="anchor" id="ga75b5b40b975d346033e26b11b0b77300"></a>
  195. <div class="memitem">
  196. <div class="memproto">
  197. <table class="memname">
  198. <tr>
  199. <td class="memname">GLM_DEPRECATED GLM_FUNC_DECL vec&lt;L, T, P&gt; glm::powerOfTwoAbove </td>
  200. <td>(</td>
  201. <td class="paramtype">vec&lt; L, T, P &gt; const &amp;&#160;</td>
  202. <td class="paramname"><em>value</em></td><td>)</td>
  203. <td></td>
  204. </tr>
  205. </table>
  206. </div><div class="memdoc">
  207. <p>Return the power of two number which value is just higher the input value. </p>
  208. <p>Deprecated, use ceilPowerOfTwo from GTC_round instead</p>
  209. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00177.html" title="rounding value to specific boundings ">GLM_GTC_round</a> </dd>
  210. <dd>
  211. <a class="el" href="a00184.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
  212. </div>
  213. </div>
  214. <a class="anchor" id="ga3de7df63c589325101a2817a56f8e29d"></a>
  215. <div class="memitem">
  216. <div class="memproto">
  217. <table class="memname">
  218. <tr>
  219. <td class="memname">GLM_DEPRECATED GLM_FUNC_DECL genIUType glm::powerOfTwoBelow </td>
  220. <td>(</td>
  221. <td class="paramtype">genIUType&#160;</td>
  222. <td class="paramname"><em>Value</em></td><td>)</td>
  223. <td></td>
  224. </tr>
  225. </table>
  226. </div><div class="memdoc">
  227. <p>Return the power of two number which value is just lower the input value. </p>
  228. <p>Deprecated, use floorPowerOfTwo from GTC_round instead</p>
  229. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00177.html" title="rounding value to specific boundings ">GLM_GTC_round</a> </dd>
  230. <dd>
  231. <a class="el" href="a00184.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
  232. </div>
  233. </div>
  234. <a class="anchor" id="ga736d1ab1b4ad53a8e5f67692949ce164"></a>
  235. <div class="memitem">
  236. <div class="memproto">
  237. <table class="memname">
  238. <tr>
  239. <td class="memname">GLM_DEPRECATED GLM_FUNC_DECL vec&lt;L, T, P&gt; glm::powerOfTwoBelow </td>
  240. <td>(</td>
  241. <td class="paramtype">vec&lt; L, T, P &gt; const &amp;&#160;</td>
  242. <td class="paramname"><em>value</em></td><td>)</td>
  243. <td></td>
  244. </tr>
  245. </table>
  246. </div><div class="memdoc">
  247. <p>Return the power of two number which value is just lower the input value. </p>
  248. <p>Deprecated, use floorPowerOfTwo from GTC_round instead</p>
  249. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00177.html" title="rounding value to specific boundings ">GLM_GTC_round</a> </dd>
  250. <dd>
  251. <a class="el" href="a00184.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
  252. </div>
  253. </div>
  254. <a class="anchor" id="ga5f65973a5d2ea38c719e6a663149ead9"></a>
  255. <div class="memitem">
  256. <div class="memproto">
  257. <table class="memname">
  258. <tr>
  259. <td class="memname">GLM_DEPRECATED GLM_FUNC_DECL genIUType glm::powerOfTwoNearest </td>
  260. <td>(</td>
  261. <td class="paramtype">genIUType&#160;</td>
  262. <td class="paramname"><em>Value</em></td><td>)</td>
  263. <td></td>
  264. </tr>
  265. </table>
  266. </div><div class="memdoc">
  267. <p>Return the power of two number which value is the closet to the input value. </p>
  268. <p>Deprecated, use roundPowerOfTwo from GTC_round instead</p>
  269. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00177.html" title="rounding value to specific boundings ">GLM_GTC_round</a> </dd>
  270. <dd>
  271. <a class="el" href="a00184.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
  272. </div>
  273. </div>
  274. <a class="anchor" id="ga68d3ae1b89171e649b827c7d74dcde57"></a>
  275. <div class="memitem">
  276. <div class="memproto">
  277. <table class="memname">
  278. <tr>
  279. <td class="memname">GLM_DEPRECATED GLM_FUNC_DECL vec&lt;L, T, P&gt; glm::powerOfTwoNearest </td>
  280. <td>(</td>
  281. <td class="paramtype">vec&lt; L, T, P &gt; const &amp;&#160;</td>
  282. <td class="paramname"><em>value</em></td><td>)</td>
  283. <td></td>
  284. </tr>
  285. </table>
  286. </div><div class="memdoc">
  287. <p>Return the power of two number which value is the closet to the input value. </p>
  288. <p>Deprecated, use roundPowerOfTwo from GTC_round instead</p>
  289. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00177.html" title="rounding value to specific boundings ">GLM_GTC_round</a> </dd>
  290. <dd>
  291. <a class="el" href="a00184.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
  292. </div>
  293. </div>
  294. </div><!-- contents -->
  295. <!-- start footer part -->
  296. <hr class="footer"/><address class="footer"><small>
  297. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  298. <img class="footer" src="doxygen.png" alt="doxygen"/>
  299. </a> 1.8.10
  300. </small></address>
  301. </body>
  302. </html>