anbox/external/glm/doc/api/a00032_source.html
Simon Fels 5070880428 external: import local copy of GLM 0.9.7.2
This allows building against the same version of GLM across all targets
and not deal with API changes of newer GLM versions which introduce
regressions. Long term we want to migrate away from GLM and stick to a
minimal self-written subset.
2018-05-18 19:37:52 +02:00

149 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>0.9.7: func_integer.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">0.9.7
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_275089585c7fc1b5fd5d7d42c69cb1da.html">D:</a></li><li class="navelem"><a class="el" href="dir_7b98f88bffbed4b390b5f8f520d9c08e.html">Source</a></li><li class="navelem"><a class="el" href="dir_1f76e953200861345293ade84ac7fb6c.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_e29b03b892e0e25920d021a614d4db9b.html">glm</a></li><li class="navelem"><a class="el" href="dir_5ce58d942b2d0776e17a9a58abc01e04.html">glm</a></li><li class="navelem"><a class="el" href="dir_e529a619cfdec1fa4c331fb042fd332f.html">detail</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">func_integer.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00032.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>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00105.html">setup.hpp</a>&quot;</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00092.html">precision.hpp</a>&quot;</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00029.html">func_common.hpp</a>&quot;</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00037.html">func_vector_relational.hpp</a>&quot;</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00146.html">glm</a></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;{</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keyword">template</span> &lt;precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; GLM_FUNC_DECL vecType&lt;uint, P&gt; <a class="code" href="a00154.html#ga2fc1a46e7b7e9fbbd8fa444fbacaa2aa">uaddCarry</a>(</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; vecType&lt;uint, P&gt; <span class="keyword">const</span> &amp; x,</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; vecType&lt;uint, P&gt; <span class="keyword">const</span> &amp; y,</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; vecType&lt;uint, P&gt; &amp; carry);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keyword">template</span> &lt;precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; GLM_FUNC_DECL vecType&lt;uint, P&gt; <a class="code" href="a00154.html#ga22a889bf08313b7e547e2cdb8bb15ee4">usubBorrow</a>(</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; vecType&lt;uint, P&gt; <span class="keyword">const</span> &amp; x,</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; vecType&lt;uint, P&gt; <span class="keyword">const</span> &amp; y,</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; vecType&lt;uint, P&gt; &amp; borrow);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keyword">template</span> &lt;precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; GLM_FUNC_DECL <span class="keywordtype">void</span> <a class="code" href="a00154.html#ga456ff9dcec42f6769a9ae2a2af7f1ce1">umulExtended</a>(</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; vecType&lt;uint, P&gt; <span class="keyword">const</span> &amp; x,</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; vecType&lt;uint, P&gt; <span class="keyword">const</span> &amp; y,</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; vecType&lt;uint, P&gt; &amp; msb,</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; vecType&lt;uint, P&gt; &amp; lsb);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; </div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keyword">template</span> &lt;precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; GLM_FUNC_DECL <span class="keywordtype">void</span> <a class="code" href="a00154.html#ga6e6e8b29ca40d8ca2df10b58ed17d426">imulExtended</a>(</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; vecType&lt;int, P&gt; <span class="keyword">const</span> &amp; x,</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; vecType&lt;int, P&gt; <span class="keyword">const</span> &amp; y,</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; vecType&lt;int, P&gt; &amp; msb,</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; vecType&lt;int, P&gt; &amp; lsb);</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00154.html#gab84b88f3a8e367774e5dd1c618c353cf">bitfieldExtract</a>(</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; Value,</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <span class="keywordtype">int</span> Offset,</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keywordtype">int</span> Bits);</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00154.html#ga5681dfac9239beb1b8bd995e3c6496d7">bitfieldInsert</a>(</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; Base,</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; Insert,</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; <span class="keywordtype">int</span> Offset,</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; <span class="keywordtype">int</span> Bits);</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00154.html#ga153e7e8d0c035f83cce50fc3e580930f">bitfieldReverse</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; GLM_FUNC_DECL <span class="keywordtype">int</span> <a class="code" href="a00154.html#ga1f29640969a3c54564da06ac67a5392e">bitCount</a>(genType v);</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160;</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; GLM_FUNC_DECL vecType&lt;int, P&gt; <a class="code" href="a00154.html#ga1f29640969a3c54564da06ac67a5392e">bitCount</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160;</div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIUType&gt;</div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160; GLM_FUNC_DECL <span class="keywordtype">int</span> <a class="code" href="a00154.html#ga014a72009e68233c34c06a6dc2251b8c">findLSB</a>(genIUType x);</div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160;</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160; GLM_FUNC_DECL vecType&lt;int, P&gt; <a class="code" href="a00154.html#ga014a72009e68233c34c06a6dc2251b8c">findLSB</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160;</div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIUType&gt;</div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160; GLM_FUNC_DECL <span class="keywordtype">int</span> <a class="code" href="a00154.html#ga433104d77ec2ba58888aaefb77e9183f">findMSB</a>(genIUType x);</div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160;</div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160; GLM_FUNC_DECL vecType&lt;int, P&gt; <a class="code" href="a00154.html#ga433104d77ec2ba58888aaefb77e9183f">findMSB</a>(vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160;</div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160;</div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160;<span class="preprocessor">#include &quot;func_integer.inl&quot;</span></div>
<div class="ttc" id="a00154_html_ga5681dfac9239beb1b8bd995e3c6496d7"><div class="ttname"><a href="a00154.html#ga5681dfac9239beb1b8bd995e3c6496d7">glm::bitfieldInsert</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; bitfieldInsert(vecType&lt; T, P &gt; const &amp;Base, vecType&lt; T, P &gt; const &amp;Insert, int Offset, int Bits)</div><div class="ttdoc">Returns the insertion the bits least-significant bits of insert into base. </div></div>
<div class="ttc" id="a00154_html_ga22a889bf08313b7e547e2cdb8bb15ee4"><div class="ttname"><a href="a00154.html#ga22a889bf08313b7e547e2cdb8bb15ee4">glm::usubBorrow</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; uint, P &gt; usubBorrow(vecType&lt; uint, P &gt; const &amp;x, vecType&lt; uint, P &gt; const &amp;y, vecType&lt; uint, P &gt; &amp;borrow)</div><div class="ttdoc">Subtracts the 32-bit unsigned integer y from x, returning the difference if non-negative, or pow(2, 32) plus the difference otherwise. </div></div>
<div class="ttc" id="a00154_html_gab84b88f3a8e367774e5dd1c618c353cf"><div class="ttname"><a href="a00154.html#gab84b88f3a8e367774e5dd1c618c353cf">glm::bitfieldExtract</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; bitfieldExtract(vecType&lt; T, P &gt; const &amp;Value, int Offset, int Bits)</div><div class="ttdoc">Extracts bits [offset, offset + bits - 1] from value, returning them in the least significant bits of...</div></div>
<div class="ttc" id="a00154_html_ga014a72009e68233c34c06a6dc2251b8c"><div class="ttname"><a href="a00154.html#ga014a72009e68233c34c06a6dc2251b8c">glm::findLSB</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; int, P &gt; findLSB(vecType&lt; T, P &gt; const &amp;v)</div><div class="ttdoc">Returns the bit number of the least significant bit set to 1 in the binary representation of value...</div></div>
<div class="ttc" id="a00154_html_ga433104d77ec2ba58888aaefb77e9183f"><div class="ttname"><a href="a00154.html#ga433104d77ec2ba58888aaefb77e9183f">glm::findMSB</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; int, P &gt; findMSB(vecType&lt; T, P &gt; const &amp;v)</div><div class="ttdoc">Returns the bit number of the most significant bit in the binary representation of value...</div></div>
<div class="ttc" id="a00154_html_ga153e7e8d0c035f83cce50fc3e580930f"><div class="ttname"><a href="a00154.html#ga153e7e8d0c035f83cce50fc3e580930f">glm::bitfieldReverse</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; bitfieldReverse(vecType&lt; T, P &gt; const &amp;v)</div><div class="ttdoc">Returns the reversal of the bits of value. </div></div>
<div class="ttc" id="a00154_html_ga2fc1a46e7b7e9fbbd8fa444fbacaa2aa"><div class="ttname"><a href="a00154.html#ga2fc1a46e7b7e9fbbd8fa444fbacaa2aa">glm::uaddCarry</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; uint, P &gt; uaddCarry(vecType&lt; uint, P &gt; const &amp;x, vecType&lt; uint, P &gt; const &amp;y, vecType&lt; uint, P &gt; &amp;carry)</div><div class="ttdoc">Adds 32-bit unsigned integer x and y, returning the sum modulo pow(2, 32). </div></div>
<div class="ttc" id="a00154_html_ga456ff9dcec42f6769a9ae2a2af7f1ce1"><div class="ttname"><a href="a00154.html#ga456ff9dcec42f6769a9ae2a2af7f1ce1">glm::umulExtended</a></div><div class="ttdeci">GLM_FUNC_DECL void umulExtended(vecType&lt; uint, P &gt; const &amp;x, vecType&lt; uint, P &gt; const &amp;y, vecType&lt; uint, P &gt; &amp;msb, vecType&lt; uint, P &gt; &amp;lsb)</div><div class="ttdoc">Multiplies 32-bit integers x and y, producing a 64-bit result. </div></div>
<div class="ttc" id="a00154_html_ga6e6e8b29ca40d8ca2df10b58ed17d426"><div class="ttname"><a href="a00154.html#ga6e6e8b29ca40d8ca2df10b58ed17d426">glm::imulExtended</a></div><div class="ttdeci">GLM_FUNC_DECL void imulExtended(vecType&lt; int, P &gt; const &amp;x, vecType&lt; int, P &gt; const &amp;y, vecType&lt; int, P &gt; &amp;msb, vecType&lt; int, P &gt; &amp;lsb)</div><div class="ttdoc">Multiplies 32-bit integers x and y, producing a 64-bit result. </div></div>
<div class="ttc" id="a00029_html"><div class="ttname"><a href="a00029.html">func_common.hpp</a></div><div class="ttdoc">OpenGL Mathematics (glm.g-truc.net) </div></div>
<div class="ttc" id="a00146_html"><div class="ttname"><a href="a00146.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00003_source.html#l00040">_noise.hpp:40</a></div></div>
<div class="ttc" id="a00105_html"><div class="ttname"><a href="a00105.html">setup.hpp</a></div><div class="ttdoc">OpenGL Mathematics (glm.g-truc.net) </div></div>
<div class="ttc" id="a00037_html"><div class="ttname"><a href="a00037.html">func_vector_relational.hpp</a></div><div class="ttdoc">OpenGL Mathematics (glm.g-truc.net) </div></div>
<div class="ttc" id="a00154_html_ga1f29640969a3c54564da06ac67a5392e"><div class="ttname"><a href="a00154.html#ga1f29640969a3c54564da06ac67a5392e">glm::bitCount</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; int, P &gt; bitCount(vecType&lt; T, P &gt; const &amp;v)</div><div class="ttdoc">Returns the number of bits set to 1 in the binary representation of value. </div></div>
<div class="ttc" id="a00092_html"><div class="ttname"><a href="a00092.html">precision.hpp</a></div><div class="ttdoc">OpenGL Mathematics (glm.g-truc.net) </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<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.8.10
</small></address>
</body>
</html>