a00134.html 8.6 KB

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