mewin/glm
1
0
Fork 0
Code Releases Activity

Updated API documentation

Browse Source
This commit is contained in:
Christophe Riccio
2016-09-11 12:44:33 +02:00
parent 9f0110f5b0
commit 454d480ceb
395 changed files with 58950 additions and 58068 deletions
Download Patch File Download Diff File Expand all files Collapse all files

345
doc/api/a00233.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.10"/>
<title>0.9.7: GLM_GTX_spline</title>
<title>0.9.8: GLM_GTX_transform2</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,59 +39,59 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_spline<div class="ingroups"><a class="el" href="a00161.html">GTX Extensions (Experimental)</a></div></div> </div>
<div class="title">GLM_GTX_transform2<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:ga8119c04f8210fd0d292757565cd6918d"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga8119c04f8210fd0d292757565cd6918d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00233.html#ga8119c04f8210fd0d292757565cd6918d">catmullRom</a> (genType const &amp;v1, genType const &amp;v2, genType const &amp;v3, genType const &amp;v4, typename genType::value_type const &amp;s)</td></tr>
<tr class="separator:ga8119c04f8210fd0d292757565cd6918d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6b867eb52e2fc933d2e0bf26aabc9a70"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga6b867eb52e2fc933d2e0bf26aabc9a70"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00233.html#ga6b867eb52e2fc933d2e0bf26aabc9a70">cubic</a> (genType const &amp;v1, genType const &amp;v2, genType const &amp;v3, genType const &amp;v4, typename genType::value_type const &amp;s)</td></tr>
<tr class="separator:ga6b867eb52e2fc933d2e0bf26aabc9a70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa69e143f6374d32f934a8edeaa50bac9"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gaa69e143f6374d32f934a8edeaa50bac9"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00233.html#gaa69e143f6374d32f934a8edeaa50bac9">hermite</a> (genType const &amp;v1, genType const &amp;t1, genType const &amp;v2, genType const &amp;t2, typename genType::value_type const &amp;s)</td></tr>
<tr class="separator:gaa69e143f6374d32f934a8edeaa50bac9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacfce1085167a8bfb71a55ea14d22752f"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gacfce1085167a8bfb71a55ea14d22752f"><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="a00233.html#gacfce1085167a8bfb71a55ea14d22752f">proj2D</a> (const tmat3x3&lt; T, P &gt; &amp;m, const tvec3&lt; T, P &gt; &amp;normal)</td></tr>
<tr class="separator:gacfce1085167a8bfb71a55ea14d22752f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafab0418f2503ec2133cb2de828cc482a"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gafab0418f2503ec2133cb2de828cc482a"><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="a00233.html#gafab0418f2503ec2133cb2de828cc482a">proj3D</a> (const tmat4x4&lt; T, P &gt; &amp;m, const tvec3&lt; T, P &gt; &amp;normal)</td></tr>
<tr class="separator:gafab0418f2503ec2133cb2de828cc482a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2874abd228989556d610a0bff993667a"><td class="memTemplParams" colspan="2">template&lt;typename valType , precision P&gt; </td></tr>
<tr class="memitem:ga2874abd228989556d610a0bff993667a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat4x4&lt; valType, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00233.html#ga2874abd228989556d610a0bff993667a">scaleBias</a> (valType scale, valType bias)</td></tr>
<tr class="separator:ga2874abd228989556d610a0bff993667a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac1a1139e2980021422d1fc1c42dc74f2"><td class="memTemplParams" colspan="2">template&lt;typename valType , precision P&gt; </td></tr>
<tr class="memitem:gac1a1139e2980021422d1fc1c42dc74f2"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat4x4&lt; valType, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00233.html#gac1a1139e2980021422d1fc1c42dc74f2">scaleBias</a> (tmat4x4&lt; valType, P &gt; const &amp;m, valType scale, valType bias)</td></tr>
<tr class="separator:gac1a1139e2980021422d1fc1c42dc74f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga10f6c62d8f827c4cacedb71fd05e4ba2"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga10f6c62d8f827c4cacedb71fd05e4ba2"><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="a00233.html#ga10f6c62d8f827c4cacedb71fd05e4ba2">shearX2D</a> (tmat3x3&lt; T, P &gt; const &amp;m, T y)</td></tr>
<tr class="separator:ga10f6c62d8f827c4cacedb71fd05e4ba2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae06ce274e4754f925d5d68440e89452e"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gae06ce274e4754f925d5d68440e89452e"><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="a00233.html#gae06ce274e4754f925d5d68440e89452e">shearX3D</a> (const tmat4x4&lt; T, P &gt; &amp;m, T y, T z)</td></tr>
<tr class="separator:gae06ce274e4754f925d5d68440e89452e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga21ade82859e09a5cdaf4a01fbf8dc61b"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga21ade82859e09a5cdaf4a01fbf8dc61b"><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="a00233.html#ga21ade82859e09a5cdaf4a01fbf8dc61b">shearY2D</a> (tmat3x3&lt; T, P &gt; const &amp;m, T x)</td></tr>
<tr class="separator:ga21ade82859e09a5cdaf4a01fbf8dc61b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga31253ea18fdcdfde08c134c8b67688f7"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga31253ea18fdcdfde08c134c8b67688f7"><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="a00233.html#ga31253ea18fdcdfde08c134c8b67688f7">shearY3D</a> (const tmat4x4&lt; T, P &gt; &amp;m, T x, T z)</td></tr>
<tr class="separator:ga31253ea18fdcdfde08c134c8b67688f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5558ac64a7144685bf2eb4483a0e2f51"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:ga5558ac64a7144685bf2eb4483a0e2f51"><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="a00233.html#ga5558ac64a7144685bf2eb4483a0e2f51">shearZ3D</a> (const tmat4x4&lt; T, P &gt; &amp;m, T x, T y)</td></tr>
<tr class="separator:ga5558ac64a7144685bf2eb4483a0e2f51"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Spline functions. </p>
<p>&lt;<a class="el" href="a00109.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/spline.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>Add extra transformation matrices. </p>
<p>&lt;<a class="el" href="a00106.html" title="GLM_GTX_transform2 ">glm/gtx/transform2.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga8119c04f8210fd0d292757565cd6918d"></a>
<a class="anchor" id="gacfce1085167a8bfb71a55ea14d22752f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::catmullRom </td>
<td class="memname">GLM_FUNC_DECL tmat3x3&lt;T, P&gt; glm::proj2D </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v1</em>, </td>
<td class="paramtype">const tmat3x3&lt; T, P &gt; &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v3</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v4</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename genType::value_type const &amp;&#160;</td>
<td class="paramname"><em>s</em>&#160;</td>
<td class="paramtype">const tvec3&lt; T, P &gt; &amp;&#160;</td>
<td class="paramname"><em>normal</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -101,44 +101,26 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Return a point from a catmull rom curve. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00233.html" title="Spline functions. ">GLM_GTX_spline</a> extension. </dd></dl>
<p>Build planar projection matrix along normal axis. </p>
<p>From GLM_GTX_transform2 extension. </p>
</div>
</div>
<a class="anchor" id="ga6b867eb52e2fc933d2e0bf26aabc9a70"></a>
<a class="anchor" id="gafab0418f2503ec2133cb2de828cc482a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::cubic </td>
<td class="memname">GLM_FUNC_DECL tmat4x4&lt;T, P&gt; glm::proj3D </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v1</em>, </td>
<td class="paramtype">const tmat4x4&lt; T, P &gt; &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v3</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v4</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename genType::value_type const &amp;&#160;</td>
<td class="paramname"><em>s</em>&#160;</td>
<td class="paramtype">const tvec3&lt; T, P &gt; &amp;&#160;</td>
<td class="paramname"><em>normal</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -148,44 +130,26 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Return a point from a cubic curve. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00233.html" title="Spline functions. ">GLM_GTX_spline</a> extension. </dd></dl>
<p>Build planar projection matrix along normal axis. </p>
<p>From GLM_GTX_transform2 extension. </p>
</div>
</div>
<a class="anchor" id="gaa69e143f6374d32f934a8edeaa50bac9"></a>
<a class="anchor" id="ga2874abd228989556d610a0bff993667a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::hermite </td>
<td class="memname">GLM_FUNC_DECL tmat4x4&lt;valType, P&gt; glm::scaleBias </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v1</em>, </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">genType const &amp;&#160;</td>
<td class="paramname"><em>t1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>t2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename genType::value_type const &amp;&#160;</td>
<td class="paramname"><em>s</em>&#160;</td>
<td class="paramtype">valType&#160;</td>
<td class="paramname"><em>bias</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -195,8 +159,205 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Return a point from a hermite curve. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00233.html" title="Spline functions. ">GLM_GTX_spline</a> extension. </dd></dl>
<p>Build a scale bias matrix. </p>
<p>From GLM_GTX_transform2 extension. </p>
</div>
</div>
<a class="anchor" id="gac1a1139e2980021422d1fc1c42dc74f2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL tmat4x4&lt;valType, P&gt; glm::scaleBias </td>
<td>(</td>
<td class="paramtype">tmat4x4&lt; valType, P &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="ga10f6c62d8f827c4cacedb71fd05e4ba2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL tmat3x3&lt;T, P&gt; glm::shearX2D </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>Transforms a matrix with a shearing on X axis. </p>
<p>From GLM_GTX_transform2 extension. </p>
</div>
</div>
<a class="anchor" id="gae06ce274e4754f925d5d68440e89452e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL tmat4x4&lt;T, P&gt; glm::shearX3D </td>
<td>(</td>
<td class="paramtype">const tmat4x4&lt; T, P &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="ga21ade82859e09a5cdaf4a01fbf8dc61b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL tmat3x3&lt;T, P&gt; glm::shearY2D </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>Transforms a matrix with a shearing on Y axis. </p>
<p>From GLM_GTX_transform2 extension. </p>
</div>
</div>
<a class="anchor" id="ga31253ea18fdcdfde08c134c8b67688f7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL tmat4x4&lt;T, P&gt; glm::shearY3D </td>
<td>(</td>
<td class="paramtype">const tmat4x4&lt; T, P &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="ga5558ac64a7144685bf2eb4483a0e2f51"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL tmat4x4&lt;T, P&gt; glm::shearZ3D </td>
<td>(</td>
<td class="paramtype">const tmat4x4&lt; T, P &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>
</div>
</div>