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

130
doc/api/a00154.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: Matrix functions</title>
<title>0.9.6: Noise functions</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,165 +39,137 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Matrix functions<div class="ingroups"><a class="el" href="a00161.html">GLM Core</a></div></div> </div>
<div class="title">Noise functions<div class="ingroups"><a class="el" href="a00160.html">GLM Core</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:ga26ea77c574802bc6fc193c40478718d2"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class matType&gt; </td></tr>
<tr class="memitem:ga26ea77c574802bc6fc193c40478718d2"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00154.html#ga26ea77c574802bc6fc193c40478718d2">determinant</a> (matType&lt; T, P &gt; const &amp;m)</td></tr>
<tr class="separator:ga26ea77c574802bc6fc193c40478718d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7635d3dbe5aa10ff73a0e6903bf6bea5"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class matType&gt; </td></tr>
<tr class="memitem:ga7635d3dbe5aa10ff73a0e6903bf6bea5"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL matType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00154.html#ga7635d3dbe5aa10ff73a0e6903bf6bea5">inverse</a> (matType&lt; T, P &gt; const &amp;m)</td></tr>
<tr class="separator:ga7635d3dbe5aa10ff73a0e6903bf6bea5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4a54992e4741188ee624b21e3ba91814"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class matType&gt; </td></tr>
<tr class="memitem:ga4a54992e4741188ee624b21e3ba91814"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL matType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00154.html#ga4a54992e4741188ee624b21e3ba91814">matrixCompMult</a> (matType&lt; T, P &gt; const &amp;x, matType&lt; T, P &gt; const &amp;y)</td></tr>
<tr class="separator:ga4a54992e4741188ee624b21e3ba91814"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae9f513dc8e4f3ceb993669321b6d0f09"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecTypeA, template&lt; typename, precision &gt; class vecTypeB&gt; </td></tr>
<tr class="memitem:gae9f513dc8e4f3ceb993669321b6d0f09"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL <br class="typebreak" />
detail::outerProduct_trait&lt; T, <br class="typebreak" />
P, vecTypeA, vecTypeB &gt;::type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00154.html#gae9f513dc8e4f3ceb993669321b6d0f09">outerProduct</a> (vecTypeA&lt; T, P &gt; const &amp;c, vecTypeB&lt; T, P &gt; const &amp;r)</td></tr>
<tr class="separator:gae9f513dc8e4f3ceb993669321b6d0f09"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadcbf14e3390990f33fda02bb20836960"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gadcbf14e3390990f33fda02bb20836960"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00154.html#gadcbf14e3390990f33fda02bb20836960">noise1</a> (genType const &amp;x)</td></tr>
<tr class="separator:gadcbf14e3390990f33fda02bb20836960"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad88de7f308dc57edb80690373a1380a9"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gad88de7f308dc57edb80690373a1380a9"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec2&lt; typename <br class="typebreak" />
genType::value_type, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00154.html#gad88de7f308dc57edb80690373a1380a9">noise2</a> (genType const &amp;x)</td></tr>
<tr class="separator:gad88de7f308dc57edb80690373a1380a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3359a5e2b61cee8cf4498470a63f7283"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga3359a5e2b61cee8cf4498470a63f7283"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec3&lt; typename <br class="typebreak" />
genType::value_type, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00154.html#ga3359a5e2b61cee8cf4498470a63f7283">noise3</a> (genType const &amp;x)</td></tr>
<tr class="separator:ga3359a5e2b61cee8cf4498470a63f7283"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaed96a491dd0c552040d59f9178bc626d"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gaed96a491dd0c552040d59f9178bc626d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec4&lt; typename <br class="typebreak" />
genType::value_type, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00154.html#gaed96a491dd0c552040d59f9178bc626d">noise4</a> (genType const &amp;x)</td></tr>
<tr class="separator:gaed96a491dd0c552040d59f9178bc626d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>For each of the following built-in matrix functions, there is both a single-precision floating point version, where all arguments and return values are single precision, and a double-precision floating version, where all arguments and return values are double precision. </p>
<p>Only the single-precision floating point version is shown. </p>
<p>Noise functions are stochastic functions that can be used to increase visual complexity. </p>
<p>Values returned by the following noise functions give the appearance of randomness, but are not truly random. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga26ea77c574802bc6fc193c40478718d2"></a>
<a class="anchor" id="gadcbf14e3390990f33fda02bb20836960"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL T glm::determinant </td>
<td class="memname">GLM_FUNC_DECL genType::value_type glm::noise1 </td>
<td>(</td>
<td class="paramtype">matType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>m</em></td><td>)</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the transposed matrix of x. </p>
<p>Returns a 1D noise value based on the input value x. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">matType</td><td>Floating-point matrix types.</td></tr>
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/transpose.xml">GLSL transpose man page</a> </dd>
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/noise1.xml">GLSL noise1 man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> Return the determinant of a squared matrix.</dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">valType</td><td>Floating-point scalar types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/determinant.xml">GLSL determinant man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> </dd></dl>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.13 Noise Functions</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga7635d3dbe5aa10ff73a0e6903bf6bea5"></a>
<a class="anchor" id="gad88de7f308dc57edb80690373a1380a9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL matType&lt;T, P&gt; glm::inverse </td>
<td class="memname">GLM_FUNC_DECL tvec2&lt;typename genType::value_type, defaultp&gt; glm::noise2 </td>
<td>(</td>
<td class="paramtype">matType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>m</em></td><td>)</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the inverse of a squared matrix. </p>
<p>Returns a 2D noise value based on the input value x. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">valType</td><td>Floating-point scalar types.</td></tr>
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/inverse.xml">GLSL inverse man page</a> </dd>
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/noise2.xml">GLSL noise2 man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> </dd></dl>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.13 Noise Functions</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga4a54992e4741188ee624b21e3ba91814"></a>
<a class="anchor" id="ga3359a5e2b61cee8cf4498470a63f7283"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL matType&lt;T, P&gt; glm::matrixCompMult </td>
<td class="memname">GLM_FUNC_DECL tvec3&lt;typename genType::value_type, defaultp&gt; glm::noise3 </td>
<td>(</td>
<td class="paramtype">matType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
<td class="paramtype">matType&lt; T, P &gt; const &amp;&#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>Multiply matrix x by matrix y component-wise, i.e., result[i][j] is the scalar product of x[i][j] and y[i][j]. </p>
<p>Returns a 3D noise value based on the input value x. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">matType</td><td>Floating-point matrix types.</td></tr>
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/matrixCompMult.xml">GLSL matrixCompMult man page</a> </dd>
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/noise3.xml">GLSL noise3 man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> </dd></dl>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.13 Noise Functions</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gae9f513dc8e4f3ceb993669321b6d0f09"></a>
<a class="anchor" id="gaed96a491dd0c552040d59f9178bc626d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL detail::outerProduct_trait&lt;T, P, vecTypeA, vecTypeB&gt;::type glm::outerProduct </td>
<td class="memname">GLM_FUNC_DECL tvec4&lt;typename genType::value_type, defaultp&gt; glm::noise4 </td>
<td>(</td>
<td class="paramtype">vecTypeA&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
<td class="paramtype">vecTypeB&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>r</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Treats the first parameter c as a column vector and the second parameter r as a row vector and does a linear algebraic matrix multiply c * r. </p>
<p>Returns a 4D noise value based on the input value x. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">matType</td><td>Floating-point matrix types.</td></tr>
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/outerProduct.xml">GLSL outerProduct man page</a> </dd>
<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/noise4.xml">GLSL noise4 man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> </dd></dl>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.13 Noise Functions</a> </dd></dl>
</div>
</div>