Updated API documentation

This commit is contained in:
Christophe Riccio
2013-12-25 23:48:55 +01:00
parent 792e5ff74f
commit fee3eddd37
459 changed files with 76100 additions and 48806 deletions

View File

@@ -3,7 +3,8 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>GLM_GTX_multiple</title>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GLM: 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>
@@ -15,18 +16,23 @@
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">GLM
&#160;<span id="projectnumber">0.9.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
@@ -35,38 +41,41 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_multiple</div> </div>
<div class="ingroups"><a class="el" href="a00139.html">GTX Extensions (Experimental)</a></div></div><!--header-->
<div class="title">GLM_GTX_closest_point<div class="ingroups"><a class="el" href="a00165.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:gaf83b1250f84ae5264a4c7df0a7f70b07"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gaf83b1250f84ae5264a4c7df0a7f70b07"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00187.html#gaf83b1250f84ae5264a4c7df0a7f70b07">higherMultiple</a> (genType const &amp;Source, genType const &amp;Multiple)</td></tr>
<tr class="separator:gaf83b1250f84ae5264a4c7df0a7f70b07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf3d38b5e3b560ad6245c33a1484c96e2"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gaf3d38b5e3b560ad6245c33a1484c96e2"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00187.html#gaf3d38b5e3b560ad6245c33a1484c96e2">lowerMultiple</a> (genType const &amp;Source, genType const &amp;Multiple)</td></tr>
<tr class="separator:gaf3d38b5e3b560ad6245c33a1484c96e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacc21a3c0b65c81909f36d23a52e00db4"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gacc21a3c0b65c81909f36d23a52e00db4"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00187.html#gacc21a3c0b65c81909f36d23a52e00db4">closestPointOnLine</a> (detail::tvec3&lt; T, P &gt; const &amp;point, detail::tvec3&lt; T, P &gt; const &amp;a, detail::tvec3&lt; T, P &gt; const &amp;b)</td></tr>
<tr class="separator:gacc21a3c0b65c81909f36d23a52e00db4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Find the closest number of a number multiple of other number. </p>
<p>&lt;<a class="el" href="a00062.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/multiple.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="a00013_source.html">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="gaf83b1250f84ae5264a4c7df0a7f70b07"></a>
<a class="anchor" id="gacc21a3c0b65c81909f36d23a52e00db4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType glm::higherMultiple </td>
<td class="memname">detail::tvec3&lt;T, P&gt; glm::closestPointOnLine </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>Source</em>, </td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>point</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>Multiple</em>&#160;</td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>b</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -76,37 +85,8 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Higher Multiple number of Source. </p>
<p>From GLM_GTX_multiple extension. </p>
</div>
</div>
<a class="anchor" id="gaf3d38b5e3b560ad6245c33a1484c96e2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType glm::lowerMultiple </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>Source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>Multiple</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Lower Multiple number of Source. </p>
<p>From GLM_GTX_multiple extension. </p>
<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="a00187.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>
@@ -115,7 +95,7 @@ Functions</h2></td></tr>
<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.2
</a> 1.8.5
</small></address>
</body>
</html>