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_GTX_matrix_interpolation</title>
|
||||
<title>0.9.8: GLM_GTX_matrix_transform_2d</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,49 +39,46 @@
|
||||
<div class="summary">
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">GLM_GTX_matrix_interpolation<div class="ingroups"><a class="el" href="a00161.html">GTX Extensions (Experimental)</a></div></div> </div>
|
||||
<div class="title">GLM_GTX_matrix_transform_2d<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:ga9aef292eb5f29bdbb58a53ef4281af92"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr>
|
||||
<tr class="memitem:ga9aef292eb5f29bdbb58a53ef4281af92"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#ga9aef292eb5f29bdbb58a53ef4281af92">axisAngle</a> (tmat4x4< T, P > const &mat, tvec3< T, P > &axis, T &angle)</td></tr>
|
||||
<tr class="separator:ga9aef292eb5f29bdbb58a53ef4281af92"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga82d4bc058e9628cb2ea1d4e117a0cf39"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr>
|
||||
<tr class="memitem:ga82d4bc058e9628cb2ea1d4e117a0cf39"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat4x4< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#ga82d4bc058e9628cb2ea1d4e117a0cf39">axisAngleMatrix</a> (tvec3< T, P > const &axis, T const angle)</td></tr>
|
||||
<tr class="separator:ga82d4bc058e9628cb2ea1d4e117a0cf39"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga6b8170aa4cf43caf81400696ebb38afe"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr>
|
||||
<tr class="memitem:ga6b8170aa4cf43caf81400696ebb38afe"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat4x4< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#ga6b8170aa4cf43caf81400696ebb38afe">extractMatrixRotation</a> (tmat4x4< T, P > const &mat)</td></tr>
|
||||
<tr class="separator:ga6b8170aa4cf43caf81400696ebb38afe"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga45099a92c5c704503565619ac2bcd5c6"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr>
|
||||
<tr class="memitem:ga45099a92c5c704503565619ac2bcd5c6"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat4x4< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#ga45099a92c5c704503565619ac2bcd5c6">interpolate</a> (tmat4x4< T, P > const &m1, tmat4x4< T, P > const &m2, T const delta)</td></tr>
|
||||
<tr class="separator:ga45099a92c5c704503565619ac2bcd5c6"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gab4f798c6048db91a6d0686812fd54022"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr>
|
||||
<tr class="memitem:gab4f798c6048db91a6d0686812fd54022"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER tmat3x3< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#gab4f798c6048db91a6d0686812fd54022">rotate</a> (tmat3x3< T, P > const &m, T angle)</td></tr>
|
||||
<tr class="separator:gab4f798c6048db91a6d0686812fd54022"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga5a608eaf1fdfd0a349a30181cb6a0240"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr>
|
||||
<tr class="memitem:ga5a608eaf1fdfd0a349a30181cb6a0240"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER tmat3x3< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#ga5a608eaf1fdfd0a349a30181cb6a0240">scale</a> (tmat3x3< T, P > const &m, tvec2< T, P > const &v)</td></tr>
|
||||
<tr class="separator:ga5a608eaf1fdfd0a349a30181cb6a0240"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga3da9ea234fdb2a96c75a97a18c903489"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr>
|
||||
<tr class="memitem:ga3da9ea234fdb2a96c75a97a18c903489"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER tmat3x3< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#ga3da9ea234fdb2a96c75a97a18c903489">shearX</a> (tmat3x3< T, P > const &m, T y)</td></tr>
|
||||
<tr class="separator:ga3da9ea234fdb2a96c75a97a18c903489"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga93bb348e7d251bcc2c17bfc11bd82e91"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr>
|
||||
<tr class="memitem:ga93bb348e7d251bcc2c17bfc11bd82e91"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER tmat3x3< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#ga93bb348e7d251bcc2c17bfc11bd82e91">shearY</a> (tmat3x3< T, P > const &m, T x)</td></tr>
|
||||
<tr class="separator:ga93bb348e7d251bcc2c17bfc11bd82e91"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga22b5e806a6d2e2be54ebd29100d11c51"><td class="memTemplParams" colspan="2">template<typename T , precision P> </td></tr>
|
||||
<tr class="memitem:ga22b5e806a6d2e2be54ebd29100d11c51"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER tmat3x3< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#ga22b5e806a6d2e2be54ebd29100d11c51">translate</a> (tmat3x3< T, P > const &m, tvec2< T, P > const &v)</td></tr>
|
||||
<tr class="separator:ga22b5e806a6d2e2be54ebd29100d11c51"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>Allows to directly interpolate two exiciting matrices. </p>
|
||||
<p><<a class="el" href="a00072.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/matrix_interpolation.hpp</a>> need to be included to use these functionalities. </p>
|
||||
<p>Defines functions that generate common 2d transformation matrices. </p>
|
||||
<p><<a class="el" href="a00071.html" title="GLM_GTX_matrix_transform_2d ">glm/gtx/matrix_transform_2d.hpp</a>> need to be included to use these functionalities. </p>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="ga9aef292eb5f29bdbb58a53ef4281af92"></a>
|
||||
<a class="anchor" id="gab4f798c6048db91a6d0686812fd54022"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL void glm::axisAngle </td>
|
||||
<td class="memname">GLM_FUNC_QUALIFIER tmat3x3<T, P> glm::rotate </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">tmat4x4< T, P > const & </td>
|
||||
<td class="paramname"><em>mat</em>, </td>
|
||||
<td class="paramtype">tmat3x3< T, P > const & </td>
|
||||
<td class="paramname"><em>m</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">tvec3< T, P > & </td>
|
||||
<td class="paramname"><em>axis</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T & </td>
|
||||
<td class="paramtype">T </td>
|
||||
<td class="paramname"><em>angle</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -92,26 +89,32 @@ Functions</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Get the axis and angle of the rotation from a matrix. </p>
|
||||
<p>From GLM_GTX_matrix_interpolation extension. </p>
|
||||
<p>Builds a rotation 3 * 3 matrix created from an angle. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">m</td><td>Input matrix multiplied by this translation matrix. </td></tr>
|
||||
<tr><td class="paramname">angle</td><td>Rotation angle expressed in radians if GLM_FORCE_RADIANS is defined or degrees otherwise. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga82d4bc058e9628cb2ea1d4e117a0cf39"></a>
|
||||
<a class="anchor" id="ga5a608eaf1fdfd0a349a30181cb6a0240"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL tmat4x4<T, P> glm::axisAngleMatrix </td>
|
||||
<td class="memname">GLM_FUNC_QUALIFIER tmat3x3<T, P> glm::scale </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">tvec3< T, P > const & </td>
|
||||
<td class="paramname"><em>axis</em>, </td>
|
||||
<td class="paramtype">tmat3x3< T, P > const & </td>
|
||||
<td class="paramname"><em>m</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T const </td>
|
||||
<td class="paramname"><em>angle</em> </td>
|
||||
<td class="paramtype">tvec2< T, P > const & </td>
|
||||
<td class="paramname"><em>v</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
@@ -121,51 +124,32 @@ Functions</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Build a matrix from axis and angle. </p>
|
||||
<p>From GLM_GTX_matrix_interpolation extension. </p>
|
||||
<p>Builds a scale 3 * 3 matrix created from a vector of 2 components. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">m</td><td>Input matrix multiplied by this translation matrix. </td></tr>
|
||||
<tr><td class="paramname">v</td><td>Coordinates of a scale vector. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga6b8170aa4cf43caf81400696ebb38afe"></a>
|
||||
<a class="anchor" id="ga3da9ea234fdb2a96c75a97a18c903489"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL tmat4x4<T, P> glm::extractMatrixRotation </td>
|
||||
<td class="memname">GLM_FUNC_QUALIFIER tmat3x3<T, P> glm::shearX </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">tmat4x4< T, P > const & </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="ga45099a92c5c704503565619ac2bcd5c6"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL tmat4x4<T, P> glm::interpolate </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">tmat4x4< T, P > const & </td>
|
||||
<td class="paramname"><em>m1</em>, </td>
|
||||
<td class="paramtype">tmat3x3< T, P > const & </td>
|
||||
<td class="paramname"><em>m</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">tmat4x4< T, P > const & </td>
|
||||
<td class="paramname"><em>m2</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T const </td>
|
||||
<td class="paramname"><em>delta</em> </td>
|
||||
<td class="paramtype">T </td>
|
||||
<td class="paramname"><em>y</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
@@ -175,8 +159,84 @@ Functions</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<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>
|
||||
<p>Builds an horizontal (parallel to the x axis) shear 3 * 3 matrix. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">m</td><td>Input matrix multiplied by this translation matrix. </td></tr>
|
||||
<tr><td class="paramname">y</td><td>Shear factor. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga93bb348e7d251bcc2c17bfc11bd82e91"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_QUALIFIER tmat3x3<T, P> glm::shearY </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">tmat3x3< T, P > const & </td>
|
||||
<td class="paramname"><em>m</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T </td>
|
||||
<td class="paramname"><em>x</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Builds a vertical (parallel to the y axis) shear 3 * 3 matrix. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">m</td><td>Input matrix multiplied by this translation matrix. </td></tr>
|
||||
<tr><td class="paramname">x</td><td>Shear factor. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga22b5e806a6d2e2be54ebd29100d11c51"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_QUALIFIER tmat3x3<T, P> glm::translate </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">tmat3x3< T, P > const & </td>
|
||||
<td class="paramname"><em>m</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">tvec2< T, P > const & </td>
|
||||
<td class="paramname"><em>v</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Builds a translation 3 * 3 matrix created from a vector of 2 components. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">m</td><td>Input matrix multiplied by this translation matrix. </td></tr>
|
||||
<tr><td class="paramname">v</td><td>Coordinates of a translation vector. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user