Home Explore Help
Sign In
cpp
/
glm
mirror of https://github.com/g-truc/glm.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: 0.9.4
Branches Tags
glm
/
doc
/
api
/
a00008_source.html

a00008_source.html 17 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <title>bit.hpp Source File</title>
    7. 

  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    8. 

  8. <script type="text/javascript" src="jquery.js"></script>
    9. 

  9. <script type="text/javascript" src="dynsections.js"></script>
    10. 

  10. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    11. 

  11. </head>
    12. 

  12. <body>
    13. 

  13. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    14. 

  14. <div id="titlearea">
    15. 

  15. <table cellspacing="0" cellpadding="0">
    16. 

  16.  <tbody>
    17. 

  17.  <tr style="height: 56px;">
    18. 

  18.   <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
    19. 

  19.  </tr>
    20. 

  20.  </tbody>
    21. 

  21. </table>
    22. 

  22. </div>
    23. 

  23. <!-- end header part -->
    24. 

  24. <!-- Generated by Doxygen 1.8.2 -->
    25. 

  25.   <div id="navrow1" class="tabs">
    26. 

  26.     <ul class="tablist">
    27. 

  27.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    28. 

  28.       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
    29. 

  29.       <li><a href="modules.html"><span>Modules</span></a></li>
    30. 

  30.       <li class="current"><a href="files.html"><span>Files</span></a></li>
    31. 

  31.     </ul>
    32. 

  32.   </div>
    33. 

  33.   <div id="navrow2" class="tabs2">
    34. 

  34.     <ul class="tablist">
    35. 

  35.       <li><a href="files.html"><span>File&#160;List</span></a></li>
    36. 

  36.     </ul>
    37. 

  37.   </div>
    38. 

  38. <div id="nav-path" class="navpath">
    39. 

  39.   <ul>
    40. 

  40. <li class="navelem"><a class="el" href="dir_934f46a345653ef2b3014a1b37a162c1.html">G:</a></li><li class="navelem"><a class="el" href="dir_bf513233250988b6ff3b72f8482c1597.html">Repository</a></li><li class="navelem"><a class="el" href="dir_e217bba5d90990da93f61f0ea8b942dc.html">glm</a></li><li class="navelem"><a class="el" href="dir_a844bf6d5a07b8853f8463b41029861e.html">glm</a></li><li class="navelem"><a class="el" href="dir_abb3ddac8d2c26e45fecc003279ba790.html">gtx</a></li>  </ul>
    41. 

  41. </div>
    42. 

  42. </div><!-- top -->
    43. 

  43. <div class="header">
    44. 

  44.   <div class="headertitle">
    45. 

  45. <div class="title">bit.hpp</div>  </div>
    46. 

  46. </div><!--header-->
    47. 

  47. <div class="contents">
    48. 

  48. <a href="a00008.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;</div>
    49. 

  49. <div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;</div>
    50. 

  50. <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;</div>
    51. 

  51. <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;</div>
    52. 

  52. <div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;</div>
    53. 

  53. <div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;</div>
    54. 

  54. <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;</div>
    55. 

  55. <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;</div>
    56. 

  56. <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;</div>
    57. 

  57. <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div>
    58. 

  58. <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;</div>
    59. 

  59. <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div>
    60. 

  60. <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;</div>
    61. 

  61. <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;</div>
    62. 

  62. <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div>
    63. 

  63. <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;</div>
    64. 

  64. <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;</div>
    65. 

  65. <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div>
    66. 

  66. <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;</div>
    67. 

  67. <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;</div>
    68. 

  68. <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div>
    69. 

  69. <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div>
    70. 

  70. <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;</div>
    71. 

  71. <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div>
    72. 

  72. <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div>
    73. 

  73. <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;</div>
    74. 

  74. <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div>
    75. 

  75. <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div>
    76. 

  76. <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div>
    77. 

  77. <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div>
    78. 

  78. <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div>
    79. 

  79. <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;</div>
    80. 

  80. <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div>
    81. 

  81. <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</div>
    82. 

  82. <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;</div>
    83. 

  83. <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div>
    84. 

  84. <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;</div>
    85. 

  85. <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;</div>
    86. 

  86. <div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="preprocessor">#ifndef GLM_GTX_bit</span></div>
    87. 

  87. <div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define GLM_GTX_bit GLM_VERSION</span></div>
    88. 

  88. <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="preprocessor"></span></div>
    89. 

  89. <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment">// Dependency:</span></div>
    90. 

  90. <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="preprocessor">#include &quot;../glm.hpp&quot;</span></div>
    91. 

  91. <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="preprocessor">#include &quot;../gtc/half_float.hpp&quot;</span></div>
    92. 

  92. <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;</div>
    93. 

  93. <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(glm_ext))</span></div>
    94. 

  94. <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#       pragma message(&quot;GLM: GLM_GTX_bit extension included&quot;)</span></div>
    95. 

  95. <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
    96. 

  96. <div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="preprocessor"></span></div>
    97. 

  97. <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="keyword">namespace </span>glm</div>
    98. 

  98. <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;{</div>
    99. 

  99. <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;</div>
    100. 

  100. <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIType&gt;</div>
    101. 

  101. <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;        genIType <a class="code" href="a00161.html#ga0d044f92de0108409d25ebcfea034dcb" title="Build a mask of &#39;count&#39; bits.">mask</a>(genIType <span class="keyword">const</span> &amp; count);</div>
    102. 

  102. <div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;</div>
    103. 

  103. <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIUType, <span class="keyword">typename</span> sizeType&gt;</div>
    104. 

  104. <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;        GLM_DEPRECATED genIUType <a class="code" href="a00161.html#gaff795f058953fb7369dbca274291f2fe" title="Component wise extraction of bit fields.">extractField</a>(</div>
    105. 

  105. <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;                genIUType <span class="keyword">const</span> &amp; v, </div>
    106. 

  106. <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;                sizeType <span class="keyword">const</span> &amp; first, </div>
    107. 

  107. <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;                sizeType <span class="keyword">const</span> &amp; count);</div>
    108. 

  108. <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;</div>
    109. 

  109. <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
    110. 

  110. <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;        GLM_DEPRECATED <span class="keywordtype">int</span> <a class="code" href="a00161.html#ga760038264d7d0c0e87f05849c8c158cc" title="Find the lowest bit set to 1 in a integer variable.">lowestBit</a>(genType <span class="keyword">const</span> &amp; value);</div>
    111. 

  111. <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;</div>
    112. 

  112. <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
    113. 

  113. <div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;        GLM_DEPRECATED <span class="keywordtype">int</span> <a class="code" href="a00161.html#ga01e02cdbfd0f7487fa800942ac911801" title="Find the highest bit set to 1 in a integer variable.">highestBit</a>(genType <span class="keyword">const</span> &amp; value);</div>
    114. 

  114. <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;</div>
    115. 

  115. <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
    116. 

  116. <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;        genType <a class="code" href="a00161.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);</div>
    117. 

  117. <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;</div>
    118. 

  118. <div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
    119. 

  119. <div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;        <span class="keywordtype">bool</span> <a class="code" href="a00161.html#ga3c0b3e843fa21220f08e801bb558470a" title="Return true if the value is a power of two number.">isPowerOfTwo</a>(genType <span class="keyword">const</span> &amp; value);</div>
    120. 

  120. <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;</div>
    121. 

  121. <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
    122. 

  122. <div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;        genType <a class="code" href="a00161.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);</div>
    123. 

  123. <div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;</div>
    124. 

  124. <div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
    125. 

  125. <div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;        genType <a class="code" href="a00161.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);</div>
    126. 

  126. <div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;</div>
    127. 

  127. <div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
    128. 

  128. <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;        genType <a class="code" href="a00161.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);</div>
    129. 

  129. <div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;</div>
    130. 

  130. <div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
    131. 

  131. <div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;        GLM_DEPRECATED genType <a class="code" href="a00161.html#ga655d3e378520be64a7832cdc8ebf20fb" title="Revert all bits of any integer based type.">bitRevert</a>(genType <span class="keyword">const</span> &amp; value);</div>
    132. 

  132. <div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;</div>
    133. 

  133. <div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;</div>
    134. 

  134. <div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;        genType <a class="code" href="a00161.html#gae2ceed046e662a889cd938de3191dd55" title="Rotate all bits to the right.">bitRotateRight</a>(genType <span class="keyword">const</span> &amp; In, std::size_t Shift);</div>
    135. 

  135. <div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;</div>
    136. 

  136. <div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;</div>
    137. 

  137. <div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;        genType <a class="code" href="a00161.html#gad9bc7e42a75381c3f6b68b8ba20863d3" title="Rotate all bits to the left.">bitRotateLeft</a>(genType <span class="keyword">const</span> &amp; In, std::size_t Shift);</div>
    138. 

  138. <div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;</div>
    139. 

  139. <div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIUType&gt;</div>
    140. 

  140. <div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;        genIUType <a class="code" href="a00161.html#gaf937428f9e6e9bb2e9214ff3be96cf95" title="Set to 1 a range of bits.">fillBitfieldWithOne</a>(</div>
    141. 

  141. <div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;                genIUType <span class="keyword">const</span> &amp; Value,</div>
    142. 

  142. <div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;                <span class="keywordtype">int</span> <span class="keyword">const</span> &amp; FromBit, </div>
    143. 

  143. <div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;                <span class="keywordtype">int</span> <span class="keyword">const</span> &amp; ToBit);</div>
    144. 

  144. <div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;</div>
    145. 

  145. <div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIUType&gt;</div>
    146. 

  146. <div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;        genIUType <a class="code" href="a00161.html#gabb9c7b3bd390a61437667e5625834a7c" title="Set to 0 a range of bits.">fillBitfieldWithZero</a>(</div>
    147. 

  147. <div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;                genIUType <span class="keyword">const</span> &amp; Value,</div>
    148. 

  148. <div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;                <span class="keywordtype">int</span> <span class="keyword">const</span> &amp; FromBit, </div>
    149. 

  149. <div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;                <span class="keywordtype">int</span> <span class="keyword">const</span> &amp; ToBit);</div>
    150. 

  150. <div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;</div>
    151. 

  151. <div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;} <span class="comment">//namespace glm</span></div>
    152. 

  152. <div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;</div>
    153. 

  153. <div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;<span class="preprocessor">#include &quot;bit.inl&quot;</span></div>
    154. 

  154. <div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;</div>
    155. 

  155. <div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;<span class="preprocessor">#endif//GLM_GTX_bit</span></div>
    156. 

  156. </div><!-- fragment --></div><!-- contents -->
    157. 

  157. <!-- start footer part -->
    158. 

  158. <hr class="footer"/><address class="footer"><small>
    159. 

  159. Generated by &#160;<a href="http://www.doxygen.org/index.html">
    160. 

  160. <img class="footer" src="doxygen.png" alt="doxygen"/>
    161. 

  161. </a> 1.8.2
    162. 

  162. </small></address>
    163. 

  163. </body>
    164. 

  164. </html>
    165.