1 /////////////////////////////////////////////////////////////////////////////////// 2 /// OpenGL Mathematics (glm.g-truc.net) 3 /// 4 /// Copyright (c) 2005 - 2014 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 38 #ifndef glm_core_func_noise 39 #define glm_core_func_noise 40 41 #include "type_vec1.hpp" 42 #include "type_vec2.hpp" 43 #include "type_vec3.hpp" 44 #include "setup.hpp" 45 46 namespace glm 47 { 48 /// @addtogroup core_func_noise 49 /// @{ 50 51 /// Returns a 1D 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/noise1.xml">GLSL noise1 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 typename genType::value_type noise1(genType const & x); 59 60 /// Returns a 2D noise value based on the input value x. 61 /// 62 /// @tparam genType Floating-point scalar or vector types. 63 /// 64 /// @see <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/noise2.xml">GLSL noise2 man page</a> 65 /// @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> 66 template <typename genType> 67 GLM_FUNC_DECL detail::tvec2<typename genType::value_type, defaultp> noise2(genType const & x); 68 69 /// Returns a 3D noise value based on the input value x. 70 /// 71 /// @tparam genType Floating-point scalar or vector types. 72 /// 73 /// @see <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/noise3.xml">GLSL noise3 man page</a> 74 /// @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> 75 template <typename genType> 76 GLM_FUNC_DECL detail::tvec3<typename genType::value_type, defaultp> noise3(genType const & x); 77 78 /// Returns a 4D noise value based on the input value x. 79 /// 80 /// @tparam genType Floating-point scalar or vector types. 81 /// 82 /// @see <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/noise4.xml">GLSL noise4 man page</a> 83 /// @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> 84 template <typename genType> 85 GLM_FUNC_DECL detail::tvec4<typename genType::value_type, defaultp> noise4(genType const & x); 86 87 /// @} 88 }//namespace glm 89 90 #include "func_noise.inl" 91 92 #endif//glm_core_func_noise 93