glm/doc/api/a00154.html

185 lines
8.8 KiB
HTML
Raw Normal View History

2014-11-25 00:28:32 +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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
2014-11-30 20:57:58 +00:00
<title>0.9.6: Noise functions</title>
2014-11-25 00:28:32 +00:00
<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, 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.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">0.9.6
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- 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="modules.html"><span>Modules</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
2014-11-30 20:57:58 +00:00
<div class="title">Noise functions<div class="ingroups"><a class="el" href="a00160.html">GLM Core</a></div></div> </div>
2014-11-25 00:28:32 +00:00
</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>
2014-11-30 20:57:58 +00:00
<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>
2014-11-25 00:28:32 +00:00
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
2014-11-30 20:57:58 +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>
2014-11-25 00:28:32 +00:00
<h2 class="groupheader">Function Documentation</h2>
2014-11-30 20:57:58 +00:00
<a class="anchor" id="gadcbf14e3390990f33fda02bb20836960"></a>
2014-11-25 00:28:32 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2014-11-30 20:57:58 +00:00
<td class="memname">GLM_FUNC_DECL genType::value_type glm::noise1 </td>
2014-11-25 00:28:32 +00:00
<td>(</td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
2014-11-25 00:28:32 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2014-11-30 20:57:58 +00:00
<p>Returns a 1D noise value based on the input value x. </p>
2014-11-25 00:28:32 +00:00
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
2014-11-30 20:57:58 +00:00
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
2014-11-25 00:28:32 +00:00
</table>
</dd>
</dl>
2014-11-30 20:57:58 +00:00
<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>
2014-11-25 00:28:32 +00:00
<dd>
2014-11-30 20:57:58 +00:00
<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>
2014-11-25 00:28:32 +00:00
</div>
</div>
2014-11-30 20:57:58 +00:00
<a class="anchor" id="gad88de7f308dc57edb80690373a1380a9"></a>
2014-11-25 00:28:32 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2014-11-30 20:57:58 +00:00
<td class="memname">GLM_FUNC_DECL tvec2&lt;typename genType::value_type, defaultp&gt; glm::noise2 </td>
2014-11-25 00:28:32 +00:00
<td>(</td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
2014-11-25 00:28:32 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2014-11-30 20:57:58 +00:00
<p>Returns a 2D noise value based on the input value x. </p>
2014-11-25 00:28:32 +00:00
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
2014-11-30 20:57:58 +00:00
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
2014-11-25 00:28:32 +00:00
</table>
</dd>
</dl>
2014-11-30 20:57:58 +00:00
<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>
2014-11-25 00:28:32 +00:00
<dd>
2014-11-30 20:57:58 +00:00
<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>
2014-11-25 00:28:32 +00:00
</div>
</div>
2014-11-30 20:57:58 +00:00
<a class="anchor" id="ga3359a5e2b61cee8cf4498470a63f7283"></a>
2014-11-25 00:28:32 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2014-11-30 20:57:58 +00:00
<td class="memname">GLM_FUNC_DECL tvec3&lt;typename genType::value_type, defaultp&gt; glm::noise3 </td>
2014-11-25 00:28:32 +00:00
<td>(</td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
2014-11-25 00:28:32 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2014-11-30 20:57:58 +00:00
<p>Returns a 3D noise value based on the input value x. </p>
2014-11-25 00:28:32 +00:00
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
2014-11-30 20:57:58 +00:00
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
2014-11-25 00:28:32 +00:00
</table>
</dd>
</dl>
2014-11-30 20:57:58 +00:00
<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>
2014-11-25 00:28:32 +00:00
<dd>
2014-11-30 20:57:58 +00:00
<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>
2014-11-25 00:28:32 +00:00
</div>
</div>
2014-11-30 20:57:58 +00:00
<a class="anchor" id="gaed96a491dd0c552040d59f9178bc626d"></a>
2014-11-25 00:28:32 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2014-11-30 20:57:58 +00:00
<td class="memname">GLM_FUNC_DECL tvec4&lt;typename genType::value_type, defaultp&gt; glm::noise4 </td>
2014-11-25 00:28:32 +00:00
<td>(</td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
2014-11-25 00:28:32 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2014-11-30 20:57:58 +00:00
<p>Returns a 4D noise value based on the input value x. </p>
2014-11-25 00:28:32 +00:00
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
2014-11-30 20:57:58 +00:00
<tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
2014-11-25 00:28:32 +00:00
</table>
</dd>
</dl>
2014-11-30 20:57:58 +00:00
<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>
2014-11-25 00:28:32 +00:00
<dd>
2014-11-30 20:57:58 +00:00
<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>
2014-11-25 00:28:32 +00:00
</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.8.8
</small></address>
</body>
</html>