mewin/glm
1
0
Fork 0
Code Releases Activity

Updated API

Browse Source
This commit is contained in:
Christophe Riccio
2014-11-30 21:57:58 +01:00
parent a1e34d02ff
commit 6285ed64d3
385 changed files with 60361 additions and 60106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

336
doc/api/a00209.html
View File

@@ -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.8"/>
<title>0.9.6: GLM_GTX_matrix_operation</title>
<title>0.9.6: 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>
@@ -39,212 +39,204 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_matrix_operation<div class="ingroups"><a class="el" href="a00160.html">GTX Extensions (Experimental)</a></div></div> </div>
<div class="title">GLM_GTX_matrix_transform_2d<div class="ingroups"><a class="el" href="a00159.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:ga01dc503262dba9c457113d131fc8c024"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga01dc503262dba9c457113d131fc8c024"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat2x2&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#ga01dc503262dba9c457113d131fc8c024">diagonal2x2</a> (tvec2&lt; T, P &gt; const &amp;v)</td></tr>
<tr class="separator:ga01dc503262dba9c457113d131fc8c024"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga763817f07d6a94b722a48adfa87a35db"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga763817f07d6a94b722a48adfa87a35db"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat2x3&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#ga763817f07d6a94b722a48adfa87a35db">diagonal2x3</a> (tvec2&lt; T, P &gt; const &amp;v)</td></tr>
<tr class="separator:ga763817f07d6a94b722a48adfa87a35db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga49b37c819cf6dd8e35112ed1a13d45a3"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga49b37c819cf6dd8e35112ed1a13d45a3"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat2x4&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#ga49b37c819cf6dd8e35112ed1a13d45a3">diagonal2x4</a> (tvec2&lt; T, P &gt; const &amp;v)</td></tr>
<tr class="separator:ga49b37c819cf6dd8e35112ed1a13d45a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga586e1ced91fd8a7c414186a200f13532"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga586e1ced91fd8a7c414186a200f13532"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat3x2&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#ga586e1ced91fd8a7c414186a200f13532">diagonal3x2</a> (tvec2&lt; T, P &gt; const &amp;v)</td></tr>
<tr class="separator:ga586e1ced91fd8a7c414186a200f13532"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8e817dba22f2305cdebae07bbbe0360c"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga8e817dba22f2305cdebae07bbbe0360c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat3x3&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#ga8e817dba22f2305cdebae07bbbe0360c">diagonal3x3</a> (tvec3&lt; T, P &gt; const &amp;v)</td></tr>
<tr class="separator:ga8e817dba22f2305cdebae07bbbe0360c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae3f85af86c18c80f2acbe3223feb8e81"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gae3f85af86c18c80f2acbe3223feb8e81"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat3x4&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#gae3f85af86c18c80f2acbe3223feb8e81">diagonal3x4</a> (tvec3&lt; T, P &gt; const &amp;v)</td></tr>
<tr class="separator:gae3f85af86c18c80f2acbe3223feb8e81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga70cc5632aa9f41e7cf0b81fee6f2bfe6"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga70cc5632aa9f41e7cf0b81fee6f2bfe6"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat4x2&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#ga70cc5632aa9f41e7cf0b81fee6f2bfe6">diagonal4x2</a> (tvec2&lt; T, P &gt; const &amp;v)</td></tr>
<tr class="separator:ga70cc5632aa9f41e7cf0b81fee6f2bfe6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4242ea5681f81539e0c5b54fadcd9ddf"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga4242ea5681f81539e0c5b54fadcd9ddf"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat4x3&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#ga4242ea5681f81539e0c5b54fadcd9ddf">diagonal4x3</a> (tvec3&lt; T, P &gt; const &amp;v)</td></tr>
<tr class="separator:ga4242ea5681f81539e0c5b54fadcd9ddf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gade576e044d8e52f343166f665589d782"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gade576e044d8e52f343166f665589d782"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat4x4&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#gade576e044d8e52f343166f665589d782">diagonal4x4</a> (tvec4&lt; T, P &gt; const &amp;v)</td></tr>
<tr class="separator:gade576e044d8e52f343166f665589d782"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab4f798c6048db91a6d0686812fd54022"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gab4f798c6048db91a6d0686812fd54022"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER tmat3x3&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#gab4f798c6048db91a6d0686812fd54022">rotate</a> (tmat3x3&lt; T, P &gt; const &amp;m, T angle)</td></tr>
<tr class="separator:gab4f798c6048db91a6d0686812fd54022"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5a608eaf1fdfd0a349a30181cb6a0240"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga5a608eaf1fdfd0a349a30181cb6a0240"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER tmat3x3&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#ga5a608eaf1fdfd0a349a30181cb6a0240">scale</a> (tmat3x3&lt; T, P &gt; const &amp;m, tvec2&lt; T, P &gt; const &amp;v)</td></tr>
<tr class="separator:ga5a608eaf1fdfd0a349a30181cb6a0240"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3da9ea234fdb2a96c75a97a18c903489"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga3da9ea234fdb2a96c75a97a18c903489"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER tmat3x3&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#ga3da9ea234fdb2a96c75a97a18c903489">shearX</a> (tmat3x3&lt; T, P &gt; const &amp;m, T y)</td></tr>
<tr class="separator:ga3da9ea234fdb2a96c75a97a18c903489"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga93bb348e7d251bcc2c17bfc11bd82e91"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga93bb348e7d251bcc2c17bfc11bd82e91"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER tmat3x3&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#ga93bb348e7d251bcc2c17bfc11bd82e91">shearY</a> (tmat3x3&lt; T, P &gt; const &amp;m, T x)</td></tr>
<tr class="separator:ga93bb348e7d251bcc2c17bfc11bd82e91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga22b5e806a6d2e2be54ebd29100d11c51"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga22b5e806a6d2e2be54ebd29100d11c51"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER tmat3x3&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00209.html#ga22b5e806a6d2e2be54ebd29100d11c51">translate</a> (tmat3x3&lt; T, P &gt; const &amp;m, tvec2&lt; T, P &gt; const &amp;v)</td></tr>
<tr class="separator:ga22b5e806a6d2e2be54ebd29100d11c51"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Build diagonal matrices from vectors. </p>
<p>&lt;<a class="el" href="a00074.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/matrix_operation.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>Defines functions that generate common 2d transformation matrices. </p>
<p>&lt;<a class="el" href="a00076.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/matrix_transform_2d.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga01dc503262dba9c457113d131fc8c024"></a>
<a class="anchor" id="gab4f798c6048db91a6d0686812fd54022"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL tmat2x2&lt;T, P&gt; glm::diagonal2x2 </td>
<td class="memname">GLM_FUNC_QUALIFIER tmat3x3&lt;T, P&gt; glm::rotate </td>
<td>(</td>
<td class="paramtype">tmat3x3&lt; T, P &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>angle</em>&#160;</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&lt;T, P&gt; glm::scale </td>
<td>(</td>
<td class="paramtype">tmat3x3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">tvec2&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td class="paramname"><em>v</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Build a diagonal matrix. </p>
<p>From GLM_GTX_matrix_operation 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="ga763817f07d6a94b722a48adfa87a35db"></a>
<a class="anchor" id="ga3da9ea234fdb2a96c75a97a18c903489"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL tmat2x3&lt;T, P&gt; glm::diagonal2x3 </td>
<td class="memname">GLM_FUNC_QUALIFIER tmat3x3&lt;T, P&gt; glm::shearX </td>
<td>(</td>
<td class="paramtype">tmat3x3&lt; T, P &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>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&lt;T, P&gt; glm::shearY </td>
<td>(</td>
<td class="paramtype">tmat3x3&lt; T, P &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>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&lt;T, P&gt; glm::translate </td>
<td>(</td>
<td class="paramtype">tmat3x3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">tvec2&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
<td class="paramname"><em>v</em>&#160;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Build a diagonal matrix. </p>
<p>From GLM_GTX_matrix_operation extension. </p>
</div>
</div>
<a class="anchor" id="ga49b37c819cf6dd8e35112ed1a13d45a3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL tmat2x4&lt;T, P&gt; glm::diagonal2x4 </td>
<td>(</td>
<td class="paramtype">tvec2&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Build a diagonal matrix. </p>
<p>From GLM_GTX_matrix_operation extension. </p>
</div>
</div>
<a class="anchor" id="ga586e1ced91fd8a7c414186a200f13532"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL tmat3x2&lt;T, P&gt; glm::diagonal3x2 </td>
<td>(</td>
<td class="paramtype">tvec2&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Build a diagonal matrix. </p>
<p>From GLM_GTX_matrix_operation extension. </p>
</div>
</div>
<a class="anchor" id="ga8e817dba22f2305cdebae07bbbe0360c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL tmat3x3&lt;T, P&gt; glm::diagonal3x3 </td>
<td>(</td>
<td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Build a diagonal matrix. </p>
<p>From GLM_GTX_matrix_operation extension. </p>
</div>
</div>
<a class="anchor" id="gae3f85af86c18c80f2acbe3223feb8e81"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL tmat3x4&lt;T, P&gt; glm::diagonal3x4 </td>
<td>(</td>
<td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Build a diagonal matrix. </p>
<p>From GLM_GTX_matrix_operation extension. </p>
</div>
</div>
<a class="anchor" id="ga70cc5632aa9f41e7cf0b81fee6f2bfe6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL tmat4x2&lt;T, P&gt; glm::diagonal4x2 </td>
<td>(</td>
<td class="paramtype">tvec2&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Build a diagonal matrix. </p>
<p>From GLM_GTX_matrix_operation extension. </p>
</div>
</div>
<a class="anchor" id="ga4242ea5681f81539e0c5b54fadcd9ddf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL tmat4x3&lt;T, P&gt; glm::diagonal4x3 </td>
<td>(</td>
<td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Build a diagonal matrix. </p>
<p>From GLM_GTX_matrix_operation extension. </p>
</div>
</div>
<a class="anchor" id="gade576e044d8e52f343166f665589d782"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL tmat4x4&lt;T, P&gt; glm::diagonal4x4 </td>
<td>(</td>
<td class="paramtype">tvec4&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Build a diagonal matrix. </p>
<p>From GLM_GTX_matrix_operation extension. </p>
<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>