glm/doc/api-0.9.3/a00147.html

194 lines
7.8 KiB
HTML
Raw Normal View History

2011-11-12 23:26:02 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
2011-12-07 14:50:15 +00:00
2011-11-12 23:26:02 +00:00
<title>Noise functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
2011-12-07 14:50:15 +00:00
<link href="doxygen.css" rel="stylesheet" type="text/css" />
2011-11-12 23:26:02 +00:00
</head>
<body>
2011-12-07 14:50:15 +00:00
<div id="top"><!-- do not remove this div! -->
2011-11-12 23:26:02 +00:00
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
2011-12-07 14:50:15 +00:00
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
2011-11-12 23:26:02 +00:00
</tr>
</tbody>
</table>
</div>
2011-12-07 14:50:15 +00:00
<!-- Generated by Doxygen 1.7.5 -->
2011-11-12 23:26:02 +00:00
<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 class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
2011-12-07 14:50:15 +00:00
<div class="title">Noise functions</div> </div>
2011-11-12 23:26:02 +00:00
<div class="ingroups"><a class="el" href="a00154.html">GLM Core</a></div></div>
<div class="contents">
<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>
2011-12-07 14:50:15 +00:00
<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>
2011-11-12 23:26:02 +00:00
<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"/>
2011-12-07 14:50:15 +00:00
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>
2011-11-12 23:26:02 +00:00
<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"/>
2011-12-07 14:50:15 +00:00
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>
2011-11-12 23:26:02 +00:00
<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"/>
2011-12-07 14:50:15 +00:00
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>
2011-11-12 23:26:02 +00:00
</table>
2011-12-07 14:50:15 +00:00
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
2011-11-12 23:26:02 +00:00
<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>
2011-12-07 14:50:15 +00:00
<a class="anchor" id="ga687ac48ae4591c0da916052e469aad74"></a><!-- doxytag: member="glm::noise1" ref="ga687ac48ae4591c0da916052e469aad74" args="(genType const &amp;x)" -->
2011-11-12 23:26:02 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType::value_type glm::noise1 </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 a 1D noise value based on the input value x. </p>
<dl><dt><b>Template Parameters:</b></dt><dd>
<table class="">
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></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.13</a> </dd></dl>
</div>
</div>
2011-12-07 14:50:15 +00:00
<a class="anchor" id="ga528fc75920119a7ab65ef6dccef28752"></a><!-- doxytag: member="glm::noise2" ref="ga528fc75920119a7ab65ef6dccef28752" args="(genType const &amp;x)" -->
2011-11-12 23:26:02 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec2&lt;typename genType::value_type&gt; glm::noise2 </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 a 2D noise value based on the input value x. </p>
<dl><dt><b>Template Parameters:</b></dt><dd>
<table class="">
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></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.13</a> </dd></dl>
</div>
</div>
2011-12-07 14:50:15 +00:00
<a class="anchor" id="gaf1589bc1859b8dc53d737ece36b59b85"></a><!-- doxytag: member="glm::noise3" ref="gaf1589bc1859b8dc53d737ece36b59b85" args="(genType const &amp;x)" -->
2011-11-12 23:26:02 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec3&lt;typename genType::value_type&gt; glm::noise3 </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 a 3D noise value based on the input value x. </p>
<dl><dt><b>Template Parameters:</b></dt><dd>
<table class="">
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></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.13</a> </dd></dl>
</div>
</div>
2011-12-07 14:50:15 +00:00
<a class="anchor" id="ga7b3cd0ab6f03142dd9ff3054e7fe5299"></a><!-- doxytag: member="glm::noise4" ref="ga7b3cd0ab6f03142dd9ff3054e7fe5299" args="(genType const &amp;x)" -->
2011-11-12 23:26:02 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec4&lt;typename genType::value_type&gt; glm::noise4 </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 a 4D noise value based on the input value x. </p>
<dl><dt><b>Template Parameters:</b></dt><dd>
<table class="">
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></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.13</a> </dd></dl>
</div>
</div>
</div>
2011-12-07 14:50:15 +00:00
<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>
2011-11-12 23:26:02 +00:00
</body>
</html>