mirror/glm
1
0
Fork 0
mirror of https://github.com/g-truc/glm.git synced 2024-11-10 12:41:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
c013b4e58f
glm/doc/api/a00170.html

323 lines
19 KiB
HTML
Raw Normal View History

Updated API doc
2017-08-15 19:22:51 +00:00
<!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"/>
Updated API doc
2017-08-17 17:53:21 +00:00
<title>0.9.9 API documenation: GLM_GTX_bit</title>
Updated API doc
2017-08-15 19:22:51 +00:00
<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;">
Updated API doc
2017-08-17 18:39:22 +00:00
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
Updated API doc
2017-08-15 19:22:51 +00:00
<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&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><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><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
Updated API doc
2017-08-17 17:53:21 +00:00
<div class="title">GLM_GTX_bit<div class="ingroups"><a class="el" href="a00148.html">Experimental extensions</a></div></div> </div>
Updated API doc
2017-08-15 19:22:51 +00:00
</div><!--header-->
<div class="contents">
Updated API doc
2017-08-17 17:53:21 +00:00
<p>Include &lt;<a class="el" href="a00008.html" title="GLM_GTX_bit ">glm/gtx/bit.hpp</a>&gt; to use the features of this extension.
Updated API doc
2017-08-15 19:22:51 +00:00
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
Updated API doc
2017-08-17 17:53:21 +00:00
<tr class="memitem:ga0dcc8fe7c3d3ad60dea409281efa3d05"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
<tr class="memitem:ga0dcc8fe7c3d3ad60dea409281efa3d05"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00170.html#ga0dcc8fe7c3d3ad60dea409281efa3d05">highestBitValue</a> (genIUType Value)</td></tr>
<tr class="separator:ga0dcc8fe7c3d3ad60dea409281efa3d05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga898ef075ccf809a1e480faab48fe96bf"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga898ef075ccf809a1e480faab48fe96bf"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00170.html#ga898ef075ccf809a1e480faab48fe96bf">highestBitValue</a> (vec&lt; L, T, Q &gt; const &amp;value)</td></tr>
<tr class="memdesc:ga898ef075ccf809a1e480faab48fe96bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the highest bit set to 1 in a integer variable and return its value. <a href="a00170.html#ga898ef075ccf809a1e480faab48fe96bf">More...</a><br /></td></tr>
<tr class="separator:ga898ef075ccf809a1e480faab48fe96bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2ff6568089f3a9b67f5c30918855fc6f"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
<tr class="memitem:ga2ff6568089f3a9b67f5c30918855fc6f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00170.html#ga2ff6568089f3a9b67f5c30918855fc6f">lowestBitValue</a> (genIUType Value)</td></tr>
<tr class="separator:ga2ff6568089f3a9b67f5c30918855fc6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8cda2459871f574a0aecbe702ac93291"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
<tr class="memitem:ga8cda2459871f574a0aecbe702ac93291"><td class="memTemplItemLeft" align="right" valign="top">GLM_DEPRECATED GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00170.html#ga8cda2459871f574a0aecbe702ac93291">powerOfTwoAbove</a> (genIUType Value)</td></tr>
<tr class="memdesc:ga8cda2459871f574a0aecbe702ac93291"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the power of two number which value is just higher the input value. <a href="a00170.html#ga8cda2459871f574a0aecbe702ac93291">More...</a><br /></td></tr>
<tr class="separator:ga8cda2459871f574a0aecbe702ac93291"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2bbded187c5febfefc1e524ba31b3fab"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga2bbded187c5febfefc1e524ba31b3fab"><td class="memTemplItemLeft" align="right" valign="top">GLM_DEPRECATED GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00170.html#ga2bbded187c5febfefc1e524ba31b3fab">powerOfTwoAbove</a> (vec&lt; L, T, Q &gt; const &amp;value)</td></tr>
<tr class="memdesc:ga2bbded187c5febfefc1e524ba31b3fab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the power of two number which value is just higher the input value. <a href="a00170.html#ga2bbded187c5febfefc1e524ba31b3fab">More...</a><br /></td></tr>
<tr class="separator:ga2bbded187c5febfefc1e524ba31b3fab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3de7df63c589325101a2817a56f8e29d"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
<tr class="memitem:ga3de7df63c589325101a2817a56f8e29d"><td class="memTemplItemLeft" align="right" valign="top">GLM_DEPRECATED GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00170.html#ga3de7df63c589325101a2817a56f8e29d">powerOfTwoBelow</a> (genIUType Value)</td></tr>
<tr class="memdesc:ga3de7df63c589325101a2817a56f8e29d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the power of two number which value is just lower the input value. <a href="a00170.html#ga3de7df63c589325101a2817a56f8e29d">More...</a><br /></td></tr>
<tr class="separator:ga3de7df63c589325101a2817a56f8e29d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf78ddcc4152c051b2a21e68fecb10980"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:gaf78ddcc4152c051b2a21e68fecb10980"><td class="memTemplItemLeft" align="right" valign="top">GLM_DEPRECATED GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00170.html#gaf78ddcc4152c051b2a21e68fecb10980">powerOfTwoBelow</a> (vec&lt; L, T, Q &gt; const &amp;value)</td></tr>
<tr class="memdesc:gaf78ddcc4152c051b2a21e68fecb10980"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the power of two number which value is just lower the input value. <a href="a00170.html#gaf78ddcc4152c051b2a21e68fecb10980">More...</a><br /></td></tr>
<tr class="separator:gaf78ddcc4152c051b2a21e68fecb10980"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5f65973a5d2ea38c719e6a663149ead9"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
<tr class="memitem:ga5f65973a5d2ea38c719e6a663149ead9"><td class="memTemplItemLeft" align="right" valign="top">GLM_DEPRECATED GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00170.html#ga5f65973a5d2ea38c719e6a663149ead9">powerOfTwoNearest</a> (genIUType Value)</td></tr>
<tr class="memdesc:ga5f65973a5d2ea38c719e6a663149ead9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the power of two number which value is the closet to the input value. <a href="a00170.html#ga5f65973a5d2ea38c719e6a663149ead9">More...</a><br /></td></tr>
<tr class="separator:ga5f65973a5d2ea38c719e6a663149ead9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac87e65d11e16c3d6b91c3bcfaef7da0b"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:gac87e65d11e16c3d6b91c3bcfaef7da0b"><td class="memTemplItemLeft" align="right" valign="top">GLM_DEPRECATED GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00170.html#gac87e65d11e16c3d6b91c3bcfaef7da0b">powerOfTwoNearest</a> (vec&lt; L, T, Q &gt; const &amp;value)</td></tr>
<tr class="memdesc:gac87e65d11e16c3d6b91c3bcfaef7da0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the power of two number which value is the closet to the input value. <a href="a00170.html#gac87e65d11e16c3d6b91c3bcfaef7da0b">More...</a><br /></td></tr>
<tr class="separator:gac87e65d11e16c3d6b91c3bcfaef7da0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
Updated API doc
2017-08-15 19:22:51 +00:00
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
Updated API doc
2017-08-17 17:53:21 +00:00
<p>Include &lt;<a class="el" href="a00008.html" title="GLM_GTX_bit ">glm/gtx/bit.hpp</a>&gt; to use the features of this extension. </p>
<p>Allow to perform bit operations on integer values </p>
Updated API doc
2017-08-15 19:22:51 +00:00
<h2 class="groupheader">Function Documentation</h2>
Updated API doc
2017-08-17 17:53:21 +00:00
<a class="anchor" id="ga0dcc8fe7c3d3ad60dea409281efa3d05"></a>
Updated API doc
2017-08-15 19:22:51 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
Updated API doc
2017-08-17 17:53:21 +00:00
<td class="memname">GLM_FUNC_DECL genIUType glm::highestBitValue </td>
Updated API doc
2017-08-15 19:22:51 +00:00
<td>(</td>
Updated API doc
2017-08-17 17:53:21 +00:00
<td class="paramtype">genIUType&#160;</td>
<td class="paramname"><em>Value</em></td><td>)</td>
Updated API doc
2017-08-15 19:22:51 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
Updated API doc
2017-08-17 17:53:21 +00:00
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00170.html" title="Include <glm/gtx/bit.hpp> to use the features of this extension. ">GLM_GTX_bit</a> </dd></dl>
Updated API doc
2017-08-15 19:22:51 +00:00
Updated API doc
2017-08-17 17:53:21 +00:00
</div>
</div>
<a class="anchor" id="ga898ef075ccf809a1e480faab48fe96bf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::highestBitValue </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find the highest bit set to 1 in a integer variable and return its value. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00170.html" title="Include <glm/gtx/bit.hpp> to use the features of this extension. ">GLM_GTX_bit</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga2ff6568089f3a9b67f5c30918855fc6f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genIUType glm::lowestBitValue </td>
<td>(</td>
<td class="paramtype">genIUType&#160;</td>
<td class="paramname"><em>Value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00170.html" title="Include <glm/gtx/bit.hpp> to use the features of this extension. ">GLM_GTX_bit</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga8cda2459871f574a0aecbe702ac93291"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_DEPRECATED GLM_FUNC_DECL genIUType glm::powerOfTwoAbove </td>
<td>(</td>
<td class="paramtype">genIUType&#160;</td>
<td class="paramname"><em>Value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the power of two number which value is just higher the input value. </p>
<p>Deprecated, use ceilPowerOfTwo from GTC_round instead</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd>
<dd>
<a class="el" href="a00170.html" title="Include <glm/gtx/bit.hpp> to use the features of this extension. ">GLM_GTX_bit</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga2bbded187c5febfefc1e524ba31b3fab"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_DEPRECATED GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::powerOfTwoAbove </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the power of two number which value is just higher the input value. </p>
<p>Deprecated, use ceilPowerOfTwo from GTC_round instead</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd>
<dd>
<a class="el" href="a00170.html" title="Include <glm/gtx/bit.hpp> to use the features of this extension. ">GLM_GTX_bit</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga3de7df63c589325101a2817a56f8e29d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_DEPRECATED GLM_FUNC_DECL genIUType glm::powerOfTwoBelow </td>
<td>(</td>
<td class="paramtype">genIUType&#160;</td>
<td class="paramname"><em>Value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the power of two number which value is just lower the input value. </p>
<p>Deprecated, use floorPowerOfTwo from GTC_round instead</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd>
<dd>
<a class="el" href="a00170.html" title="Include <glm/gtx/bit.hpp> to use the features of this extension. ">GLM_GTX_bit</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaf78ddcc4152c051b2a21e68fecb10980"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_DEPRECATED GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::powerOfTwoBelow </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the power of two number which value is just lower the input value. </p>
<p>Deprecated, use floorPowerOfTwo from GTC_round instead</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd>
<dd>
<a class="el" href="a00170.html" title="Include <glm/gtx/bit.hpp> to use the features of this extension. ">GLM_GTX_bit</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga5f65973a5d2ea38c719e6a663149ead9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_DEPRECATED GLM_FUNC_DECL genIUType glm::powerOfTwoNearest </td>
<td>(</td>
<td class="paramtype">genIUType&#160;</td>
<td class="paramname"><em>Value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the power of two number which value is the closet to the input value. </p>
<p>Deprecated, use roundPowerOfTwo from GTC_round instead</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd>
<dd>
<a class="el" href="a00170.html" title="Include <glm/gtx/bit.hpp> to use the features of this extension. ">GLM_GTX_bit</a> </dd></dl>
Updated API doc
2017-08-15 19:22:51 +00:00
</div>
</div>
Updated API doc
2017-08-17 17:53:21 +00:00
<a class="anchor" id="gac87e65d11e16c3d6b91c3bcfaef7da0b"></a>
Updated API doc
2017-08-15 19:22:51 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
Updated API doc
2017-08-17 17:53:21 +00:00
<td class="memname">GLM_DEPRECATED GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::powerOfTwoNearest </td>
Updated API doc
2017-08-15 19:22:51 +00:00
<td>(</td>
Updated API doc
2017-08-17 17:53:21 +00:00
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
Updated API doc
2017-08-15 19:22:51 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
Updated API doc
2017-08-17 17:53:21 +00:00
<p>Return the power of two number which value is the closet to the input value. </p>
<p>Deprecated, use roundPowerOfTwo from GTC_round instead</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd>
<dd>
<a class="el" href="a00170.html" title="Include <glm/gtx/bit.hpp> to use the features of this extension. ">GLM_GTX_bit</a> </dd></dl>
Updated API doc
2017-08-15 19:22:51 +00:00
</div>
</div>
</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>
Reference in New Issue Copy Permalink