Updated doxygen documentation

This commit is contained in:
Christophe Riccio
2011-12-07 14:50:15 +00:00
parent a3b5034d4e
commit f18ad6bf2e
389 changed files with 27429 additions and 14460 deletions

View File

@@ -2,22 +2,36 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Noise functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="top"><!-- do not remove this div! -->
<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-mini.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
@@ -32,32 +46,29 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>Noise functions</h1> </div>
<div class="title">Noise functions</div> </div>
<div class="ingroups"><a class="el" href="a00154.html">GLM Core</a></div></div>
<div class="contents">
<p>Noise functions are stochastic functions that can be used to increase visual complexity.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#ga808e59c8fa5db374692ffe013e82579c">noise1</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#ga687ac48ae4591c0da916052e469aad74">noise1</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec2&lt; typename <br class="typebreak"/>
genType::value_type &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#ga76ec36566b17266879f21b7569e1c841">noise2</a> (genType const &amp;x)</td></tr>
genType::value_type &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#ga528fc75920119a7ab65ef6dccef28752">noise2</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; typename <br class="typebreak"/>
genType::value_type &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#gaa13cb8087ee4bf996581e9499b78a608">noise3</a> (genType const &amp;x)</td></tr>
genType::value_type &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#gaf1589bc1859b8dc53d737ece36b59b85">noise3</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec4&lt; typename <br class="typebreak"/>
genType::value_type &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#gaf0cd5c48b858df6120e748666fd42b58">noise4</a> (genType const &amp;x)</td></tr>
genType::value_type &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00147.html#ga7b3cd0ab6f03142dd9ff3054e7fe5299">noise4</a> (genType const &amp;x)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<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>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga808e59c8fa5db374692ffe013e82579c"></a><!-- doxytag: member="glm::noise1" ref="ga808e59c8fa5db374692ffe013e82579c" args="(genType const &amp;x)" -->
<a class="anchor" id="ga687ac48ae4591c0da916052e469aad74"></a><!-- doxytag: member="glm::noise1" ref="ga687ac48ae4591c0da916052e469aad74" args="(genType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -85,7 +96,7 @@ genType::value_type &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"
</div>
</div>
<a class="anchor" id="ga76ec36566b17266879f21b7569e1c841"></a><!-- doxytag: member="glm::noise2" ref="ga76ec36566b17266879f21b7569e1c841" args="(genType const &amp;x)" -->
<a class="anchor" id="ga528fc75920119a7ab65ef6dccef28752"></a><!-- doxytag: member="glm::noise2" ref="ga528fc75920119a7ab65ef6dccef28752" args="(genType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -113,7 +124,7 @@ genType::value_type &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"
</div>
</div>
<a class="anchor" id="gaa13cb8087ee4bf996581e9499b78a608"></a><!-- doxytag: member="glm::noise3" ref="gaa13cb8087ee4bf996581e9499b78a608" args="(genType const &amp;x)" -->
<a class="anchor" id="gaf1589bc1859b8dc53d737ece36b59b85"></a><!-- doxytag: member="glm::noise3" ref="gaf1589bc1859b8dc53d737ece36b59b85" args="(genType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -141,7 +152,7 @@ genType::value_type &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"
</div>
</div>
<a class="anchor" id="gaf0cd5c48b858df6120e748666fd42b58"></a><!-- doxytag: member="glm::noise4" ref="gaf0cd5c48b858df6120e748666fd42b58" args="(genType const &amp;x)" -->
<a class="anchor" id="ga7b3cd0ab6f03142dd9ff3054e7fe5299"></a><!-- doxytag: member="glm::noise4" ref="ga7b3cd0ab6f03142dd9ff3054e7fe5299" args="(genType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -170,8 +181,13 @@ genType::value_type &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"
</div>
</div>
</div>
<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.3 </small></address>
<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
</small></address>
</body>
</html>