mewin/glm
1
0
Fork 0
Code Releases Activity

Updated documentation

Browse Source
This commit is contained in:
Christophe Riccio
2012-11-18 14:05:52 +01:00
parent 5474e33d08
commit 753d5db251
389 changed files with 47803 additions and 49899 deletions
Download Patch File Download Diff File Expand all files Collapse all files

196
doc/api/a00148.html
View File

@@ -2,101 +2,77 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GLM_GTC_noise: Procedural noise functions</title>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>GLM_GTC_matrix_access</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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<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="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTC_noise: Procedural noise functions</div> </div>
<div class="ingroups"><a class="el" href="a00136.html">GTC Extensions (Stable)</a></div></div>
<div class="title">GLM_GTC_matrix_access</div> </div>
<div class="ingroups"><a class="el" href="a00138.html">GTC Extensions (Stable)</a></div></div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T , template&lt; typename &gt; class vecType&gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00148.html#gaa9f3e905afe771551512322edcec001b">perlin</a> (vecType&lt; T &gt; const &amp;p)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T , template&lt; typename &gt; class vecType&gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00148.html#ga52495e641513a2f965178d2a5d803077">perlin</a> (vecType&lt; T &gt; const &amp;p, vecType&lt; T &gt; const &amp;rep)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T , template&lt; typename &gt; class vecType&gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00148.html#ga5fa44c45d9b0cf67559b705c95b5dcd7">simplex</a> (vecType&lt; T &gt; const &amp;p)</td></tr>
<tr class="memitem:ga263133e2acfc1421ab17b41d2954aa8f"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga263133e2acfc1421ab17b41d2954aa8f"><td class="memTemplItemLeft" align="right" valign="top">genType::col_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00148.html#ga263133e2acfc1421ab17b41d2954aa8f">column</a> (genType const &amp;m, int index)</td></tr>
<tr class="separator:ga263133e2acfc1421ab17b41d2954aa8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae0e0157f3f2d58b640937e74d81f5ea6"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gae0e0157f3f2d58b640937e74d81f5ea6"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00148.html#gae0e0157f3f2d58b640937e74d81f5ea6">column</a> (genType const &amp;m, int index, typename genType::col_type const &amp;x)</td></tr>
<tr class="separator:gae0e0157f3f2d58b640937e74d81f5ea6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7e90918d2599dfcce7cffdde61e0ecb4"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga7e90918d2599dfcce7cffdde61e0ecb4"><td class="memTemplItemLeft" align="right" valign="top">genType::row_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00148.html#ga7e90918d2599dfcce7cffdde61e0ecb4">row</a> (genType const &amp;m, int index)</td></tr>
<tr class="separator:ga7e90918d2599dfcce7cffdde61e0ecb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6f90181a0a87ea6fb1beb5b90ca31ce9"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga6f90181a0a87ea6fb1beb5b90ca31ce9"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00148.html#ga6f90181a0a87ea6fb1beb5b90ca31ce9">row</a> (genType const &amp;m, int index, typename genType::row_type const &amp;x)</td></tr>
<tr class="separator:ga6f90181a0a87ea6fb1beb5b90ca31ce9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Defines 2D, 3D and 4D procedural noise functions Based on the work of Stefan Gustavson and Ashima Arts on "webgl-noise": <a href="https://github.com/ashima/webgl-noise">https://github.com/ashima/webgl-noise</a> Following Stefan Gustavson's paper "Simplex noise demystified": <a href="http://www.itn.liu.se/~stegu/simplexnoise/simplexnoise.pdf">http://www.itn.liu.se/~stegu/simplexnoise/simplexnoise.pdf</a> &lt;<a class="el" href="a00063.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtc/noise.hpp</a>&gt; need to be included to use these functionalities. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gaa9f3e905afe771551512322edcec001b"></a><!-- doxytag: member="glm::perlin" ref="gaa9f3e905afe771551512322edcec001b" args="(vecType&lt; T &gt; const &amp;p)" -->
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Defines functions to access rows or columns of a matrix easily. </p>
<p>&lt;<a class="el" href="a00052.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtc/matrix_access.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga263133e2acfc1421ab17b41d2954aa8f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::perlin </td>
<td class="memname">genType::col_type glm::column </td>
<td>(</td>
<td class="paramtype">vecType&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Classic perlin noise. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00148.html" title="Defines 2D, 3D and 4D procedural noise functions Based on the work of Stefan Gustavson and Ashima Art...">GLM_GTC_noise: Procedural noise functions</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga52495e641513a2f965178d2a5d803077"></a><!-- doxytag: member="glm::perlin" ref="ga52495e641513a2f965178d2a5d803077" args="(vecType&lt; T &gt; const &amp;p, vecType&lt; T &gt; const &amp;rep)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::perlin </td>
<td>(</td>
<td class="paramtype">vecType&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>p</em>, </td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vecType&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>rep</em>&#160;</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>index</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -104,42 +80,118 @@ Functions</h2></td></tr>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div><div class="memdoc">
<p>Periodic perlin noise. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00148.html" title="Defines 2D, 3D and 4D procedural noise functions Based on the work of Stefan Gustavson and Ashima Art...">GLM_GTC_noise: Procedural noise functions</a> </dd></dl>
<p>Get a specific column of a matrix. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00148.html" title="Defines functions to access rows or columns of a matrix easily.">GLM_GTC_matrix_access</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga5fa44c45d9b0cf67559b705c95b5dcd7"></a><!-- doxytag: member="glm::simplex" ref="ga5fa44c45d9b0cf67559b705c95b5dcd7" args="(vecType&lt; T &gt; const &amp;p)" -->
<a class="anchor" id="gae0e0157f3f2d58b640937e74d81f5ea6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::simplex </td>
<td class="memname">genType glm::column </td>
<td>(</td>
<td class="paramtype">vecType&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>p</em></td><td>)</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename genType::col_type const &amp;&#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">
</div><div class="memdoc">
<p>Simplex noise. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00148.html" title="Defines 2D, 3D and 4D procedural noise functions Based on the work of Stefan Gustavson and Ashima Art...">GLM_GTC_noise: Procedural noise functions</a> </dd></dl>
<p>Set a specific column to a matrix. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00148.html" title="Defines functions to access rows or columns of a matrix easily.">GLM_GTC_matrix_access</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga7e90918d2599dfcce7cffdde61e0ecb4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType::row_type glm::row </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>index</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a specific row of a matrix. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00148.html" title="Defines functions to access rows or columns of a matrix easily.">GLM_GTC_matrix_access</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga6f90181a0a87ea6fb1beb5b90ca31ce9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType glm::row </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename genType::row_type const &amp;&#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>Set a specific row to a matrix. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00148.html" title="Defines functions to access rows or columns of a matrix easily.">GLM_GTC_matrix_access</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<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.7.5.1
</a> 1.8.2
</small></address>
</body>
</html>