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_orthonormalize</title>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GLM: GLM_GTX_extend</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,57 +41,42 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_orthonormalize</div> </div>
<div class="ingroups"><a class="el" href="a00139.html">GTX Extensions (Experimental)</a></div></div><!--header-->
<div class="title">GLM_GTX_extend<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:ga41553b39596f8e2633daa4b596044c95"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga41553b39596f8e2633daa4b596044c95"><td class="memTemplItemLeft" align="right" valign="top">detail::tmat3x3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00194.html#ga41553b39596f8e2633daa4b596044c95">orthonormalize</a> (const detail::tmat3x3&lt; T &gt; &amp;m)</td></tr>
<tr class="separator:ga41553b39596f8e2633daa4b596044c95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafcf2c8e15bcf91dcfcee7d0aa239d4f3"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gafcf2c8e15bcf91dcfcee7d0aa239d4f3"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00194.html#gafcf2c8e15bcf91dcfcee7d0aa239d4f3">orthonormalize</a> (const detail::tvec3&lt; T &gt; &amp;x, const detail::tvec3&lt; T &gt; &amp;y)</td></tr>
<tr class="separator:gafcf2c8e15bcf91dcfcee7d0aa239d4f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8140caae613b0f847ab0d7175dc03a37"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga8140caae613b0f847ab0d7175dc03a37"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00194.html#ga8140caae613b0f847ab0d7175dc03a37">extend</a> (genType const &amp;Origin, genType const &amp;Source, typename genType::value_type const Length)</td></tr>
<tr class="separator:ga8140caae613b0f847ab0d7175dc03a37"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Orthonormalize matrices. </p>
<p>&lt;<a class="el" href="a00071.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/orthonormalize.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>Extend a position from a source to a position at a defined length. </p>
<p>&lt;<a class="el" href="a00027.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/extend.hpp</a>&gt; need to be included to use these functionalities.</p>
<p>&lt;<a class="el" href="a00107.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/scalar_relational.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga41553b39596f8e2633daa4b596044c95"></a>
<a class="anchor" id="ga8140caae613b0f847ab0d7175dc03a37"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tmat3x3&lt;T&gt; glm::orthonormalize </td>
<td class="memname">GLM_FUNC_DECL genType glm::extend </td>
<td>(</td>
<td class="paramtype">const detail::tmat3x3&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the orthonormalized matrix of m. </p>
<p>From GLM_GTX_orthonormalize extension. </p>
</div>
</div>
<a class="anchor" id="gafcf2c8e15bcf91dcfcee7d0aa239d4f3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec3&lt;T&gt; glm::orthonormalize </td>
<td>(</td>
<td class="paramtype">const detail::tvec3&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>Origin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const detail::tvec3&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>y</em>&#160;</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">typename genType::value_type const&#160;</td>
<td class="paramname"><em>Length</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -95,8 +86,8 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Orthonormalizes x according y. </p>
<p>From GLM_GTX_orthonormalize extension. </p>
<p>Extends of Length the Origin position using the (Source - Origin) direction. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00194.html" title="Extend a position from a source to a position at a defined length. ">GLM_GTX_extend</a> </dd></dl>
</div>
</div>
@@ -105,7 +96,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>