mewin/glm
1
0
Fork 0
Code Releases Activity

Updated doxygen for 0.9.6 API

Browse Source
This commit is contained in:
Christophe Riccio
2014-11-25 01:28:32 +01:00
parent c273be264c
commit 39334f282c
464 changed files with 68872 additions and 70562 deletions
Download Patch File Download Diff File Expand all files Collapse all files

319
doc/api/a00236.html
View File

@@ -3,8 +3,8 @@
<head>
<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.5"/>
<title>GLM: GLM_GTX_wrap</title>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>0.9.6: 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>
@@ -16,9 +16,9 @@
<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 id="projectname">0.9.6
</div>
</td>
</tr>
@@ -26,13 +26,11 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<!-- Generated by Doxygen 1.8.8 -->
<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>
@@ -41,80 +39,325 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_wrap<div class="ingroups"><a class="el" href="a00165.html">GTX Extensions (Experimental)</a></div></div> </div>
<div class="title">GLM_GTX_transform2<div class="ingroups"><a class="el" href="a00160.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:ga6c0cc6bd1d67ea1008d2592e998bad33"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga6c0cc6bd1d67ea1008d2592e998bad33"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00236.html#ga6c0cc6bd1d67ea1008d2592e998bad33">clamp</a> (genType const &amp;Texcoord)</td></tr>
<tr class="separator:ga6c0cc6bd1d67ea1008d2592e998bad33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga16a89b0661b60d5bea85137bbae74d73"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga16a89b0661b60d5bea85137bbae74d73"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00236.html#ga16a89b0661b60d5bea85137bbae74d73">mirrorRepeat</a> (genType const &amp;Texcoord)</td></tr>
<tr class="separator:ga16a89b0661b60d5bea85137bbae74d73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga809650c6310ea7c42666e918c117fb6f"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga809650c6310ea7c42666e918c117fb6f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00236.html#ga809650c6310ea7c42666e918c117fb6f">repeat</a> (genType const &amp;Texcoord)</td></tr>
<tr class="separator:ga809650c6310ea7c42666e918c117fb6f"><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="a00236.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="a00236.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="a00236.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="a00236.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="a00236.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="a00236.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="a00236.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="a00236.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="a00236.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>Wrapping mode of texture coordinates. </p>
<p>&lt;<a class="el" href="a00149.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/wrap.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>Add extra transformation matrices. </p>
<p>&lt;<a class="el" href="a00113.html" title="OpenGL Mathematics (glm.g-truc.net) ">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="ga6c0cc6bd1d67ea1008d2592e998bad33"></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::clamp </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>Texcoord</em></td><td>)</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">const tvec3&lt; T, P &gt; &amp;&#160;</td>
<td class="paramname"><em>normal</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Simulate GL_CLAMP OpenGL wrap mode. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00236.html" title="Wrapping mode of texture coordinates. ">GLM_GTX_wrap</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="ga16a89b0661b60d5bea85137bbae74d73"></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::mirrorRepeat </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>Texcoord</em></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">const tvec3&lt; T, P &gt; &amp;&#160;</td>
<td class="paramname"><em>normal</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Simulate GL_MIRROR_REPEAT OpenGL wrap mode. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00236.html" title="Wrapping mode of texture coordinates. ">GLM_GTX_wrap</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="ga809650c6310ea7c42666e918c117fb6f"></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::repeat </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>Texcoord</em></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>Simulate GL_REPEAT OpenGL wrap mode. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00236.html" title="Wrapping mode of texture coordinates. ">GLM_GTX_wrap</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>
@@ -123,7 +366,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.5
</a> 1.8.8
</small></address>
</body>
</html>