Updated API documentation
This commit is contained in:
Christophe Riccio
@@ -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.10"/>
|
||||
<title>0.9.7: GLM_GTC_ulp</title>
|
||||
<title>0.9.8: 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>
|
||||
@@ -18,7 +18,7 @@
|
||||
<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 id="projectname">0.9.8
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -39,50 +39,45 @@
|
||||
<div class="summary">
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">GLM_GTC_ulp<div class="ingroups"><a class="el" href="a00160.html">GTC Extensions (Stable)</a></div></div> </div>
|
||||
<div class="title">GLM_GTX_closest_point<div class="ingroups"><a class="el" href="a00155.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:ga2e09bd6c8b0a9c91f6f5683d68245634"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr class="memitem:ga2e09bd6c8b0a9c91f6f5683d68245634"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL uint </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00183.html#ga2e09bd6c8b0a9c91f6f5683d68245634">float_distance</a> (T const &x, T const &y)</td></tr>
|
||||
<tr class="separator:ga2e09bd6c8b0a9c91f6f5683d68245634"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga85355f2549d75789eb66e5d565d8ad26"><td class="memTemplParams" colspan="2">template<typename T , template< typename > class vecType> </td></tr>
|
||||
<tr class="memitem:ga85355f2549d75789eb66e5d565d8ad26"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< uint > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00183.html#ga85355f2549d75789eb66e5d565d8ad26">float_distance</a> (vecType< T > const &x, vecType< T > const &y)</td></tr>
|
||||
<tr class="separator:ga85355f2549d75789eb66e5d565d8ad26"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gae516ae554faa6117660828240e8bdaf0"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:gae516ae554faa6117660828240e8bdaf0"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00183.html#gae516ae554faa6117660828240e8bdaf0">next_float</a> (genType const &x)</td></tr>
|
||||
<tr class="separator:gae516ae554faa6117660828240e8bdaf0"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gad107ec3d9697ef82032a33338a73ebdd"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:gad107ec3d9697ef82032a33338a73ebdd"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00183.html#gad107ec3d9697ef82032a33338a73ebdd">next_float</a> (genType const &x, uint const &Distance)</td></tr>
|
||||
<tr class="separator:gad107ec3d9697ef82032a33338a73ebdd"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga2fcbb7bfbfc595712bfddc51b0715b07"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:ga2fcbb7bfbfc595712bfddc51b0715b07"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00183.html#ga2fcbb7bfbfc595712bfddc51b0715b07">prev_float</a> (genType const &x)</td></tr>
|
||||
<tr class="separator:ga2fcbb7bfbfc595712bfddc51b0715b07"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gaa399d5b6472a70e8952f9b26ecaacdec"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:gaa399d5b6472a70e8952f9b26ecaacdec"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00183.html#gaa399d5b6472a70e8952f9b26ecaacdec">prev_float</a> (genType const &x, uint const &Distance)</td></tr>
|
||||
<tr class="separator:gaa399d5b6472a70e8952f9b26ecaacdec"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gac26353282a8213e469f5e33560c1200f"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr>
|
||||
<tr class="memitem:gac26353282a8213e469f5e33560c1200f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec3< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00183.html#gac26353282a8213e469f5e33560c1200f">closestPointOnLine</a> (tvec3< T, P > const &point, tvec3< T, P > const &a, tvec3< T, P > const &b)</td></tr>
|
||||
<tr class="separator:gac26353282a8213e469f5e33560c1200f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gadc7010070bb0cacd284f560299b21660"><td class="memTemplParams" colspan="2"><a class="anchor" id="gadc7010070bb0cacd284f560299b21660"></a>
|
||||
template<typename T , precision P> </td></tr>
|
||||
<tr class="memitem:gadc7010070bb0cacd284f560299b21660"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec2< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00183.html#gadc7010070bb0cacd284f560299b21660">closestPointOnLine</a> (tvec2< T, P > const &point, tvec2< T, P > const &a, tvec2< T, P > const &b)</td></tr>
|
||||
<tr class="separator:gadc7010070bb0cacd284f560299b21660"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>Allow the measurement of the accuracy of a function against a reference implementation. </p>
|
||||
<p>This extension works on floating-point data and provide results in ULP. <<a class="el" href="a00137.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtc/ulp.hpp</a>> need to be included to use these features. </p>
|
||||
<p>Find the point on a straight line which is the closet of a point. </p>
|
||||
<p><<a class="el" href="a00010.html" title="GLM_GTX_closest_point ">glm/gtx/closest_point.hpp</a>> need to be included to use these functionalities. </p>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="ga2e09bd6c8b0a9c91f6f5683d68245634"></a>
|
||||
<a class="anchor" id="gac26353282a8213e469f5e33560c1200f"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL uint glm::float_distance </td>
|
||||
<td class="memname">GLM_FUNC_DECL tvec3<T, P> glm::closestPointOnLine </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">T const & </td>
|
||||
<td class="paramname"><em>x</em>, </td>
|
||||
<td class="paramtype">tvec3< T, P > const & </td>
|
||||
<td class="paramname"><em>point</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T const & </td>
|
||||
<td class="paramname"><em>y</em> </td>
|
||||
<td class="paramtype">tvec3< T, P > const & </td>
|
||||
<td class="paramname"><em>a</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">tvec3< T, P > const & </td>
|
||||
<td class="paramname"><em>b</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
@@ -92,133 +87,8 @@ Functions</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Return the distance in the number of ULP between 2 scalars. </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00183.html" title="Allow the measurement of the accuracy of a function against a reference implementation. ">GLM_GTC_ulp</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga85355f2549d75789eb66e5d565d8ad26"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL vecType<uint> glm::float_distance </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">vecType< T > const & </td>
|
||||
<td class="paramname"><em>x</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">vecType< T > const & </td>
|
||||
<td class="paramname"><em>y</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Return the distance in the number of ULP between 2 vectors. </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00183.html" title="Allow the measurement of the accuracy of a function against a reference implementation. ">GLM_GTC_ulp</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gae516ae554faa6117660828240e8bdaf0"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL genType glm::next_float </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>x</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Return the next ULP value(s) after the input value(s). </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00183.html" title="Allow the measurement of the accuracy of a function against a reference implementation. ">GLM_GTC_ulp</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gad107ec3d9697ef82032a33338a73ebdd"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL genType glm::next_float </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>x</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"><a class="el" href="a00164.html#ga91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> const & </td>
|
||||
<td class="paramname"><em>Distance</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Return the value(s) ULP distance after the input value(s). </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00183.html" title="Allow the measurement of the accuracy of a function against a reference implementation. ">GLM_GTC_ulp</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga2fcbb7bfbfc595712bfddc51b0715b07"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL genType glm::prev_float </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>x</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Return the previous ULP value(s) before the input value(s). </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00183.html" title="Allow the measurement of the accuracy of a function against a reference implementation. ">GLM_GTC_ulp</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gaa399d5b6472a70e8952f9b26ecaacdec"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL genType glm::prev_float </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>x</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"><a class="el" href="a00164.html#ga91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> const & </td>
|
||||
<td class="paramname"><em>Distance</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Return the value(s) ULP distance before the input value(s). </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00183.html" title="Allow the measurement of the accuracy of a function against a reference implementation. ">GLM_GTC_ulp</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="a00183.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>
|
||||
|
||||
Reference in New Issue
Block a user