mirror of
https://github.com/g-truc/glm.git
synced 2024-11-10 12:41:54 +00:00
188 lines
20 KiB
HTML
188 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.9 API documenation: 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="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</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-mini.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">0.9.9 API documenation
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.10 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main 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>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_934f46a345653ef2b3014a1b37a162c1.html">G:</a></li><li class="navelem"><a class="el" href="dir_98f7f9d41f9d3029bd68cf237526a774.html">Source</a></li><li class="navelem"><a class="el" href="dir_9344afb825aed5e2f5be1d2015dde43c.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_45973f864e07b2505003ae343b7c8af7.html">glm</a></li><li class="navelem"><a class="el" href="dir_304be5dfae1339a7705426c0b536faf2.html">glm</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">integer.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="a00041.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "<a class="code" href="a00094.html">detail/setup.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "<a class="code" href="a00082.html">detail/qualifier.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "<a class="code" href="a00015.html">common.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "vector_relational.hpp"</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">namespace </span><a class="code" href="a00135.html">glm</a></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> {</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">template</span><length_t L, qualifier Q></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  GLM_FUNC_DECL vec<L, uint, Q> <a class="code" href="a00229.html#gaedcec48743632dff6786bcc492074b1b">uaddCarry</a>(</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  vec<L, uint, Q> <span class="keyword">const</span>& x,</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  vec<L, uint, Q> <span class="keyword">const</span>& y,</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  vec<L, uint, Q> & carry);</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">template</span><length_t L, qualifier Q></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  GLM_FUNC_DECL vec<L, uint, Q> <a class="code" href="a00229.html#gae3316ba1229ad9b9f09480833321b053">usubBorrow</a>(</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  vec<L, uint, Q> <span class="keyword">const</span>& x,</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  vec<L, uint, Q> <span class="keyword">const</span>& y,</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  vec<L, uint, Q> & borrow);</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">template</span><length_t L, qualifier Q></div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  GLM_FUNC_DECL <span class="keywordtype">void</span> <a class="code" href="a00229.html#ga732e2fb56db57ea541c7e5c92b7121be">umulExtended</a>(</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  vec<L, uint, Q> <span class="keyword">const</span>& x,</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  vec<L, uint, Q> <span class="keyword">const</span>& y,</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  vec<L, uint, Q> & msb,</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  vec<L, uint, Q> & lsb);</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">template</span><length_t L, qualifier Q></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  GLM_FUNC_DECL <span class="keywordtype">void</span> <a class="code" href="a00229.html#gac0c510a70e852f57594a9141848642e3">imulExtended</a>(</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  vec<L, int, Q> <span class="keyword">const</span>& x,</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  vec<L, int, Q> <span class="keyword">const</span>& y,</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  vec<L, int, Q> & msb,</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  vec<L, int, Q> & lsb);</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keyword">template</span><length_t L, <span class="keyword">typename</span> T, qualifier Q></div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  GLM_FUNC_DECL vec<L, T, Q> <a class="code" href="a00229.html#ga346b25ab11e793e91a4a69c8aa6819f2">bitfieldExtract</a>(</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  vec<L, T, Q> <span class="keyword">const</span>& Value,</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordtype">int</span> Offset,</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordtype">int</span> Bits);</div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">template</span><length_t L, <span class="keyword">typename</span> T, qualifier Q></div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  GLM_FUNC_DECL vec<L, T, Q> <a class="code" href="a00229.html#ga2e82992340d421fadb61a473df699b20">bitfieldInsert</a>(</div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  vec<L, T, Q> <span class="keyword">const</span>& Base,</div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  vec<L, T, Q> <span class="keyword">const</span>& Insert,</div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordtype">int</span> Offset,</div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keywordtype">int</span> Bits);</div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keyword">template</span><length_t L, <span class="keyword">typename</span> T, qualifier Q></div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  GLM_FUNC_DECL vec<L, T, Q> <a class="code" href="a00229.html#ga750a1d92464489b7711dee67aa3441b6">bitfieldReverse</a>(vec<L, T, Q> <span class="keyword">const</span>& v);</div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keyword">template</span><<span class="keyword">typename</span> genType></div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  GLM_FUNC_DECL <span class="keywordtype">int</span> <a class="code" href="a00229.html#gaac7b15e40bdea8d9aa4c4cb34049f7b5">bitCount</a>(genType v);</div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keyword">template</span><length_t L, <span class="keyword">typename</span> T, qualifier Q></div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  GLM_FUNC_DECL vec<L, int, Q> <a class="code" href="a00229.html#gaac7b15e40bdea8d9aa4c4cb34049f7b5">bitCount</a>(vec<L, T, Q> <span class="keyword">const</span>& v);</div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> </div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="keyword">template</span><<span class="keyword">typename</span> genIUType></div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  GLM_FUNC_DECL <span class="keywordtype">int</span> <a class="code" href="a00229.html#ga4454c0331d6369888c28ab677f4810c7">findLSB</a>(genIUType x);</div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> </div>
|
|
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <span class="keyword">template</span><length_t L, <span class="keyword">typename</span> T, qualifier Q></div>
|
|
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  GLM_FUNC_DECL vec<L, int, Q> <a class="code" href="a00229.html#ga4454c0331d6369888c28ab677f4810c7">findLSB</a>(vec<L, T, Q> <span class="keyword">const</span>& v);</div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> </div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  <span class="keyword">template</span><<span class="keyword">typename</span> genIUType></div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  GLM_FUNC_DECL <span class="keywordtype">int</span> <a class="code" href="a00229.html#ga39ac4d52028bb6ab08db5ad6562c2872">findMSB</a>(genIUType x);</div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> </div>
|
|
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <span class="keyword">template</span><length_t L, <span class="keyword">typename</span> T, qualifier Q></div>
|
|
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  GLM_FUNC_DECL vec<L, int, Q> <a class="code" href="a00229.html#ga39ac4d52028bb6ab08db5ad6562c2872">findMSB</a>(vec<L, T, Q> <span class="keyword">const</span>& v);</div>
|
|
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> </div>
|
|
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> }<span class="comment">//namespace glm</span></div>
|
|
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> </div>
|
|
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="preprocessor">#include "detail/func_integer.inl"</span></div>
|
|
<div class="ttc" id="a00229_html_ga39ac4d52028bb6ab08db5ad6562c2872"><div class="ttname"><a href="a00229.html#ga39ac4d52028bb6ab08db5ad6562c2872">glm::findMSB</a></div><div class="ttdeci">GLM_FUNC_DECL vec< L, int, Q > findMSB(vec< L, T, Q > const &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="a00229_html_ga750a1d92464489b7711dee67aa3441b6"><div class="ttname"><a href="a00229.html#ga750a1d92464489b7711dee67aa3441b6">glm::bitfieldReverse</a></div><div class="ttdeci">GLM_FUNC_DECL vec< L, T, Q > bitfieldReverse(vec< L, T, Q > const &v)</div><div class="ttdoc">Returns the reversal of the bits of value. </div></div>
|
|
<div class="ttc" id="a00229_html_gac0c510a70e852f57594a9141848642e3"><div class="ttname"><a href="a00229.html#gac0c510a70e852f57594a9141848642e3">glm::imulExtended</a></div><div class="ttdeci">GLM_FUNC_DECL void imulExtended(vec< L, int, Q > const &x, vec< L, int, Q > const &y, vec< L, int, Q > &msb, vec< L, int, Q > &lsb)</div><div class="ttdoc">Multiplies 32-bit integers x and y, producing a 64-bit result. </div></div>
|
|
<div class="ttc" id="a00015_html"><div class="ttname"><a href="a00015.html">common.hpp</a></div><div class="ttdoc">Core features </div></div>
|
|
<div class="ttc" id="a00229_html_gaedcec48743632dff6786bcc492074b1b"><div class="ttname"><a href="a00229.html#gaedcec48743632dff6786bcc492074b1b">glm::uaddCarry</a></div><div class="ttdeci">GLM_FUNC_DECL vec< L, uint, Q > uaddCarry(vec< L, uint, Q > const &x, vec< L, uint, Q > const &y, vec< L, uint, Q > &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="a00135_html"><div class="ttname"><a href="a00135.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00015_source.html#l00020">common.hpp:20</a></div></div>
|
|
<div class="ttc" id="a00229_html_ga4454c0331d6369888c28ab677f4810c7"><div class="ttname"><a href="a00229.html#ga4454c0331d6369888c28ab677f4810c7">glm::findLSB</a></div><div class="ttdeci">GLM_FUNC_DECL vec< L, int, Q > findLSB(vec< L, T, Q > const &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="a00082_html"><div class="ttname"><a href="a00082.html">qualifier.hpp</a></div><div class="ttdoc">Core features </div></div>
|
|
<div class="ttc" id="a00229_html_gaac7b15e40bdea8d9aa4c4cb34049f7b5"><div class="ttname"><a href="a00229.html#gaac7b15e40bdea8d9aa4c4cb34049f7b5">glm::bitCount</a></div><div class="ttdeci">GLM_FUNC_DECL vec< L, int, Q > bitCount(vec< L, T, Q > const &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="a00229_html_ga2e82992340d421fadb61a473df699b20"><div class="ttname"><a href="a00229.html#ga2e82992340d421fadb61a473df699b20">glm::bitfieldInsert</a></div><div class="ttdeci">GLM_FUNC_DECL vec< L, T, Q > bitfieldInsert(vec< L, T, Q > const &Base, vec< L, T, Q > const &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="a00229_html_ga346b25ab11e793e91a4a69c8aa6819f2"><div class="ttname"><a href="a00229.html#ga346b25ab11e793e91a4a69c8aa6819f2">glm::bitfieldExtract</a></div><div class="ttdeci">GLM_FUNC_DECL vec< L, T, Q > bitfieldExtract(vec< L, T, Q > const &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="a00094_html"><div class="ttname"><a href="a00094.html">setup.hpp</a></div><div class="ttdoc">Core features </div></div>
|
|
<div class="ttc" id="a00229_html_gae3316ba1229ad9b9f09480833321b053"><div class="ttname"><a href="a00229.html#gae3316ba1229ad9b9f09480833321b053">glm::usubBorrow</a></div><div class="ttdeci">GLM_FUNC_DECL vec< L, uint, Q > usubBorrow(vec< L, uint, Q > const &x, vec< L, uint, Q > const &y, vec< L, uint, Q > &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="a00229_html_ga732e2fb56db57ea541c7e5c92b7121be"><div class="ttname"><a href="a00229.html#ga732e2fb56db57ea541c7e5c92b7121be">glm::umulExtended</a></div><div class="ttdeci">GLM_FUNC_DECL void umulExtended(vec< L, uint, Q > const &x, vec< L, uint, Q > const &y, vec< L, uint, Q > &msb, vec< L, uint, Q > &lsb)</div><div class="ttdoc">Multiplies 32-bit integers x and y, producing a 64-bit result. </div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.10
|
|
</small></address>
|
|
</body>
|
|
</html>
|