mewin/glm
1
0
Fork 0
Code Releases Activity

Updated doxygen documentation

Browse Source
This commit is contained in:
Christophe Riccio
2011-12-07 14:50:15 +00:00
parent a3b5034d4e
commit f18ad6bf2e
389 changed files with 27429 additions and 14460 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
doc/api-0.9.3/a00025_source.html
View File

@@ -2,22 +2,36 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>bit.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"></td>
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
@@ -34,7 +48,7 @@
</div>
<div class="header">
<div class="headertitle">
<h1>bit.hpp</h1> </div>
<div class="title">bit.hpp</div> </div>
</div>
<div class="contents">
<a href="a00025.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
@@ -79,8 +93,8 @@
<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="preprocessor">#define GLM_GTX_bit GLM_VERSION</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span>
<a name="l00042"></a>00042 <span class="comment">// Dependency:</span>
<a name="l00043"></a>00043 <span class="preprocessor">#include &quot;<a class="code" href="a00050.html" title="OpenGL Mathematics (glm.g-truc.net)">../glm.hpp</a>&quot;</span>
<a name="l00044"></a>00044 <span class="preprocessor">#include &quot;<a class="code" href="a00052.html" title="OpenGL Mathematics (glm.g-truc.net)">../gtc/half_float.hpp</a>&quot;</span>
<a name="l00043"></a>00043 <span class="preprocessor">#include &quot;../glm.hpp&quot;</span>
<a name="l00044"></a>00044 <span class="preprocessor">#include &quot;../gtc/half_float.hpp&quot;</span>
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <span class="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(glm_ext))</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_bit extension included&quot;)</span>
@@ -90,52 +104,52 @@
<a name="l00051"></a>00051 {
<a name="l00054"></a>00054
<a name="l00057"></a>00057 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIType&gt;
<a name="l00058"></a>00058 genIType <a class="code" href="a00170.html#ga02e7aad9f8900fe483177b84d03037a1" title="Build a mask of &amp;#39;count&amp;#39; bits From GLM_GTX_bit extension.">mask</a>(genIType <span class="keyword">const</span> &amp; count);
<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);
<a name="l00059"></a>00059
<a name="l00063"></a>00063 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIUType, <span class="keyword">typename</span> sizeType&gt;
<a name="l00064"></a>00064 genIUType <a class="code" href="a00170.html#ga2ced7c6243ed5d1e28063ba90d9de008" title="Component wise extraction of bit fields.">extractField</a>(
<a name="l00064"></a>00064 genIUType <a class="code" href="a00170.html#ga929b849daa656caecf8bd0febcd71f7a" title="Component wise extraction of bit fields.">extractField</a>(
<a name="l00065"></a>00065 genIUType <span class="keyword">const</span> &amp; v,
<a name="l00066"></a>00066 sizeType <span class="keyword">const</span> &amp; first,
<a name="l00067"></a>00067 sizeType <span class="keyword">const</span> &amp; count);
<a name="l00068"></a>00068
<a name="l00071"></a>00071 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;
<a name="l00072"></a>00072 <span class="keywordtype">int</span> <a class="code" href="a00170.html#ga93c2f76f0b437371de1dcb0923a4918d" title="Find the lowest bit set to 1 in a integer variable.">lowestBit</a>(genType <span class="keyword">const</span> &amp; value);
<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);
<a name="l00073"></a>00073
<a name="l00076"></a>00076 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;
<a name="l00077"></a>00077 <span class="keywordtype">int</span> <a class="code" href="a00170.html#gaf6631fa5cb5cac607706ec020e2cc718" title="Find the highest bit set to 1 in a integer variable.">highestBit</a>(genType <span class="keyword">const</span> &amp; value);
<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);
<a name="l00078"></a>00078
<a name="l00081"></a>00081 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;
<a name="l00082"></a>00082 genType <a class="code" href="a00170.html#ga63ffd8b9d5a1e3fe3213059196c8369b" 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);
<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);
<a name="l00083"></a>00083
<a name="l00086"></a>00086 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;
<a name="l00087"></a>00087 <span class="keywordtype">bool</span> <a class="code" href="a00170.html#ga46b94af83e87d1e7e9de92ef2465fe4e" title="Return true if the value is a power of two number.">isPowerOfTwo</a>(genType <span class="keyword">const</span> &amp; value);
<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);
<a name="l00088"></a>00088
<a name="l00091"></a>00091 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;
<a name="l00092"></a>00092 genType <a class="code" href="a00170.html#gad618ae43f546aadc27c80c138c155772" 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);
<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);
<a name="l00093"></a>00093
<a name="l00096"></a>00096 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;
<a name="l00097"></a>00097 genType <a class="code" href="a00170.html#gae5e33169af7437396eef62776fdccc7a" 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);
<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);
<a name="l00098"></a>00098
<a name="l00101"></a>00101 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;
<a name="l00102"></a>00102 genType <a class="code" href="a00170.html#gad0944ea5228ef8b5c1e449e5a5f876d1" 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);
<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);
<a name="l00103"></a>00103
<a name="l00106"></a>00106 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;
<a name="l00107"></a>00107 genType <a class="code" href="a00170.html#ga1c1f542c65b528ece3ef686fb5d81ba1" title="Revert all bits of any integer based type.">bitRevert</a>(genType <span class="keyword">const</span> &amp; value);
<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);
<a name="l00108"></a>00108
<a name="l00111"></a>00111 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;
<a name="l00112"></a>00112 genType <a class="code" href="a00170.html#ga9bdf75ccffa293713db6f4d711129077" title="Rotate all bits to the right.">bitRotateRight</a>(genType <span class="keyword">const</span> &amp; In, std::size_t Shift);
<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);
<a name="l00113"></a>00113
<a name="l00116"></a>00116 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;
<a name="l00117"></a>00117 genType <a class="code" href="a00170.html#ga05eb060b6dd7c97fafd161b00e9b38f1" title="Rotate all bits to the left.">bitRotateLeft</a>(genType <span class="keyword">const</span> &amp; In, std::size_t Shift);
<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);
<a name="l00118"></a>00118
<a name="l00121"></a>00121 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIUType&gt;
<a name="l00122"></a>00122 genIUType <a class="code" href="a00170.html#gae42f1f6dd35271781f2c1029dd1c0a09" title="Set to 1 a range of bits.">fillBitfieldWithOne</a>(
<a name="l00122"></a>00122 genIUType <a class="code" href="a00170.html#gaf937428f9e6e9bb2e9214ff3be96cf95" title="Set to 1 a range of bits.">fillBitfieldWithOne</a>(
<a name="l00123"></a>00123 genIUType <span class="keyword">const</span> &amp; Value,
<a name="l00124"></a>00124 <span class="keywordtype">int</span> <span class="keyword">const</span> &amp; FromBit,
<a name="l00125"></a>00125 <span class="keywordtype">int</span> <span class="keyword">const</span> &amp; ToBit);
<a name="l00126"></a>00126
<a name="l00129"></a>00129 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIUType&gt;
<a name="l00130"></a>00130 genIUType <a class="code" href="a00170.html#ga4ba23fa82e64b0840b4b0b910217f730" title="Set to 0 a range of bits.">fillBitfieldWithZero</a>(
<a name="l00130"></a>00130 genIUType <a class="code" href="a00170.html#gabb9c7b3bd390a61437667e5625834a7c" title="Set to 0 a range of bits.">fillBitfieldWithZero</a>(
<a name="l00131"></a>00131 genIUType <span class="keyword">const</span> &amp; Value,
<a name="l00132"></a>00132 <span class="keywordtype">int</span> <span class="keyword">const</span> &amp; FromBit,
<a name="l00133"></a>00133 <span class="keywordtype">int</span> <span class="keyword">const</span> &amp; ToBit);
@@ -147,8 +161,13 @@
<a name="l00140"></a>00140 <span class="preprocessor">#endif//GLM_GTX_bit</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5
</small></address>
</body>
</html>