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_transform2</title>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GLM: GLM_GTX_matrix_interpolation</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,59 +41,50 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_transform2</div> </div>
<div class="ingroups"><a class="el" href="a00139.html">GTX Extensions (Experimental)</a></div></div><!--header-->
<div class="title">GLM_GTX_matrix_interpolation<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:ga63ac40786b580f12561cd69df85b62ab"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga63ac40786b580f12561cd69df85b62ab"><td class="memTemplItemLeft" align="right" valign="top">detail::tmat3x3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00207.html#ga63ac40786b580f12561cd69df85b62ab">proj2D</a> (const detail::tmat3x3&lt; T &gt; &amp;m, const detail::tvec3&lt; T &gt; &amp;normal)</td></tr>
<tr class="separator:ga63ac40786b580f12561cd69df85b62ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadd9c5431c89ba697f0fa0332c171a71e"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gadd9c5431c89ba697f0fa0332c171a71e"><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00207.html#gadd9c5431c89ba697f0fa0332c171a71e">proj3D</a> (const detail::tmat4x4&lt; T &gt; &amp;m, const detail::tvec3&lt; T &gt; &amp;normal)</td></tr>
<tr class="separator:gadd9c5431c89ba697f0fa0332c171a71e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga22a8d41efc320bcdee0ed09bad45f596"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
<tr class="memitem:ga22a8d41efc320bcdee0ed09bad45f596"><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00207.html#ga22a8d41efc320bcdee0ed09bad45f596">scaleBias</a> (valType scale, valType bias)</td></tr>
<tr class="separator:ga22a8d41efc320bcdee0ed09bad45f596"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga94ffe124f2d5425f0a517d9adbb88bdd"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
<tr class="memitem:ga94ffe124f2d5425f0a517d9adbb88bdd"><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00207.html#ga94ffe124f2d5425f0a517d9adbb88bdd">scaleBias</a> (detail::tmat4x4&lt; valType &gt; const &amp;m, valType scale, valType bias)</td></tr>
<tr class="separator:ga94ffe124f2d5425f0a517d9adbb88bdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadddd52c978f045f5f8dca53495b9ae61"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gadddd52c978f045f5f8dca53495b9ae61"><td class="memTemplItemLeft" align="right" valign="top">detail::tmat3x3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00207.html#gadddd52c978f045f5f8dca53495b9ae61">shearX2D</a> (detail::tmat3x3&lt; T &gt; const &amp;m, T y)</td></tr>
<tr class="separator:gadddd52c978f045f5f8dca53495b9ae61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gada3d1377736da971fd1d33b5749d4dd3"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gada3d1377736da971fd1d33b5749d4dd3"><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00207.html#gada3d1377736da971fd1d33b5749d4dd3">shearX3D</a> (const detail::tmat4x4&lt; T &gt; &amp;m, T y, T z)</td></tr>
<tr class="separator:gada3d1377736da971fd1d33b5749d4dd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad6911c0aa16802530d2344633074d23c"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gad6911c0aa16802530d2344633074d23c"><td class="memTemplItemLeft" align="right" valign="top">detail::tmat3x3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00207.html#gad6911c0aa16802530d2344633074d23c">shearY2D</a> (detail::tmat3x3&lt; T &gt; const &amp;m, T x)</td></tr>
<tr class="separator:gad6911c0aa16802530d2344633074d23c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga48f777ba390f40b93c2b0ace7523bbdf"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga48f777ba390f40b93c2b0ace7523bbdf"><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00207.html#ga48f777ba390f40b93c2b0ace7523bbdf">shearY3D</a> (const detail::tmat4x4&lt; T &gt; &amp;m, T x, T z)</td></tr>
<tr class="separator:ga48f777ba390f40b93c2b0ace7523bbdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9e8ec50d810af7f3da402ef120b37e3f"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga9e8ec50d810af7f3da402ef120b37e3f"><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00207.html#ga9e8ec50d810af7f3da402ef120b37e3f">shearZ3D</a> (const detail::tmat4x4&lt; T &gt; &amp;m, T x, T y)</td></tr>
<tr class="separator:ga9e8ec50d810af7f3da402ef120b37e3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6b76b95383a720b763a0bf12b9691e3a"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga6b76b95383a720b763a0bf12b9691e3a"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00207.html#ga6b76b95383a720b763a0bf12b9691e3a">axisAngle</a> (detail::tmat4x4&lt; T, P &gt; const &amp;mat, detail::tvec3&lt; T, P &gt; &amp;axis, T &amp;angle)</td></tr>
<tr class="separator:ga6b76b95383a720b763a0bf12b9691e3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaffcc7a788548911bea4e8a7bec9aa69d"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gaffcc7a788548911bea4e8a7bec9aa69d"><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00207.html#gaffcc7a788548911bea4e8a7bec9aa69d">axisAngleMatrix</a> (detail::tvec3&lt; T, P &gt; const &amp;axis, T const angle)</td></tr>
<tr class="separator:gaffcc7a788548911bea4e8a7bec9aa69d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4aeb9c402514dfd9c6d2e8ca73d07f30"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga4aeb9c402514dfd9c6d2e8ca73d07f30"><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00207.html#ga4aeb9c402514dfd9c6d2e8ca73d07f30">extractMatrixRotation</a> (detail::tmat4x4&lt; T, P &gt; const &amp;mat)</td></tr>
<tr class="separator:ga4aeb9c402514dfd9c6d2e8ca73d07f30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga26fcd9ab0660c54a19d5edec727d1dab"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga26fcd9ab0660c54a19d5edec727d1dab"><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00207.html#ga26fcd9ab0660c54a19d5edec727d1dab">interpolate</a> (detail::tmat4x4&lt; T, P &gt; const &amp;m1, detail::tmat4x4&lt; T, P &gt; const &amp;m2, T const delta)</td></tr>
<tr class="separator:ga26fcd9ab0660c54a19d5edec727d1dab"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Add extra transformation matrices. </p>
<p>&lt;<a class="el" href="a00092.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/transform2.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>Allows to directly interpolate two exiciting matrices. </p>
<p>&lt;<a class="el" href="a00075.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/matrix_interpolation.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga63ac40786b580f12561cd69df85b62ab"></a>
<a class="anchor" id="ga6b76b95383a720b763a0bf12b9691e3a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tmat3x3&lt;T&gt; glm::proj2D </td>
<td class="memname">void glm::axisAngle </td>
<td>(</td>
<td class="paramtype">const detail::tmat3x3&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
<td class="paramtype">detail::tmat4x4&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>mat</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>normal</em>&#160;</td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; &amp;&#160;</td>
<td class="paramname"><em>axis</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T &amp;&#160;</td>
<td class="paramname"><em>angle</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -97,26 +94,26 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Build planar projection matrix along normal axis. </p>
<p>From GLM_GTX_transform2 extension. </p>
<p>Get the axis and angle of the rotation from a matrix. </p>
<p>From GLM_GTX_matrix_interpolation extension. </p>
</div>
</div>
<a class="anchor" id="gadd9c5431c89ba697f0fa0332c171a71e"></a>
<a class="anchor" id="gaffcc7a788548911bea4e8a7bec9aa69d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tmat4x4&lt;T&gt; glm::proj3D </td>
<td class="memname">detail::tmat4x4&lt;T, P&gt; glm::axisAngleMatrix </td>
<td>(</td>
<td class="paramtype">const detail::tmat4x4&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>axis</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>normal</em>&#160;</td>
<td class="paramtype">T const&#160;</td>
<td class="paramname"><em>angle</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -126,26 +123,51 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Build planar projection matrix along normal axis. </p>
<p>From GLM_GTX_transform2 extension. </p>
<p>Build a matrix from axis and angle. </p>
<p>From GLM_GTX_matrix_interpolation extension. </p>
</div>
</div>
<a class="anchor" id="ga22a8d41efc320bcdee0ed09bad45f596"></a>
<a class="anchor" id="ga4aeb9c402514dfd9c6d2e8ca73d07f30"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tmat4x4&lt;valType&gt; glm::scaleBias </td>
<td class="memname">detail::tmat4x4&lt;T, P&gt; glm::extractMatrixRotation </td>
<td>(</td>
<td class="paramtype">valType&#160;</td>
<td class="paramname"><em>scale</em>, </td>
<td class="paramtype">detail::tmat4x4&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>mat</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts the rotation part of a matrix. </p>
<p>From GLM_GTX_matrix_interpolation extension. </p>
</div>
</div>
<a class="anchor" id="ga26fcd9ab0660c54a19d5edec727d1dab"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tmat4x4&lt;T, P&gt; glm::interpolate </td>
<td>(</td>
<td class="paramtype">detail::tmat4x4&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>m1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">valType&#160;</td>
<td class="paramname"><em>bias</em>&#160;</td>
<td class="paramtype">detail::tmat4x4&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>m2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const&#160;</td>
<td class="paramname"><em>delta</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -155,205 +177,8 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Build a scale bias matrix. </p>
<p>From GLM_GTX_transform2 extension. </p>
</div>
</div>
<a class="anchor" id="ga94ffe124f2d5425f0a517d9adbb88bdd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tmat4x4&lt;valType&gt; glm::scaleBias </td>
<td>(</td>
<td class="paramtype">detail::tmat4x4&lt; valType &gt; const &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">valType&#160;</td>
<td class="paramname"><em>scale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">valType&#160;</td>
<td class="paramname"><em>bias</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Build a scale bias matrix. </p>
<p>From GLM_GTX_transform2 extension. </p>
</div>
</div>
<a class="anchor" id="gadddd52c978f045f5f8dca53495b9ae61"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tmat3x3&lt;T&gt; glm::shearX2D </td>
<td>(</td>
<td class="paramtype">detail::tmat3x3&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>y</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 shearing on X axis. </p>
<p>From GLM_GTX_transform2 extension. </p>
</div>
</div>
<a class="anchor" id="gada3d1377736da971fd1d33b5749d4dd3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tmat4x4&lt;T&gt; glm::shearX3D </td>
<td>(</td>
<td class="paramtype">const detail::tmat4x4&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>m</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 shearing on X axis From GLM_GTX_transform2 extension. </p>
</div>
</div>
<a class="anchor" id="gad6911c0aa16802530d2344633074d23c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tmat3x3&lt;T&gt; glm::shearY2D </td>
<td>(</td>
<td class="paramtype">detail::tmat3x3&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>x</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 shearing on Y axis. </p>
<p>From GLM_GTX_transform2 extension. </p>
</div>
</div>
<a class="anchor" id="ga48f777ba390f40b93c2b0ace7523bbdf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tmat4x4&lt;T&gt; glm::shearY3D </td>
<td>(</td>
<td class="paramtype">const detail::tmat4x4&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>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 shearing on Y axis. </p>
<p>From GLM_GTX_transform2 extension. </p>
</div>
</div>
<a class="anchor" id="ga9e8ec50d810af7f3da402ef120b37e3f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tmat4x4&lt;T&gt; glm::shearZ3D </td>
<td>(</td>
<td class="paramtype">const detail::tmat4x4&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Transforms a matrix with a shearing on Z axis. </p>
<p>From GLM_GTX_transform2 extension. </p>
<p>Build a interpolation of 4 * 4 matrixes. </p>
<p>From GLM_GTX_matrix_interpolation extension. Warning! works only with rotation and/or translation matrixes, scale will generate unexpected results. </p>
</div>
</div>
@@ -362,7 +187,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>