a00025_source.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  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. <title>bit.hpp Source File</title>
  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  7. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  8. </head>
  9. <body>
  10. <div id="top"><!-- do not remove this div! -->
  11. <div id="titlearea">
  12. <table cellspacing="0" cellpadding="0">
  13. <tbody>
  14. <tr style="height: 56px;">
  15. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  16. </tr>
  17. </tbody>
  18. </table>
  19. </div>
  20. <!-- Generated by Doxygen 1.7.5 -->
  21. <div id="navrow1" class="tabs">
  22. <ul class="tablist">
  23. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  24. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  25. <li><a href="modules.html"><span>Modules</span></a></li>
  26. <li><a href="annotated.html"><span>Classes</span></a></li>
  27. <li class="current"><a href="files.html"><span>Files</span></a></li>
  28. </ul>
  29. </div>
  30. <div id="navrow2" class="tabs2">
  31. <ul class="tablist">
  32. <li><a href="files.html"><span>File&#160;List</span></a></li>
  33. </ul>
  34. </div>
  35. <div class="header">
  36. <div class="headertitle">
  37. <div class="title">bit.hpp</div> </div>
  38. </div>
  39. <div class="contents">
  40. <a href="a00025.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
  41. <a name="l00002"></a>00002
  42. <a name="l00003"></a>00003
  43. <a name="l00004"></a>00004
  44. <a name="l00005"></a>00005
  45. <a name="l00006"></a>00006
  46. <a name="l00007"></a>00007
  47. <a name="l00008"></a>00008
  48. <a name="l00009"></a>00009
  49. <a name="l00010"></a>00010
  50. <a name="l00011"></a>00011
  51. <a name="l00012"></a>00012
  52. <a name="l00013"></a>00013
  53. <a name="l00014"></a>00014
  54. <a name="l00015"></a>00015
  55. <a name="l00016"></a>00016
  56. <a name="l00017"></a>00017
  57. <a name="l00018"></a>00018
  58. <a name="l00019"></a>00019
  59. <a name="l00020"></a>00020
  60. <a name="l00021"></a>00021
  61. <a name="l00022"></a>00022
  62. <a name="l00023"></a>00023
  63. <a name="l00024"></a>00024
  64. <a name="l00025"></a>00025
  65. <a name="l00026"></a>00026
  66. <a name="l00027"></a>00027
  67. <a name="l00028"></a>00028
  68. <a name="l00029"></a>00029
  69. <a name="l00030"></a>00030
  70. <a name="l00031"></a>00031
  71. <a name="l00032"></a>00032
  72. <a name="l00033"></a>00033
  73. <a name="l00034"></a>00034
  74. <a name="l00035"></a>00035
  75. <a name="l00036"></a>00036
  76. <a name="l00037"></a>00037
  77. <a name="l00038"></a>00038
  78. <a name="l00039"></a>00039 <span class="preprocessor">#ifndef GLM_GTX_bit</span>
  79. <a name="l00040"></a>00040 <span class="preprocessor"></span><span class="preprocessor">#define GLM_GTX_bit GLM_VERSION</span>
  80. <a name="l00041"></a>00041 <span class="preprocessor"></span>
  81. <a name="l00042"></a>00042 <span class="comment">// Dependency:</span>
  82. <a name="l00043"></a>00043 <span class="preprocessor">#include &quot;../glm.hpp&quot;</span>
  83. <a name="l00044"></a>00044 <span class="preprocessor">#include &quot;../gtc/half_float.hpp&quot;</span>
  84. <a name="l00045"></a>00045
  85. <a name="l00046"></a>00046 <span class="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(glm_ext))</span>
  86. <a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_bit extension included&quot;)</span>
  87. <a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
  88. <a name="l00049"></a>00049 <span class="preprocessor"></span>
  89. <a name="l00050"></a>00050 <span class="keyword">namespace </span>glm
  90. <a name="l00051"></a>00051 {
  91. <a name="l00054"></a>00054
  92. <a name="l00057"></a>00057 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIType&gt;
  93. <a name="l00058"></a>00058 genIType <a class="code" href="a00170.html#ga0d044f92de0108409d25ebcfea034dcb" title="Build a mask of &#39;count&#39; bits.">mask</a>(genIType <span class="keyword">const</span> &amp; count);
  94. <a name="l00059"></a>00059
  95. <a name="l00063"></a>00063 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIUType, <span class="keyword">typename</span> sizeType&gt;
  96. <a name="l00064"></a>00064 genIUType <a class="code" href="a00170.html#ga929b849daa656caecf8bd0febcd71f7a" title="Component wise extraction of bit fields.">extractField</a>(
  97. <a name="l00065"></a>00065 genIUType <span class="keyword">const</span> &amp; v,
  98. <a name="l00066"></a>00066 sizeType <span class="keyword">const</span> &amp; first,
  99. <a name="l00067"></a>00067 sizeType <span class="keyword">const</span> &amp; count);
  100. <a name="l00068"></a>00068
  101. <a name="l00071"></a>00071 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;
  102. <a name="l00072"></a>00072 <span class="keywordtype">int</span> <a class="code" href="a00170.html#ga94e553e5aabf9b202b5915719966d323" title="Find the lowest bit set to 1 in a integer variable.">lowestBit</a>(genType <span class="keyword">const</span> &amp; value);
  103. <a name="l00073"></a>00073
  104. <a name="l00076"></a>00076 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;
  105. <a name="l00077"></a>00077 <span class="keywordtype">int</span> <a class="code" href="a00170.html#gaa3679c623c2ff5dfb745f9ce4316b23c" title="Find the highest bit set to 1 in a integer variable.">highestBit</a>(genType <span class="keyword">const</span> &amp; value);
  106. <a name="l00078"></a>00078
  107. <a name="l00081"></a>00081 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;
  108. <a name="l00082"></a>00082 genType <a class="code" href="a00170.html#ga485d3ead7f6c624b00cc800c68ab8e08" title="Find the highest bit set to 1 in a integer variable and return its value.">highestBitValue</a>(genType <span class="keyword">const</span> &amp; value);
  109. <a name="l00083"></a>00083
  110. <a name="l00086"></a>00086 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;
  111. <a name="l00087"></a>00087 <span class="keywordtype">bool</span> <a class="code" href="a00170.html#ga3c0b3e843fa21220f08e801bb558470a" title="Return true if the value is a power of two number.">isPowerOfTwo</a>(genType <span class="keyword">const</span> &amp; value);
  112. <a name="l00088"></a>00088
  113. <a name="l00091"></a>00091 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;
  114. <a name="l00092"></a>00092 genType <a class="code" href="a00170.html#ga335322b4fcb2e5444ec467a1e7a40301" title="Return the power of two number which value is just higher the input value.">powerOfTwoAbove</a>(genType <span class="keyword">const</span> &amp; value);
  115. <a name="l00093"></a>00093
  116. <a name="l00096"></a>00096 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;
  117. <a name="l00097"></a>00097 genType <a class="code" href="a00170.html#ga4c3ea31127e64ec283fb6cf715b4d9ac" title="Return the power of two number which value is just lower the input value.">powerOfTwoBelow</a>(genType <span class="keyword">const</span> &amp; value);
  118. <a name="l00098"></a>00098
  119. <a name="l00101"></a>00101 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;
  120. <a name="l00102"></a>00102 genType <a class="code" href="a00170.html#ga00cb2e4b82215e4d531ec046c19e2ce7" title="Return the power of two number which value is the closet to the input value.">powerOfTwoNearest</a>(genType <span class="keyword">const</span> &amp; value);
  121. <a name="l00103"></a>00103
  122. <a name="l00106"></a>00106 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;
  123. <a name="l00107"></a>00107 genType <a class="code" href="a00170.html#ga7aadf1d73b4236e9cf9b2f23c13af604" title="Revert all bits of any integer based type.">bitRevert</a>(genType <span class="keyword">const</span> &amp; value);
  124. <a name="l00108"></a>00108
  125. <a name="l00111"></a>00111 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;
  126. <a name="l00112"></a>00112 genType <a class="code" href="a00170.html#gae2ceed046e662a889cd938de3191dd55" title="Rotate all bits to the right.">bitRotateRight</a>(genType <span class="keyword">const</span> &amp; In, std::size_t Shift);
  127. <a name="l00113"></a>00113
  128. <a name="l00116"></a>00116 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;
  129. <a name="l00117"></a>00117 genType <a class="code" href="a00170.html#gad9bc7e42a75381c3f6b68b8ba20863d3" title="Rotate all bits to the left.">bitRotateLeft</a>(genType <span class="keyword">const</span> &amp; In, std::size_t Shift);
  130. <a name="l00118"></a>00118
  131. <a name="l00121"></a>00121 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIUType&gt;
  132. <a name="l00122"></a>00122 genIUType <a class="code" href="a00170.html#gaf937428f9e6e9bb2e9214ff3be96cf95" title="Set to 1 a range of bits.">fillBitfieldWithOne</a>(
  133. <a name="l00123"></a>00123 genIUType <span class="keyword">const</span> &amp; Value,
  134. <a name="l00124"></a>00124 <span class="keywordtype">int</span> <span class="keyword">const</span> &amp; FromBit,
  135. <a name="l00125"></a>00125 <span class="keywordtype">int</span> <span class="keyword">const</span> &amp; ToBit);
  136. <a name="l00126"></a>00126
  137. <a name="l00129"></a>00129 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIUType&gt;
  138. <a name="l00130"></a>00130 genIUType <a class="code" href="a00170.html#gabb9c7b3bd390a61437667e5625834a7c" title="Set to 0 a range of bits.">fillBitfieldWithZero</a>(
  139. <a name="l00131"></a>00131 genIUType <span class="keyword">const</span> &amp; Value,
  140. <a name="l00132"></a>00132 <span class="keywordtype">int</span> <span class="keyword">const</span> &amp; FromBit,
  141. <a name="l00133"></a>00133 <span class="keywordtype">int</span> <span class="keyword">const</span> &amp; ToBit);
  142. <a name="l00134"></a>00134
  143. <a name="l00136"></a>00136 } <span class="comment">//namespace glm</span>
  144. <a name="l00137"></a>00137
  145. <a name="l00138"></a>00138 <span class="preprocessor">#include &quot;bit.inl&quot;</span>
  146. <a name="l00139"></a>00139
  147. <a name="l00140"></a>00140 <span class="preprocessor">#endif//GLM_GTX_bit</span>
  148. </pre></div></div>
  149. </div>
  150. <hr class="footer"/><address class="footer"><small>
  151. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  152. <img class="footer" src="doxygen.png" alt="doxygen"/>
  153. </a> 1.7.5
  154. </small></address>
  155. </body>
  156. </html>