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_transform_2d</title>
|
||||
<title>0.9.8: GLM_GTX_normalize_dot</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,116 +39,37 @@
|
||||
<div class="summary">
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">GLM_GTX_matrix_transform_2d<div class="ingroups"><a class="el" href="a00161.html">GTX Extensions (Experimental)</a></div></div> </div>
|
||||
<div class="title">GLM_GTX_normalize_dot<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: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="a00213.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="a00213.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="a00213.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="a00213.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="a00213.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>
|
||||
<tr class="memitem:ga8593b21bc2fe22184f01d5e08b5a2024"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr>
|
||||
<tr class="memitem:ga8593b21bc2fe22184f01d5e08b5a2024"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#ga8593b21bc2fe22184f01d5e08b5a2024">fastNormalizeDot</a> (vecType< T, P > const &x, vecType< T, P > const &y)</td></tr>
|
||||
<tr class="separator:ga8593b21bc2fe22184f01d5e08b5a2024"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gaffbc2f2cb15838de8886a68048f9004d"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr>
|
||||
<tr class="memitem:gaffbc2f2cb15838de8886a68048f9004d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00213.html#gaffbc2f2cb15838de8886a68048f9004d">normalizeDot</a> (vecType< T, P > const &x, vecType< T, P > const &y)</td></tr>
|
||||
<tr class="separator:gaffbc2f2cb15838de8886a68048f9004d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>Defines functions that generate common 2d transformation matrices. </p>
|
||||
<p><<a class="el" href="a00078.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/matrix_transform_2d.hpp</a>> need to be included to use these functionalities. </p>
|
||||
<p>Dot product of vectors that need to be normalize with a single square root. </p>
|
||||
<p><glm/gtx/normalized_dot.hpp> need to be included to use these functionalities. </p>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="gab4f798c6048db91a6d0686812fd54022"></a>
|
||||
<a class="anchor" id="ga8593b21bc2fe22184f01d5e08b5a2024"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_QUALIFIER tmat3x3<T, P> glm::rotate </td>
|
||||
<td class="memname">GLM_FUNC_DECL T glm::fastNormalizeDot </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">tmat3x3< T, P > const & </td>
|
||||
<td class="paramname"><em>m</em>, </td>
|
||||
<td class="paramtype">vecType< T, P > const & </td>
|
||||
<td class="paramname"><em>x</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T </td>
|
||||
<td class="paramname"><em>angle</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<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="ga5a608eaf1fdfd0a349a30181cb6a0240"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_QUALIFIER tmat3x3<T, P> glm::scale </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 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="ga3da9ea234fdb2a96c75a97a18c903489"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_QUALIFIER tmat3x3<T, P> glm::shearX </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="paramtype">vecType< T, P > const & </td>
|
||||
<td class="paramname"><em>y</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -159,32 +80,27 @@ Functions</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<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>
|
||||
<p>Normalize parameters and returns the dot product of x and y. </p>
|
||||
<p>Faster that dot(fastNormalize(x), fastNormalize(y)).</p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00213.html" title="Dot product of vectors that need to be normalize with a single square root. ">GLM_GTX_normalize_dot</a> extension. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga93bb348e7d251bcc2c17bfc11bd82e91"></a>
|
||||
<a class="anchor" id="gaffbc2f2cb15838de8886a68048f9004d"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_QUALIFIER tmat3x3<T, P> glm::shearY </td>
|
||||
<td class="memname">GLM_FUNC_DECL T glm::normalizeDot </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">tmat3x3< T, P > const & </td>
|
||||
<td class="paramname"><em>m</em>, </td>
|
||||
<td class="paramtype">vecType< T, P > const & </td>
|
||||
<td class="paramname"><em>x</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T </td>
|
||||
<td class="paramname"><em>x</em> </td>
|
||||
<td class="paramtype">vecType< T, P > const & </td>
|
||||
<td class="paramname"><em>y</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
@@ -194,49 +110,9 @@ Functions</h2></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>
|
||||
<p>Normalize parameters and returns the dot product of x and y. </p>
|
||||
<p>It's faster that dot(normalize(x), normalize(y)).</p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00213.html" title="Dot product of vectors that need to be normalize with a single square root. ">GLM_GTX_normalize_dot</a> extension. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user