You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

87 lines
4.0 KiB

  1. ///////////////////////////////////////////////////////////////////////////////////
  2. /// OpenGL Mathematics (glm.g-truc.net)
  3. ///
  4. /// Copyright (c) 2005 - 2013 G-Truc Creation (www.g-truc.net)
  5. /// Permission is hereby granted, free of charge, to any person obtaining a copy
  6. /// of this software and associated documentation files (the "Software"), to deal
  7. /// in the Software without restriction, including without limitation the rights
  8. /// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  9. /// copies of the Software, and to permit persons to whom the Software is
  10. /// furnished to do so, subject to the following conditions:
  11. ///
  12. /// The above copyright notice and this permission notice shall be included in
  13. /// all copies or substantial portions of the Software.
  14. ///
  15. /// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16. /// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17. /// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18. /// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19. /// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20. /// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21. /// THE SOFTWARE.
  22. ///
  23. /// @ref core
  24. /// @file glm/core/func_noise.hpp
  25. /// @date 2008-08-01 / 2011-06-18
  26. /// @author Christophe Riccio
  27. ///
  28. /// @see <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.13 Noise Functions</a>
  29. ///
  30. /// @defgroup core_func_noise Noise functions
  31. /// @ingroup core
  32. ///
  33. /// Noise functions are stochastic functions that can be used to increase visual
  34. /// complexity. Values returned by the following noise functions give the
  35. /// appearance of randomness, but are not truly random.
  36. ///////////////////////////////////////////////////////////////////////////////////
  37. #ifndef glm_core_func_noise
  38. #define glm_core_func_noise GLM_VERSION
  39. namespace glm
  40. {
  41. /// @addtogroup core_func_noise
  42. /// @{
  43. /// Returns a 1D noise value based on the input value x.
  44. ///
  45. /// @tparam genType Floating-point scalar or vector types.
  46. ///
  47. /// @see <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/noise1.xml">GLSL noise1 man page</a>
  48. /// @see <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.13 Noise Functions</a>
  49. template <typename genType>
  50. GLM_FUNC_DECL typename genType::value_type noise1(genType const & x);
  51. /// Returns a 2D noise value based on the input value x.
  52. ///
  53. /// @tparam genType Floating-point scalar or vector types.
  54. ///
  55. /// @see <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/noise2.xml">GLSL noise2 man page</a>
  56. /// @see <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.13 Noise Functions</a>
  57. template <typename genType>
  58. GLM_FUNC_DECL detail::tvec2<typename genType::value_type> noise2(genType const & x);
  59. /// Returns a 3D noise value based on the input value x.
  60. ///
  61. /// @tparam genType Floating-point scalar or vector types.
  62. ///
  63. /// @see <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/noise3.xml">GLSL noise3 man page</a>
  64. /// @see <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.13 Noise Functions</a>
  65. template <typename genType>
  66. GLM_FUNC_DECL detail::tvec3<typename genType::value_type> noise3(genType const & x);
  67. /// Returns a 4D noise value based on the input value x.
  68. ///
  69. /// @tparam genType Floating-point scalar or vector types.
  70. ///
  71. /// @see <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/noise4.xml">GLSL noise4 man page</a>
  72. /// @see <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.13 Noise Functions</a>
  73. template <typename genType>
  74. GLM_FUNC_DECL detail::tvec4<typename genType::value_type> noise4(genType const & x);
  75. /// @}
  76. }//namespace glm
  77. #include "func_noise.inl"
  78. #endif//glm_core_func_noise