Updated API

This commit is contained in:
Christophe Riccio
2014-11-30 21:57:58 +01:00
parent a1e34d02ff
commit 6285ed64d3
385 changed files with 60361 additions and 60106 deletions

View File

@@ -4,7 +4,7 @@
<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.8"/>
<title>0.9.6: GLM_GTX_bit</title>
<title>0.9.6: GLM_GTX_closest_point</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>
@@ -39,188 +39,56 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_bit<div class="ingroups"><a class="el" href="a00160.html">GTX Extensions (Experimental)</a></div></div> </div>
<div class="title">GLM_GTX_closest_point<div class="ingroups"><a class="el" href="a00159.html">GTX Extensions (Experimental)</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<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="a00184.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="a00184.html#ga5eea3a4d429040af13d39a7d7cd84d73">highestBitValue</a> (vecType&lt; T, P &gt; const &amp;value)</td></tr>
<tr class="separator:ga5eea3a4d429040af13d39a7d7cd84d73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac3d48ed0ca5e1f2ed4bfa0d9830ade7c"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
<tr class="memitem:gac3d48ed0ca5e1f2ed4bfa0d9830ade7c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00184.html#gac3d48ed0ca5e1f2ed4bfa0d9830ade7c">powerOfTwoAbove</a> (genIUType Value)</td></tr>
<tr class="separator:gac3d48ed0ca5e1f2ed4bfa0d9830ade7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaeaafc0666a197b7175ab9fe2bac9b76c"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:gaeaafc0666a197b7175ab9fe2bac9b76c"><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="a00184.html#gaeaafc0666a197b7175ab9fe2bac9b76c">powerOfTwoAbove</a> (vecType&lt; T, P &gt; const &amp;value)</td></tr>
<tr class="separator:gaeaafc0666a197b7175ab9fe2bac9b76c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga238c43b77a03e95994f6aae978fdc581"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
<tr class="memitem:ga238c43b77a03e95994f6aae978fdc581"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00184.html#ga238c43b77a03e95994f6aae978fdc581">powerOfTwoBelow</a> (genIUType Value)</td></tr>
<tr class="separator:ga238c43b77a03e95994f6aae978fdc581"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac1a4b469276f2f1e34e515a74e495cc9"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:gac1a4b469276f2f1e34e515a74e495cc9"><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="a00184.html#gac1a4b469276f2f1e34e515a74e495cc9">powerOfTwoBelow</a> (vecType&lt; T, P &gt; const &amp;value)</td></tr>
<tr class="separator:gac1a4b469276f2f1e34e515a74e495cc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaffc52fa00d900040b3509fd158da0f62"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
<tr class="memitem:gaffc52fa00d900040b3509fd158da0f62"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00184.html#gaffc52fa00d900040b3509fd158da0f62">powerOfTwoNearest</a> (genIUType Value)</td></tr>
<tr class="separator:gaffc52fa00d900040b3509fd158da0f62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6f3ce56c9f85dbd45a157f668cd49a63"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga6f3ce56c9f85dbd45a157f668cd49a63"><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="a00184.html#ga6f3ce56c9f85dbd45a157f668cd49a63">powerOfTwoNearest</a> (vecType&lt; T, P &gt; const &amp;value)</td></tr>
<tr class="separator:ga6f3ce56c9f85dbd45a157f668cd49a63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac26353282a8213e469f5e33560c1200f"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gac26353282a8213e469f5e33560c1200f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec3&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00184.html#gac26353282a8213e469f5e33560c1200f">closestPointOnLine</a> (tvec3&lt; T, P &gt; const &amp;point, tvec3&lt; T, P &gt; const &amp;a, tvec3&lt; T, P &gt; const &amp;b)</td></tr>
<tr class="separator:gac26353282a8213e469f5e33560c1200f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadc7010070bb0cacd284f560299b21660"><td class="memTemplParams" colspan="2"><a class="anchor" id="gadc7010070bb0cacd284f560299b21660"></a>
template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gadc7010070bb0cacd284f560299b21660"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec2&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00184.html#gadc7010070bb0cacd284f560299b21660">closestPointOnLine</a> (tvec2&lt; T, P &gt; const &amp;point, tvec2&lt; T, P &gt; const &amp;a, tvec2&lt; T, P &gt; const &amp;b)</td></tr>
<tr class="separator:gadc7010070bb0cacd284f560299b21660"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Allow to perform bit operations on integer values. </p>
<p>&lt;<a class="el" href="a00008.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/bit.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>Find the point on a straight line which is the closet of a point. </p>
<p>&lt;<a class="el" href="a00010.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/closest_point.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga0dcc8fe7c3d3ad60dea409281efa3d05"></a>
<a class="anchor" id="gac26353282a8213e469f5e33560c1200f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genIUType glm::highestBitValue </td>
<td class="memname">GLM_FUNC_DECL tvec3&lt;T, P&gt; glm::closestPointOnLine </td>
<td>(</td>
<td class="paramtype">genIUType&#160;</td>
<td class="paramname"><em>Value</em></td><td>)</td>
<td></td>
<td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>point</em>, </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00184.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga5eea3a4d429040af13d39a7d7cd84d73"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::highestBitValue </td>
<td>(</td>
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>a</em>, </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="a00184.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gac3d48ed0ca5e1f2ed4bfa0d9830ade7c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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 class="paramkey"></td>
<td></td>
<td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>b</em>&#160;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the power of two number which value is just higher the input value. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00184.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaeaafc0666a197b7175ab9fe2bac9b76c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::powerOfTwoAbove </td>
<td>(</td>
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
<td>)</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>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00184.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga238c43b77a03e95994f6aae978fdc581"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00184.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gac1a4b469276f2f1e34e515a74e495cc9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::powerOfTwoBelow </td>
<td>(</td>
<td class="paramtype">vecType&lt; T, P &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>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00184.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaffc52fa00d900040b3509fd158da0f62"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00184.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga6f3ce56c9f85dbd45a157f668cd49a63"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::powerOfTwoNearest </td>
<td>(</td>
<td class="paramtype">vecType&lt; T, P &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 the closet to the input value. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00184.html" title="Allow to perform bit operations on integer values. ">GLM_GTX_bit</a> </dd></dl>
<p>Find the point on a straight line which is the closet of a point. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00184.html" title="Find the point on a straight line which is the closet of a point. ">GLM_GTX_closest_point</a> </dd></dl>
</div>
</div>