a00156.html 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.10"/>
  7. <title>0.9.7: Noise functions</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  20. <td id="projectalign" style="padding-left: 0.5em;">
  21. <div id="projectname">0.9.7
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.10 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="modules.html"><span>Modules</span></a></li>
  34. <li><a href="files.html"><span>Files</span></a></li>
  35. </ul>
  36. </div>
  37. </div><!-- top -->
  38. <div class="header">
  39. <div class="summary">
  40. <a href="#func-members">Functions</a> </div>
  41. <div class="headertitle">
  42. <div class="title">Noise functions<div class="ingroups"><a class="el" href="a00162.html">GLM Core</a></div></div> </div>
  43. </div><!--header-->
  44. <div class="contents">
  45. <table class="memberdecls">
  46. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  47. Functions</h2></td></tr>
  48. <tr class="memitem:gadcbf14e3390990f33fda02bb20836960"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  49. <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="a00156.html#gadcbf14e3390990f33fda02bb20836960">noise1</a> (genType const &amp;x)</td></tr>
  50. <tr class="separator:gadcbf14e3390990f33fda02bb20836960"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51. <tr class="memitem:gad88de7f308dc57edb80690373a1380a9"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  52. <tr class="memitem:gad88de7f308dc57edb80690373a1380a9"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec2&lt; typename genType::value_type, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#gad88de7f308dc57edb80690373a1380a9">noise2</a> (genType const &amp;x)</td></tr>
  53. <tr class="separator:gad88de7f308dc57edb80690373a1380a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54. <tr class="memitem:ga3359a5e2b61cee8cf4498470a63f7283"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  55. <tr class="memitem:ga3359a5e2b61cee8cf4498470a63f7283"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec3&lt; typename genType::value_type, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#ga3359a5e2b61cee8cf4498470a63f7283">noise3</a> (genType const &amp;x)</td></tr>
  56. <tr class="separator:ga3359a5e2b61cee8cf4498470a63f7283"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem:gaed96a491dd0c552040d59f9178bc626d"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  58. <tr class="memitem:gaed96a491dd0c552040d59f9178bc626d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tvec4&lt; typename genType::value_type, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#gaed96a491dd0c552040d59f9178bc626d">noise4</a> (genType const &amp;x)</td></tr>
  59. <tr class="separator:gaed96a491dd0c552040d59f9178bc626d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. </table>
  61. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  62. <p>Noise functions are stochastic functions that can be used to increase visual complexity. </p>
  63. <p>Values returned by the following noise functions give the appearance of randomness, but are not truly random. </p>
  64. <h2 class="groupheader">Function Documentation</h2>
  65. <a class="anchor" id="gadcbf14e3390990f33fda02bb20836960"></a>
  66. <div class="memitem">
  67. <div class="memproto">
  68. <table class="memname">
  69. <tr>
  70. <td class="memname">GLM_FUNC_DECL genType::value_type glm::noise1 </td>
  71. <td>(</td>
  72. <td class="paramtype">genType const &amp;&#160;</td>
  73. <td class="paramname"><em>x</em></td><td>)</td>
  74. <td></td>
  75. </tr>
  76. </table>
  77. </div><div class="memdoc">
  78. <p>Returns a 1D noise value based on the input value x. </p>
  79. <dl class="tparams"><dt>Template Parameters</dt><dd>
  80. <table class="tparams">
  81. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  82. </table>
  83. </dd>
  84. </dl>
  85. <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>
  86. <dd>
  87. <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>
  88. </div>
  89. </div>
  90. <a class="anchor" id="gad88de7f308dc57edb80690373a1380a9"></a>
  91. <div class="memitem">
  92. <div class="memproto">
  93. <table class="memname">
  94. <tr>
  95. <td class="memname">GLM_FUNC_DECL tvec2&lt;typename genType::value_type, defaultp&gt; glm::noise2 </td>
  96. <td>(</td>
  97. <td class="paramtype">genType const &amp;&#160;</td>
  98. <td class="paramname"><em>x</em></td><td>)</td>
  99. <td></td>
  100. </tr>
  101. </table>
  102. </div><div class="memdoc">
  103. <p>Returns a 2D noise value based on the input value x. </p>
  104. <dl class="tparams"><dt>Template Parameters</dt><dd>
  105. <table class="tparams">
  106. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  107. </table>
  108. </dd>
  109. </dl>
  110. <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>
  111. <dd>
  112. <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>
  113. </div>
  114. </div>
  115. <a class="anchor" id="ga3359a5e2b61cee8cf4498470a63f7283"></a>
  116. <div class="memitem">
  117. <div class="memproto">
  118. <table class="memname">
  119. <tr>
  120. <td class="memname">GLM_FUNC_DECL tvec3&lt;typename genType::value_type, defaultp&gt; glm::noise3 </td>
  121. <td>(</td>
  122. <td class="paramtype">genType const &amp;&#160;</td>
  123. <td class="paramname"><em>x</em></td><td>)</td>
  124. <td></td>
  125. </tr>
  126. </table>
  127. </div><div class="memdoc">
  128. <p>Returns a 3D noise value based on the input value x. </p>
  129. <dl class="tparams"><dt>Template Parameters</dt><dd>
  130. <table class="tparams">
  131. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  132. </table>
  133. </dd>
  134. </dl>
  135. <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>
  136. <dd>
  137. <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>
  138. </div>
  139. </div>
  140. <a class="anchor" id="gaed96a491dd0c552040d59f9178bc626d"></a>
  141. <div class="memitem">
  142. <div class="memproto">
  143. <table class="memname">
  144. <tr>
  145. <td class="memname">GLM_FUNC_DECL tvec4&lt;typename genType::value_type, defaultp&gt; glm::noise4 </td>
  146. <td>(</td>
  147. <td class="paramtype">genType const &amp;&#160;</td>
  148. <td class="paramname"><em>x</em></td><td>)</td>
  149. <td></td>
  150. </tr>
  151. </table>
  152. </div><div class="memdoc">
  153. <p>Returns a 4D noise value based on the input value x. </p>
  154. <dl class="tparams"><dt>Template Parameters</dt><dd>
  155. <table class="tparams">
  156. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  157. </table>
  158. </dd>
  159. </dl>
  160. <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>
  161. <dd>
  162. <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>
  163. </div>
  164. </div>
  165. </div><!-- contents -->
  166. <!-- start footer part -->
  167. <hr class="footer"/><address class="footer"><small>
  168. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  169. <img class="footer" src="doxygen.png" alt="doxygen"/>
  170. </a> 1.8.10
  171. </small></address>
  172. </body>
  173. </html>