glm/doc/api/a00182.html

284 lines
17 KiB
HTML
Raw Normal View History

2015-08-02 08:23:00 +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"/>
2016-11-12 23:39:32 +00:00
<title>0.9.8 API documenation: GLM_GTX_bit</title>
2015-08-02 08:23:00 +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="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;">
2016-11-12 23:39:32 +00:00
<div id="projectname">0.9.8 API documenation
2015-08-02 08:23:00 +00:00
</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><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
2016-11-12 23:39:32 +00:00
<div class="title">GLM_GTX_bit<div class="ingroups"><a class="el" href="a00154.html">GTX Extensions (Experimental)</a></div></div> </div>
2015-08-02 08:23:00 +00:00
</div><!--header-->
<div class="contents">
2016-11-12 23:39:32 +00:00
<p>Allow to perform bit operations on integer values.
<a href="#details">More...</a></p>
2015-08-02 08:23:00 +00:00
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
2016-09-11 10:44:33 +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="a00182.html#ga0dcc8fe7c3d3ad60dea409281efa3d05">highestBitValue</a> (genIUType Value)</td></tr>
<tr class="separator:ga0dcc8fe7c3d3ad60dea409281efa3d05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5eea3a4d429040af13d39a7d7cd84d73"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga5eea3a4d429040af13d39a7d7cd84d73"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00182.html#ga5eea3a4d429040af13d39a7d7cd84d73">highestBitValue</a> (vecType&lt; T, P &gt; const &amp;value)</td></tr>
2016-11-12 23:39:32 +00:00
<tr class="memdesc:ga5eea3a4d429040af13d39a7d7cd84d73"><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="a00182.html#ga5eea3a4d429040af13d39a7d7cd84d73">More...</a><br /></td></tr>
2016-09-11 10:44:33 +00:00
<tr class="separator:ga5eea3a4d429040af13d39a7d7cd84d73"><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="a00182.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="a00182.html#ga8cda2459871f574a0aecbe702ac93291">powerOfTwoAbove</a> (genIUType Value)</td></tr>
2016-11-12 23:39:32 +00:00
<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="a00182.html#ga8cda2459871f574a0aecbe702ac93291">More...</a><br /></td></tr>
2016-09-11 10:44:33 +00:00
<tr class="separator:ga8cda2459871f574a0aecbe702ac93291"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafe08808a50226b75b50e640a08b32ddc"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:gafe08808a50226b75b50e640a08b32ddc"><td class="memTemplItemLeft" align="right" valign="top">GLM_DEPRECATED GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00182.html#gafe08808a50226b75b50e640a08b32ddc">powerOfTwoAbove</a> (vecType&lt; T, P &gt; const &amp;value)</td></tr>
2016-11-12 23:39:32 +00:00
<tr class="memdesc:gafe08808a50226b75b50e640a08b32ddc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the power of two number which value is just higher the input value. <a href="a00182.html#gafe08808a50226b75b50e640a08b32ddc">More...</a><br /></td></tr>
2016-09-11 10:44:33 +00:00
<tr class="separator:gafe08808a50226b75b50e640a08b32ddc"><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="a00182.html#ga3de7df63c589325101a2817a56f8e29d">powerOfTwoBelow</a> (genIUType Value)</td></tr>
2016-11-12 23:39:32 +00:00
<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="a00182.html#ga3de7df63c589325101a2817a56f8e29d">More...</a><br /></td></tr>
2016-09-11 10:44:33 +00:00
<tr class="separator:ga3de7df63c589325101a2817a56f8e29d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae33bb1ca2b55846b23a0f0796a679195"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:gae33bb1ca2b55846b23a0f0796a679195"><td class="memTemplItemLeft" align="right" valign="top">GLM_DEPRECATED GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00182.html#gae33bb1ca2b55846b23a0f0796a679195">powerOfTwoBelow</a> (vecType&lt; T, P &gt; const &amp;value)</td></tr>
2016-11-12 23:39:32 +00:00
<tr class="memdesc:gae33bb1ca2b55846b23a0f0796a679195"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the power of two number which value is just lower the input value. <a href="a00182.html#gae33bb1ca2b55846b23a0f0796a679195">More...</a><br /></td></tr>
2016-09-11 10:44:33 +00:00
<tr class="separator:gae33bb1ca2b55846b23a0f0796a679195"><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="a00182.html#ga5f65973a5d2ea38c719e6a663149ead9">powerOfTwoNearest</a> (genIUType Value)</td></tr>
2016-11-12 23:39:32 +00:00
<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="a00182.html#ga5f65973a5d2ea38c719e6a663149ead9">More...</a><br /></td></tr>
2016-09-11 10:44:33 +00:00
<tr class="separator:ga5f65973a5d2ea38c719e6a663149ead9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2d7e85995d097518b8d70cd409bda39e"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga2d7e85995d097518b8d70cd409bda39e"><td class="memTemplItemLeft" align="right" valign="top">GLM_DEPRECATED GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00182.html#ga2d7e85995d097518b8d70cd409bda39e">powerOfTwoNearest</a> (vecType&lt; T, P &gt; const &amp;value)</td></tr>
2016-11-12 23:39:32 +00:00
<tr class="memdesc:ga2d7e85995d097518b8d70cd409bda39e"><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="a00182.html#ga2d7e85995d097518b8d70cd409bda39e">More...</a><br /></td></tr>
2016-09-11 10:44:33 +00:00
<tr class="separator:ga2d7e85995d097518b8d70cd409bda39e"><td class="memSeparator" colspan="2">&#160;</td></tr>
2015-08-02 08:23:00 +00:00
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
2016-09-11 10:44:33 +00:00
<p>Allow to perform bit operations on integer values. </p>
<p>&lt;<a class="el" href="a00008.html" title="GLM_GTX_bit ">glm/gtx/bit.hpp</a>&gt; need to be included to use these functionalities. </p>
2015-08-02 08:23:00 +00:00
<h2 class="groupheader">Function Documentation</h2>
2016-09-11 10:44:33 +00:00
<a class="anchor" id="ga0dcc8fe7c3d3ad60dea409281efa3d05"></a>
2015-08-02 08:23:00 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2016-09-11 10:44:33 +00:00
<td class="memname">GLM_FUNC_DECL genIUType glm::highestBitValue </td>
2015-08-02 08:23:00 +00:00
<td>(</td>
2016-09-11 10:44:33 +00:00
<td class="paramtype">genIUType&#160;</td>
<td class="paramname"><em>Value</em></td><td>)</td>
2015-08-02 08:23:00 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2016-09-11 10:44:33 +00:00
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00182.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
2015-08-02 08:23:00 +00:00
</div>
</div>
2016-09-11 10:44:33 +00:00
<a class="anchor" id="ga5eea3a4d429040af13d39a7d7cd84d73"></a>
2015-08-02 08:23:00 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2016-09-11 10:44:33 +00:00
<td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::highestBitValue </td>
2015-08-02 08:23:00 +00:00
<td>(</td>
2016-09-11 10:44:33 +00:00
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
2015-08-02 08:23:00 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2016-09-11 10:44:33 +00:00
<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="a00182.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
2015-08-02 08:23:00 +00:00
</div>
</div>
2016-09-11 10:44:33 +00:00
<a class="anchor" id="ga2ff6568089f3a9b67f5c30918855fc6f"></a>
2015-08-02 08:23:00 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2016-09-11 10:44:33 +00:00
<td class="memname">GLM_FUNC_DECL genIUType glm::lowestBitValue </td>
2015-08-02 08:23:00 +00:00
<td>(</td>
2016-09-11 10:44:33 +00:00
<td class="paramtype">genIUType&#160;</td>
<td class="paramname"><em>Value</em></td><td>)</td>
2015-08-02 08:23:00 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2016-09-11 10:44:33 +00:00
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00182.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
2015-08-02 08:23:00 +00:00
</div>
</div>
2016-09-11 10:44:33 +00:00
<a class="anchor" id="ga8cda2459871f574a0aecbe702ac93291"></a>
2015-08-02 08:23:00 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2016-09-11 10:44:33 +00:00
<td class="memname">GLM_DEPRECATED GLM_FUNC_DECL genIUType glm::powerOfTwoAbove </td>
2015-08-02 08:23:00 +00:00
<td>(</td>
2016-09-11 10:44:33 +00:00
<td class="paramtype">genIUType&#160;</td>
<td class="paramname"><em>Value</em></td><td>)</td>
2015-08-02 08:23:00 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2016-09-11 10:44:33 +00:00
<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="a00175.html" title="rounding value to specific boundings ">GLM_GTC_round</a> </dd>
<dd>
<a class="el" href="a00182.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
2015-08-02 08:23:00 +00:00
</div>
</div>
2016-09-11 10:44:33 +00:00
<a class="anchor" id="gafe08808a50226b75b50e640a08b32ddc"></a>
2015-08-02 08:23:00 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2016-09-11 10:44:33 +00:00
<td class="memname">GLM_DEPRECATED GLM_FUNC_DECL vecType&lt;T, P&gt; glm::powerOfTwoAbove </td>
2015-08-02 08:23:00 +00:00
<td>(</td>
2016-09-11 10:44:33 +00:00
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
2015-08-02 08:23:00 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2016-09-11 10:44:33 +00:00
<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="a00175.html" title="rounding value to specific boundings ">GLM_GTC_round</a> </dd>
<dd>
<a class="el" href="a00182.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
2015-08-02 08:23:00 +00:00
</div>
</div>
2016-09-11 10:44:33 +00:00
<a class="anchor" id="ga3de7df63c589325101a2817a56f8e29d"></a>
2015-08-02 08:23:00 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2016-09-11 10:44:33 +00:00
<td class="memname">GLM_DEPRECATED GLM_FUNC_DECL genIUType glm::powerOfTwoBelow </td>
2015-08-02 08:23:00 +00:00
<td>(</td>
2016-09-11 10:44:33 +00:00
<td class="paramtype">genIUType&#160;</td>
<td class="paramname"><em>Value</em></td><td>)</td>
2015-08-02 08:23:00 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2016-09-11 10:44:33 +00:00
<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="a00175.html" title="rounding value to specific boundings ">GLM_GTC_round</a> </dd>
<dd>
<a class="el" href="a00182.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
2015-08-02 08:23:00 +00:00
</div>
</div>
2016-09-11 10:44:33 +00:00
<a class="anchor" id="gae33bb1ca2b55846b23a0f0796a679195"></a>
2015-08-02 08:23:00 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2016-09-11 10:44:33 +00:00
<td class="memname">GLM_DEPRECATED GLM_FUNC_DECL vecType&lt;T, P&gt; glm::powerOfTwoBelow </td>
2015-08-02 08:23:00 +00:00
<td>(</td>
2016-09-11 10:44:33 +00:00
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
2015-08-02 08:23:00 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2016-09-11 10:44:33 +00:00
<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="a00175.html" title="rounding value to specific boundings ">GLM_GTC_round</a> </dd>
<dd>
<a class="el" href="a00182.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
2015-08-02 08:23:00 +00:00
</div>
</div>
2016-09-11 10:44:33 +00:00
<a class="anchor" id="ga5f65973a5d2ea38c719e6a663149ead9"></a>
2015-08-02 08:23:00 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2016-09-11 10:44:33 +00:00
<td class="memname">GLM_DEPRECATED GLM_FUNC_DECL genIUType glm::powerOfTwoNearest </td>
2015-08-02 08:23:00 +00:00
<td>(</td>
2016-09-11 10:44:33 +00:00
<td class="paramtype">genIUType&#160;</td>
<td class="paramname"><em>Value</em></td><td>)</td>
2015-08-02 08:23:00 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2016-09-11 10:44:33 +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="a00175.html" title="rounding value to specific boundings ">GLM_GTC_round</a> </dd>
<dd>
<a class="el" href="a00182.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
2015-08-02 08:23:00 +00:00
</div>
</div>
2016-09-11 10:44:33 +00:00
<a class="anchor" id="ga2d7e85995d097518b8d70cd409bda39e"></a>
2015-08-02 08:23:00 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2016-09-11 10:44:33 +00:00
<td class="memname">GLM_DEPRECATED GLM_FUNC_DECL vecType&lt;T, P&gt; glm::powerOfTwoNearest </td>
2015-08-02 08:23:00 +00:00
<td>(</td>
2016-09-11 10:44:33 +00:00
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
2015-08-02 08:23:00 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2016-09-11 10:44:33 +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="a00175.html" title="rounding value to specific boundings ">GLM_GTC_round</a> </dd>
<dd>
<a class="el" href="a00182.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
2015-08-02 08:23:00 +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>