diff options
Diffstat (limited to 'external/include/glm/gtc/random.hpp')
| -rw-r--r-- | external/include/glm/gtc/random.hpp | 91 |
1 files changed, 37 insertions, 54 deletions
diff --git a/external/include/glm/gtc/random.hpp b/external/include/glm/gtc/random.hpp index fa3956e..9156e43 100644 --- a/external/include/glm/gtc/random.hpp +++ b/external/include/glm/gtc/random.hpp @@ -2,15 +2,14 @@ /// @file glm/gtc/random.hpp /// /// @see core (dependence) -/// @see gtc_half_float (dependence) /// @see gtx_random (extended) /// /// @defgroup gtc_random GLM_GTC_random /// @ingroup gtc /// -/// @brief Generate random number from various distribution methods. +/// Include <glm/gtc/random.hpp> to use the features of this extension. /// -/// <glm/gtc/random.hpp> need to be included to use these functionalities. +/// Generate random number from various distribution methods. #pragma once @@ -26,72 +25,56 @@ namespace glm { /// @addtogroup gtc_random /// @{ - - /// Generate random numbers in the interval [Min, Max], according a linear distribution - /// - /// @param Min - /// @param Max + + /// Generate random numbers in the interval [Min, Max], according a linear distribution + /// + /// @param Min Minimum value included in the sampling + /// @param Max Maximum value included in the sampling /// @tparam genType Value type. Currently supported: float or double scalars. /// @see gtc_random - template <typename genTYpe> - GLM_FUNC_DECL genTYpe linearRand( - genTYpe Min, - genTYpe Max); + template<typename genType> + GLM_FUNC_DECL genType linearRand(genType Min, genType Max); - /// Generate random numbers in the interval [Min, Max], according a linear distribution - /// - /// @param Min - /// @param Max + /// Generate random numbers in the interval [Min, Max], according a linear distribution + /// + /// @param Min Minimum value included in the sampling + /// @param Max Maximum value included in the sampling /// @tparam T Value type. Currently supported: float or double. - /// @tparam vecType A vertor type: tvec1, tvec2, tvec3, tvec4 or compatible + /// /// @see gtc_random - template <typename T, precision P, template <typename, precision> class vecType> - GLM_FUNC_DECL vecType<T, P> linearRand( - vecType<T, P> const & Min, - vecType<T, P> const & Max); + template<length_t L, typename T, qualifier Q> + GLM_FUNC_DECL vec<L, T, Q> linearRand(vec<L, T, Q> const& Min, vec<L, T, Q> const& Max); - /// Generate random numbers in the interval [Min, Max], according a gaussian distribution - /// - /// @param Mean - /// @param Deviation + /// Generate random numbers in the interval [Min, Max], according a gaussian distribution + /// /// @see gtc_random - template <typename genType> - GLM_FUNC_DECL genType gaussRand( - genType Mean, - genType Deviation); - + template<typename genType> + GLM_FUNC_DECL genType gaussRand(genType Mean, genType Deviation); + /// Generate a random 2D vector which coordinates are regulary distributed on a circle of a given radius - /// - /// @param Radius + /// /// @see gtc_random - template <typename T> - GLM_FUNC_DECL tvec2<T, defaultp> circularRand( - T Radius); - + template<typename T> + GLM_FUNC_DECL vec<2, T, defaultp> circularRand(T Radius); + /// Generate a random 3D vector which coordinates are regulary distributed on a sphere of a given radius - /// - /// @param Radius + /// /// @see gtc_random - template <typename T> - GLM_FUNC_DECL tvec3<T, defaultp> sphericalRand( - T Radius); - + template<typename T> + GLM_FUNC_DECL vec<3, T, defaultp> sphericalRand(T Radius); + /// Generate a random 2D vector which coordinates are regulary distributed within the area of a disk of a given radius - /// - /// @param Radius + /// /// @see gtc_random - template <typename T> - GLM_FUNC_DECL tvec2<T, defaultp> diskRand( - T Radius); - + template<typename T> + GLM_FUNC_DECL vec<2, T, defaultp> diskRand(T Radius); + /// Generate a random 3D vector which coordinates are regulary distributed within the volume of a ball of a given radius - /// - /// @param Radius + /// /// @see gtc_random - template <typename T> - GLM_FUNC_DECL tvec3<T, defaultp> ballRand( - T Radius); - + template<typename T> + GLM_FUNC_DECL vec<3, T, defaultp> ballRand(T Radius); + /// @} }//namespace glm |