Updated doxygen documentation

This commit is contained in:
Christophe Riccio
2011-12-07 14:50:15 +00:00
parent a3b5034d4e
commit f18ad6bf2e
389 changed files with 27429 additions and 14460 deletions

View File

@@ -2,22 +2,36 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GLM_GTX_transform: Extented transformation matrices</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"></td>
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
@@ -32,39 +46,36 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>GLM_GTX_transform: Extented transformation matrices</h1> </div>
<div class="title">GLM_GTX_transform: Extented transformation matrices</div> </div>
<div class="ingroups"><a class="el" href="a00152.html">GTX Extensions (Experimental)</a></div></div>
<div class="contents">
<p>Add transformation matrices.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00220.html#ga26c0231870ad99b259cc1919bca4a8ee">rotate</a> (T angle, T x, T y, T z)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00220.html#ga5457db4563fa9c0195d4097f9e788617">rotate</a> (T angle, T x, T y, T z)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00220.html#gaf71419917ba9aee1120dcaf015e6b2cf">rotate</a> (T angle, detail::tvec3&lt; T &gt; const &amp;v)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00220.html#ga9a123708926335a4c097eee1157d4791">rotate</a> (T angle, detail::tvec3&lt; T &gt; const &amp;v)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00220.html#ga6382dc3286cf373ed2869b84aac41ad0">rotate</a> (detail::tmat4x4&lt; T &gt; const &amp;m, T angle, T x, T y, T z)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00220.html#ga3eed13fc5bcaff2f2204b12013bb83bf">rotate</a> (detail::tmat4x4&lt; T &gt; const &amp;m, T angle, T x, T y, T z)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00220.html#ga3f96fa1ec92cc61b73393515c5fa5e96">scale</a> (detail::tvec3&lt; T &gt; const &amp;v)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00220.html#ga7ffcdedf36bf2491505845f9d43276ae">scale</a> (T x, T y, T z)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00220.html#ga9767f84aefa391866b0947a256f3d3c9">scale</a> (detail::tmat4x4&lt; T &gt; const &amp;m, T x, T y, T z)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00220.html#ga0ce31189ca3aca6cadc306244af521f0">scale</a> (detail::tmat4x4&lt; T &gt; const &amp;m, T x, T y, T z)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00220.html#ga037adbd433d9cfaea0ad9b8b7f5a5267">scale</a> (T x, T y, T z)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00220.html#gad9b1d9ea9a64ba5e76dbe807abf8362c">scale</a> (detail::tvec3&lt; T &gt; const &amp;v)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00220.html#ga7416ff71fca0238e5a06013d53abfde3">translate</a> (detail::tmat4x4&lt; T &gt; const &amp;m, T x, T y, T z)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00220.html#ga353b66810f6788c6486197cb6a30248c">translate</a> (T x, T y, T z)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00220.html#ga3b0a5ec17d3e4327ec49415a4f7d13fb">translate</a> (T x, T y, T z)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00220.html#gaba8fdcaf3cbd37c131b2880116749273">translate</a> (detail::tmat4x4&lt; T &gt; const &amp;m, T x, T y, T z)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00220.html#gafd1edb755fac52c9ba9c20c95b8aa2e3">translate</a> (detail::tvec3&lt; T &gt; const &amp;v)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00220.html#gae65c5f45d880bf921b2af669b97a8fa8">translate</a> (detail::tvec3&lt; T &gt; const &amp;v)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Add transformation matrices. </p>
<p>&lt;<a class="el" href="a00105.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/transform.hpp</a>&gt; need to be included to use these functionalities. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga26c0231870ad99b259cc1919bca4a8ee"></a><!-- doxytag: member="glm::rotate" ref="ga26c0231870ad99b259cc1919bca4a8ee" args="(T angle, T x, T y, T z)" -->
<a class="anchor" id="ga5457db4563fa9c0195d4097f9e788617"></a><!-- doxytag: member="glm::rotate" ref="ga5457db4563fa9c0195d4097f9e788617" args="(T angle, T x, T y, T z)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -108,7 +119,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="gaf71419917ba9aee1120dcaf015e6b2cf"></a><!-- doxytag: member="glm::rotate" ref="gaf71419917ba9aee1120dcaf015e6b2cf" args="(T angle, detail::tvec3&lt; T &gt; const &amp;v)" -->
<a class="anchor" id="ga9a123708926335a4c097eee1157d4791"></a><!-- doxytag: member="glm::rotate" ref="ga9a123708926335a4c097eee1157d4791" args="(T angle, detail::tvec3&lt; T &gt; const &amp;v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -140,7 +151,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga6382dc3286cf373ed2869b84aac41ad0"></a><!-- doxytag: member="glm::rotate" ref="ga6382dc3286cf373ed2869b84aac41ad0" args="(detail::tmat4x4&lt; T &gt; const &amp;m, T angle, T x, T y, T z)" -->
<a class="anchor" id="ga3eed13fc5bcaff2f2204b12013bb83bf"></a><!-- doxytag: member="glm::rotate" ref="ga3eed13fc5bcaff2f2204b12013bb83bf" args="(detail::tmat4x4&lt; T &gt; const &amp;m, T angle, T x, T y, T z)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -190,29 +201,45 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga3f96fa1ec92cc61b73393515c5fa5e96"></a><!-- doxytag: member="glm::scale" ref="ga3f96fa1ec92cc61b73393515c5fa5e96" args="(detail::tvec3&lt; T &gt; const &amp;v)" -->
<a class="anchor" id="ga7ffcdedf36bf2491505845f9d43276ae"></a><!-- doxytag: member="glm::scale" ref="ga7ffcdedf36bf2491505845f9d43276ae" args="(T x, T y, T z)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tmat4x4&lt;T&gt; glm::scale </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>z</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Transforms a matrix with a scale 4 * 4 matrix created from a vector of 3 components. </p>
<p>Builds a scale 4 * 4 matrix created from 3 scalars. </p>
<ul>
<li>From <a class="el" href="a00220.html">GLM_GTX_transform </a> extension </li>
</ul>
</div>
</div>
<a class="anchor" id="ga9767f84aefa391866b0947a256f3d3c9"></a><!-- doxytag: member="glm::scale" ref="ga9767f84aefa391866b0947a256f3d3c9" args="(detail::tmat4x4&lt; T &gt; const &amp;m, T x, T y, T z)" -->
<a class="anchor" id="ga0ce31189ca3aca6cadc306244af521f0"></a><!-- doxytag: member="glm::scale" ref="ga0ce31189ca3aca6cadc306244af521f0" args="(detail::tmat4x4&lt; T &gt; const &amp;m, T x, T y, T z)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -256,13 +283,35 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga037adbd433d9cfaea0ad9b8b7f5a5267"></a><!-- doxytag: member="glm::scale" ref="ga037adbd433d9cfaea0ad9b8b7f5a5267" args="(T x, T y, T z)" -->
<a class="anchor" id="gad9b1d9ea9a64ba5e76dbe807abf8362c"></a><!-- doxytag: member="glm::scale" ref="gad9b1d9ea9a64ba5e76dbe807abf8362c" args="(detail::tvec3&lt; T &gt; const &amp;v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tmat4x4&lt;T&gt; glm::scale </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Transforms a matrix with a scale 4 * 4 matrix created from a vector of 3 components. </p>
<ul>
<li>From <a class="el" href="a00220.html">GLM_GTX_transform </a> extension </li>
</ul>
</div>
</div>
<a class="anchor" id="ga353b66810f6788c6486197cb6a30248c"></a><!-- doxytag: member="glm::translate" ref="ga353b66810f6788c6486197cb6a30248c" args="(T x, T y, T z)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tmat4x4&lt;T&gt; glm::translate </td>
<td>(</td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
@@ -287,14 +336,14 @@ Functions</h2></td></tr>
</div>
<div class="memdoc">
<p>Builds a scale 4 * 4 matrix created from 3 scalars. </p>
<p>Builds a translation 4 * 4 matrix created from 3 scalars. </p>
<ul>
<li>From <a class="el" href="a00220.html">GLM_GTX_transform </a> extension </li>
</ul>
</div>
</div>
<a class="anchor" id="ga7416ff71fca0238e5a06013d53abfde3"></a><!-- doxytag: member="glm::translate" ref="ga7416ff71fca0238e5a06013d53abfde3" args="(detail::tmat4x4&lt; T &gt; const &amp;m, T x, T y, T z)" -->
<a class="anchor" id="gaba8fdcaf3cbd37c131b2880116749273"></a><!-- doxytag: member="glm::translate" ref="gaba8fdcaf3cbd37c131b2880116749273" args="(detail::tmat4x4&lt; T &gt; const &amp;m, T x, T y, T z)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -338,45 +387,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga3b0a5ec17d3e4327ec49415a4f7d13fb"></a><!-- doxytag: member="glm::translate" ref="ga3b0a5ec17d3e4327ec49415a4f7d13fb" args="(T x, T y, T z)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tmat4x4&lt;T&gt; glm::translate </td>
<td>(</td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>z</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Builds a translation 4 * 4 matrix created from 3 scalars. </p>
<ul>
<li>From <a class="el" href="a00220.html">GLM_GTX_transform </a> extension </li>
</ul>
</div>
</div>
<a class="anchor" id="gafd1edb755fac52c9ba9c20c95b8aa2e3"></a><!-- doxytag: member="glm::translate" ref="gafd1edb755fac52c9ba9c20c95b8aa2e3" args="(detail::tvec3&lt; T &gt; const &amp;v)" -->
<a class="anchor" id="gae65c5f45d880bf921b2af669b97a8fa8"></a><!-- doxytag: member="glm::translate" ref="gae65c5f45d880bf921b2af669b97a8fa8" args="(detail::tvec3&lt; T &gt; const &amp;v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -399,8 +410,13 @@ Functions</h2></td></tr>
</div>
</div>
</div>
<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.7.3 </small></address>
<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.7.5
</small></address>
</body>
</html>