From ef15d0610421bd55e37ee778e54685414492c2cd Mon Sep 17 00:00:00 2001 From: Christophe Riccio Date: Sun, 12 May 2013 15:51:11 +0200 Subject: [PATCH] Updated doxygen references --- glm/gtx/simd_vec4.hpp | 171 +++++++++++++++++++++-------------- glm/gtx/spline.hpp | 10 +- glm/gtx/string_cast.hpp | 2 +- glm/gtx/vec1.hpp | 32 +++---- glm/gtx/vector_access.hpp | 12 +-- glm/gtx/vector_angle.hpp | 6 +- glm/gtx/vector_query.hpp | 14 +-- glm/gtx/verbose_operator.hpp | 10 +- glm/gtx/wrap.hpp | 12 +-- 9 files changed, 153 insertions(+), 116 deletions(-) diff --git a/glm/gtx/simd_vec4.hpp b/glm/gtx/simd_vec4.hpp index 927e7df8..0e8da15e 100644 --- a/glm/gtx/simd_vec4.hpp +++ b/glm/gtx/simd_vec4.hpp @@ -79,13 +79,13 @@ namespace detail typedef tvec4 bool_type; #ifdef GLM_SIMD_ENABLE_XYZW_UNION - union - { - __m128 Data; - struct {float x, y, z, w;}; - }; + union + { + __m128 Data; + struct {float x, y, z, w;}; + }; #else - __m128 Data; + __m128 Data; #endif ////////////////////////////////////// @@ -160,60 +160,65 @@ namespace detail /// @{ //! Convert a simdVec4 to a vec4. - //! (From GLM_GTX_simd_vec4 extension) + /// @see gtx_simd_vec4 vec4 vec4_cast( detail::fvec4SIMD const & x); - //! Returns x if x >= 0; otherwise, it returns -x. - //! (From GLM_GTX_simd_vec4 extension, common function) + //! Returns x if x >= 0; otherwise, it returns -x. + /// @see gtx_simd_vec4 detail::fvec4SIMD abs(detail::fvec4SIMD const & x); - //! Returns 1.0 if x > 0, 0.0 if x = 0, or -1.0 if x < 0. - //! (From GLM_GTX_simd_vec4 extension, common function) + //! Returns 1.0 if x > 0, 0.0 if x = 0, or -1.0 if x < 0. + /// @see gtx_simd_vec4 detail::fvec4SIMD sign(detail::fvec4SIMD const & x); - //! Returns a value equal to the nearest integer that is less then or equal to x. - //! (From GLM_GTX_simd_vec4 extension, common function) + //! Returns a value equal to the nearest integer that is less then or equal to x. + /// @see gtx_simd_vec4 detail::fvec4SIMD floor(detail::fvec4SIMD const & x); - //! Returns a value equal to the nearest integer to x - //! whose absolute value is not larger than the absolute value of x. - //! (From GLM_GTX_simd_vec4 extension, common function) + //! Returns a value equal to the nearest integer to x + //! whose absolute value is not larger than the absolute value of x. + /// @see gtx_simd_vec4 detail::fvec4SIMD trunc(detail::fvec4SIMD const & x); - //! Returns a value equal to the nearest integer to x. - //! The fraction 0.5 will round in a direction chosen by the - //! implementation, presumably the direction that is fastest. - //! This includes the possibility that round(x) returns the - //! same value as roundEven(x) for all values of x. - //! (From GLM_GTX_simd_vec4 extension, common function) + //! Returns a value equal to the nearest integer to x. + //! The fraction 0.5 will round in a direction chosen by the + //! implementation, presumably the direction that is fastest. + //! This includes the possibility that round(x) returns the + //! same value as roundEven(x) for all values of x. + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD round(detail::fvec4SIMD const & x); //! Returns a value equal to the nearest integer to x. //! A fractional part of 0.5 will round toward the nearest even //! integer. (Both 3.5 and 4.5 for x will return 4.0.) - //! (From GLM_GTX_simd_vec4 extension, common function) + /// + /// @see gtx_simd_vec4 //detail::fvec4SIMD roundEven(detail::fvec4SIMD const & x); //! Returns a value equal to the nearest integer //! that is greater than or equal to x. - //! (From GLM_GTX_simd_vec4 extension, common function) + /// @see gtx_simd_vec4 detail::fvec4SIMD ceil(detail::fvec4SIMD const & x); //! Return x - floor(x). - //! (From GLM_GTX_simd_vec4 extension, common function) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD fract(detail::fvec4SIMD const & x); - //! Modulus. Returns x - y * floor(x / y) + //! Modulus. Returns x - y * floor(x / y) //! for each component in x using the floating point value y. - //! (From GLM_GTX_simd_vec4 extension, common function) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD mod( detail::fvec4SIMD const & x, detail::fvec4SIMD const & y); - //! Modulus. Returns x - y * floor(x / y) + //! Modulus. Returns x - y * floor(x / y) //! for each component in x using the floating point value y. - //! (From GLM_GTX_simd_vec4 extension, common function) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD mod( detail::fvec4SIMD const & x, float const & y); @@ -228,7 +233,8 @@ namespace detail // detail::fvec4SIMD & i); //! Returns y if y < x; otherwise, it returns x. - //! (From GLM_GTX_simd_vec4 extension, common function) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD min( detail::fvec4SIMD const & x, detail::fvec4SIMD const & y); @@ -238,7 +244,8 @@ namespace detail float const & y); //! Returns y if x < y; otherwise, it returns x. - //! (From GLM_GTX_simd_vec4 extension, common function) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD max( detail::fvec4SIMD const & x, detail::fvec4SIMD const & y); @@ -249,7 +256,8 @@ namespace detail //! Returns min(max(x, minVal), maxVal) for each component in x //! using the floating-point values minVal and maxVal. - //! (From GLM_GTX_simd_vec4 extension, common function) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD clamp( detail::fvec4SIMD const & x, detail::fvec4SIMD const & minVal, @@ -283,15 +291,17 @@ namespace detail //! \param[in] y Floating point scalar or vector. //! \param[in] a Floating point or boolean scalar or vector. //! - // \todo Test when 'a' is a boolean. - //! (From GLM_GTX_simd_vec4 extension, common function) + /// \todo Test when 'a' is a boolean. + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD mix( detail::fvec4SIMD const & x, detail::fvec4SIMD const & y, detail::fvec4SIMD const & a); //! Returns 0.0 if x < edge, otherwise it returns 1.0. - //! (From GLM_GTX_simd_vec4 extension, common function) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD step( detail::fvec4SIMD const & edge, detail::fvec4SIMD const & x); @@ -309,7 +319,8 @@ namespace detail //! t = clamp ((x - edge0) / (edge1 - edge0), 0, 1); //! return t * t * (3 - 2 * t); //! Results are undefined if edge0 >= edge1. - //! (From GLM_GTX_simd_vec4 extension, common function) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD smoothstep( detail::fvec4SIMD const & edge0, detail::fvec4SIMD const & edge1, @@ -325,7 +336,8 @@ namespace detail //! floating point representations. Returns false otherwise, //! including for implementations with no NaN //! representations. - //! (From GLM_GTX_simd_vec4 extension, common function) + /// + /// @see gtx_simd_vec4 //bvec4 isnan(detail::fvec4SIMD const & x); //! Returns true if x holds a positive infinity or negative @@ -333,13 +345,15 @@ namespace detail //! set of floating point representations. Returns false //! otherwise, including for implementations with no infinity //! representations. - //! (From GLM_GTX_simd_vec4 extension, common function) + /// + /// @see gtx_simd_vec4 //bvec4 isinf(detail::fvec4SIMD const & x); //! Returns a signed or unsigned integer value representing //! the encoding of a floating-point value. The floatingpoint //! value's bit-level representation is preserved. - //! (From GLM_GTX_simd_vec4 extension, common function) + /// + /// @see gtx_simd_vec4 //detail::ivec4SIMD floatBitsToInt(detail::fvec4SIMD const & value); //! Returns a floating-point value corresponding to a signed @@ -347,11 +361,13 @@ namespace detail //! If an inf or NaN is passed in, it will not signal, and the //! resulting floating point value is unspecified. Otherwise, //! the bit-level representation is preserved. - //! (From GLM_GTX_simd_vec4 extension, common function) + /// + /// @see gtx_simd_vec4 //detail::fvec4SIMD intBitsToFloat(detail::ivec4SIMD const & value); //! Computes and returns a * b + c. - //! (From GLM_GTX_simd_vec4 extension, common function) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD fma( detail::fvec4SIMD const & a, detail::fvec4SIMD const & b, @@ -365,7 +381,8 @@ namespace detail //! floating-point value of zero, the significant and exponent //! are both zero. For a floating-point value that is an //! infinity or is not a number, the results are undefined. - //! (From GLM_GTX_simd_vec4 extension, common function) + /// + /// @see gtx_simd_vec4 //detail::fvec4SIMD frexp(detail::fvec4SIMD const & x, detail::ivec4SIMD & exp); //! Builds a floating-point number from x and the @@ -373,86 +390,101 @@ namespace detail //! significand * exp(2, exponent) //! If this product is too large to be represented in the //! floating-point type, the result is undefined. - //! (From GLM_GTX_simd_vec4 extension, common function) + /// + /// @see gtx_simd_vec4 //detail::fvec4SIMD ldexp(detail::fvec4SIMD const & x, detail::ivec4SIMD const & exp); //! Returns the length of x, i.e., sqrt(x * x). - //! (From GLM_GTX_simd_vec4 extension, geometry functions) + /// + /// @see gtx_simd_vec4 float length( detail::fvec4SIMD const & x); //! Returns the length of x, i.e., sqrt(x * x). //! Less accurate but much faster than simdLength. - //! (From GLM_GTX_simd_vec4 extension, geometry functions) + /// + /// @see gtx_simd_vec4 float fastLength( detail::fvec4SIMD const & x); //! Returns the length of x, i.e., sqrt(x * x). //! Slightly more accurate but much slower than simdLength. - //! (From GLM_GTX_simd_vec4 extension, geometry functions) + /// + /// @see gtx_simd_vec4 float niceLength( detail::fvec4SIMD const & x); //! Returns the length of x, i.e., sqrt(x * x). - //! (From GLM_GTX_simd_vec4 extension, geometry functions) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD length4( detail::fvec4SIMD const & x); //! Returns the length of x, i.e., sqrt(x * x). //! Less accurate but much faster than simdLength4. - //! (From GLM_GTX_simd_vec4 extension, geometry functions) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD fastLength4( detail::fvec4SIMD const & x); //! Returns the length of x, i.e., sqrt(x * x). //! Slightly more accurate but much slower than simdLength4. - //! (From GLM_GTX_simd_vec4 extension, geometry functions) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD niceLength4( detail::fvec4SIMD const & x); //! Returns the distance betwwen p0 and p1, i.e., length(p0 - p1). - //! (From GLM_GTX_simd_vec4 extension, geometry functions) + /// + /// @see gtx_simd_vec4 float distance( detail::fvec4SIMD const & p0, detail::fvec4SIMD const & p1); //! Returns the distance betwwen p0 and p1, i.e., length(p0 - p1). - //! (From GLM_GTX_simd_vec4 extension, geometry functions) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD distance4( detail::fvec4SIMD const & p0, detail::fvec4SIMD const & p1); //! Returns the dot product of x and y, i.e., result = x * y. - //! (From GLM_GTX_simd_vec4 extension, geometry functions) + /// + /// @see gtx_simd_vec4 float simdDot( detail::fvec4SIMD const & x, detail::fvec4SIMD const & y); //! Returns the dot product of x and y, i.e., result = x * y. - //! (From GLM_GTX_simd_vec4 extension, geometry functions) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD dot4( detail::fvec4SIMD const & x, detail::fvec4SIMD const & y); //! Returns the cross product of x and y. - //! (From GLM_GTX_simd_vec4 extension, geometry functions) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD cross( detail::fvec4SIMD const & x, detail::fvec4SIMD const & y); //! Returns a vector in the same direction as x but with length of 1. - //! (From GLM_GTX_simd_vec4 extension, geometry functions) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD normalize( detail::fvec4SIMD const & x); //! Returns a vector in the same direction as x but with length of 1. //! Less accurate but much faster than simdNormalize. - //! (From GLM_GTX_simd_vec4 extension, geometry functions) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD fastNormalize( detail::fvec4SIMD const & x); //! If dot(Nref, I) < 0.0, return N, otherwise, return -N. - //! (From GLM_GTX_simd_vec4 extension, geometry functions) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD simdFaceforward( detail::fvec4SIMD const & N, detail::fvec4SIMD const & I, @@ -460,7 +492,8 @@ namespace detail //! For the incident vector I and surface orientation N, //! returns the reflection direction : result = I - 2.0 * dot(N, I) * N. - //! (From GLM_GTX_simd_vec4 extension, geometry functions) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD reflect( detail::fvec4SIMD const & I, detail::fvec4SIMD const & N); @@ -468,37 +501,43 @@ namespace detail //! For the incident vector I and surface normal N, //! and the ratio of indices of refraction eta, //! return the refraction vector. - //! (From GLM_GTX_simd_vec4 extension, geometry functions) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD refract( detail::fvec4SIMD const & I, detail::fvec4SIMD const & N, float const & eta); //! Returns the positive square root of x. - //! (From GLM_GTX_simd_vec4 extension, exponential function) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD sqrt( detail::fvec4SIMD const & x); //! Returns the positive square root of x with the nicest quality but very slow. //! Slightly more accurate but much slower than simdSqrt. - //! (From GLM_GTX_simd_vec4 extension, exponential function) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD niceSqrt( detail::fvec4SIMD const & x); //! Returns the positive square root of x //! Less accurate but much faster than sqrt. - //! (From GLM_GTX_simd_vec4 extension, exponential function) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD fastSqrt( detail::fvec4SIMD const & x); //! Returns the reciprocal of the positive square root of x. - //! (From GLM_GTX_simd_vec4 extension, exponential function) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD inversesqrt( detail::fvec4SIMD const & x); //! Returns the reciprocal of the positive square root of x. //! Faster than inversesqrt but less accurate. - //! (From GLM_GTX_simd_vec4 extension, exponential function) + /// + /// @see gtx_simd_vec4 detail::fvec4SIMD fastInversesqrt( detail::fvec4SIMD const & x); @@ -507,12 +546,10 @@ namespace detail #include "simd_vec4.inl" - #if (GLM_COMPILER & GLM_COMPILER_VC) -# pragma warning(pop) +# pragma warning(pop) #endif - #endif//(GLM_ARCH != GLM_ARCH_PURE) #endif//GLM_GTX_simd_vec4 diff --git a/glm/gtx/spline.hpp b/glm/gtx/spline.hpp index e9035ce1..9f811709 100644 --- a/glm/gtx/spline.hpp +++ b/glm/gtx/spline.hpp @@ -52,7 +52,7 @@ namespace glm /// @{ //! Return a point from a catmull rom curve. - //! From GLM_GTX_spline extension. + /// @see gtx_spline extension. template genType catmullRom( genType const & v1, @@ -62,8 +62,8 @@ namespace glm typename genType::value_type const & s); //! Return a point from a hermite curve. - //! From GLM_GTX_spline extension. - template + /// @see gtx_spline extension. + template genType hermite( genType const & v1, genType const & t1, @@ -71,8 +71,8 @@ namespace glm genType const & t2, typename genType::value_type const & s); - //! Return a point from a cubic curve. - //! From GLM_GTX_spline extension. + //! Return a point from a cubic curve. + /// @see gtx_spline extension. template genType cubic( genType const & v1, diff --git a/glm/gtx/string_cast.hpp b/glm/gtx/string_cast.hpp index b3060931..f5efa6ac 100644 --- a/glm/gtx/string_cast.hpp +++ b/glm/gtx/string_cast.hpp @@ -58,7 +58,7 @@ namespace glm /// @{ /// Create a string from a GLM type value. - /// From GLM_GTX_string_cast extension. + /// @see gtx_string_cast extension. template std::string to_string(genType const & x); diff --git a/glm/gtx/vec1.hpp b/glm/gtx/vec1.hpp index 346c7ffa..ddf9880d 100644 --- a/glm/gtx/vec1.hpp +++ b/glm/gtx/vec1.hpp @@ -49,62 +49,62 @@ namespace glm { //! 1 component vector of high precision floating-point numbers. //! There is no guarantee on the actual precision. - //! From GLM_GTX_vec1 extension. + /// @see gtx_vec1 extension. typedef highp_vec1_t highp_vec1; //! 1 component vector of medium precision floating-point numbers. //! There is no guarantee on the actual precision. - //! From GLM_GTX_vec1 extension. + /// @see gtx_vec1 extension. typedef mediump_vec1_t mediump_vec1; //! 1 component vector of low precision floating-point numbers. //! There is no guarantee on the actual precision. - //! From GLM_GTX_vec1 extension. + /// @see gtx_vec1 extension. typedef lowp_vec1_t lowp_vec1; //! 1 component vector of high precision signed integer numbers. //! There is no guarantee on the actual precision. - //! From GLM_GTX_vec1 extension. + /// @see gtx_vec1 extension. typedef highp_ivec1_t highp_ivec1; //! 1 component vector of medium precision signed integer numbers. //! There is no guarantee on the actual precision. - //! From GLM_GTX_vec1 extension. + /// @see gtx_vec1 extension. typedef mediump_ivec1_t mediump_ivec1; //! 1 component vector of low precision signed integer numbers. //! There is no guarantee on the actual precision. - //! From GLM_GTX_vec1 extension. + /// @see gtx_vec1 extension. typedef lowp_ivec1_t lowp_ivec1; //! 1 component vector of high precision unsigned integer numbers. //! There is no guarantee on the actual precision. - //! From GLM_GTX_vec1 extension. + /// @see gtx_vec1 extension. typedef highp_uvec1_t highp_uvec1; //! 1 component vector of medium precision unsigned integer numbers. //! There is no guarantee on the actual precision. - //! From GLM_GTX_vec1 extension. + /// @see gtx_vec1 extension. typedef mediump_uvec1_t mediump_uvec1; //! 1 component vector of low precision unsigned integer numbers. //! There is no guarantee on the actual precision. - //! From GLM_GTX_vec1 extension. + /// @see gtx_vec1 extension. typedef lowp_uvec1_t lowp_uvec1; //! 1 component vector of high precision boolean. //! There is no guarantee on the actual precision. - //! From GLM_GTX_vec1 extension. + /// @see gtx_vec1 extension. typedef highp_bvec1_t highp_bvec1; //! 1 component vector of medium precision boolean. //! There is no guarantee on the actual precision. - //! From GLM_GTX_vec1 extension. + /// @see gtx_vec1 extension. typedef mediump_bvec1_t mediump_bvec1; //! 1 component vector of low precision boolean. //! There is no guarantee on the actual precision. - //! From GLM_GTX_vec1 extension. + /// @see gtx_vec1 extension. typedef lowp_bvec1_t lowp_bvec1; ////////////////////////// @@ -118,7 +118,7 @@ namespace glm typedef lowp_bvec1 bvec1; #else /// 1 component vector of boolean. - /// From GLM_GTX_vec1 extension. + /// @see gtx_vec1 extension. typedef highp_bvec1 bvec1; #endif//GLM_PRECISION @@ -130,7 +130,7 @@ namespace glm typedef lowp_vec1 vec1; #else /// 1 component vector of floating-point numbers. - /// From GLM_GTX_vec1 extension. + /// @see gtx_vec1 extension. typedef highp_vec1 vec1; #endif//GLM_PRECISION @@ -142,7 +142,7 @@ namespace glm typedef lowp_ivec1 ivec1; #else /// 1 component vector of signed integer numbers. - /// From GLM_GTX_vec1 extension. + /// @see gtx_vec1 extension. typedef highp_ivec1 ivec1; #endif//GLM_PRECISION @@ -154,7 +154,7 @@ namespace glm typedef lowp_uvec1 uvec1; #else /// 1 component vector of unsigned integer numbers. - /// From GLM_GTX_vec1 extension. + /// @see gtx_vec1 extension. typedef highp_uvec1 uvec1; #endif//GLM_PRECISION diff --git a/glm/gtx/vector_access.hpp b/glm/gtx/vector_access.hpp index 89426611..29bb8971 100644 --- a/glm/gtx/vector_access.hpp +++ b/glm/gtx/vector_access.hpp @@ -51,16 +51,16 @@ namespace glm /// @{ //! Set values to a 2 components vector. - //! From GLM_GTX_vector_access extension. - template + /// @see gtx_vector_access extension. + template void set( detail::tvec2 & v, valType const & x, valType const & y); //! Set values to a 3 components vector. - //! From GLM_GTX_vector_access extension. - template + /// @see gtx_vector_access extension. + template void set( detail::tvec3 & v, valType const & x, @@ -68,8 +68,8 @@ namespace glm valType const & z); //! Set values to a 4 components vector. - //! From GLM_GTX_vector_access extension. - template + /// @see gtx_vector_access extension. + template void set( detail::tvec4 & v, valType const & x, diff --git a/glm/gtx/vector_angle.hpp b/glm/gtx/vector_angle.hpp index 0fc99fb0..424c6920 100644 --- a/glm/gtx/vector_angle.hpp +++ b/glm/gtx/vector_angle.hpp @@ -57,7 +57,7 @@ namespace glm //! Returns the absolute angle between two vectors //! Parameters need to be normalized. - //! From GLM_GTX_vector_angle extension + /// @see gtx_vector_angle extension template GLM_FUNC_QUALIFIER typename vecType::value_type angle( vecType const & x, @@ -65,7 +65,7 @@ namespace glm //! Returns the oriented angle between two 2d vectors //! Parameters need to be normalized. - //! From GLM_GTX_vector_angle extension. + /// @see gtx_vector_angle extension. template GLM_FUNC_QUALIFIER T orientedAngle( detail::tvec2 const & x, @@ -73,7 +73,7 @@ namespace glm //! Returns the oriented angle between two 3d vectors based from a reference axis. //! Parameters need to be normalized. - //! From GLM_GTX_vector_angle extension. + /// @see gtx_vector_angle extension. template GLM_FUNC_QUALIFIER T orientedAngle( detail::tvec3 const & x, diff --git a/glm/gtx/vector_query.hpp b/glm/gtx/vector_query.hpp index 557526d5..2474727d 100644 --- a/glm/gtx/vector_query.hpp +++ b/glm/gtx/vector_query.hpp @@ -53,7 +53,7 @@ namespace glm /// @{ //! Check whether two vectors are collinears. - //! From GLM_GTX_vector_query extensions. + /// @see gtx_vector_query extensions. template bool areCollinear( genType const & v0, @@ -61,7 +61,7 @@ namespace glm typename genType::value_type const & epsilon); //! Check whether two vectors are orthogonals. - //! From GLM_GTX_vector_query extensions. + /// @see gtx_vector_query extensions. template bool areOrthogonal( genType const & v0, @@ -69,35 +69,35 @@ namespace glm typename genType::value_type const & epsilon); //! Check whether a vector is normalized. - //! From GLM_GTX_vector_query extensions. + /// @see gtx_vector_query extensions. template class vecType> bool isNormalized( vecType const & v, genType const & epsilon); //! Check whether a vector is null. - //! From GLM_GTX_vector_query extensions. + /// @see gtx_vector_query extensions. template bool isNull( detail::tvec2 const & v, T const & epsilon); //! Check whether a vector is null. - //! From GLM_GTX_vector_query extensions. + /// @see gtx_vector_query extensions. template bool isNull( detail::tvec3 const & v, T const & epsilon); //! Check whether a vector is null. - //! From GLM_GTX_vector_query extensions. + /// @see gtx_vector_query extensions. template bool isNull( detail::tvec4 const & v, T const & epsilon); //! Check whether two vectors are orthonormal. - //! From GLM_GTX_vector_query extensions. + /// @see gtx_vector_query extensions. template bool areOrthonormal( genType const & v0, diff --git a/glm/gtx/verbose_operator.hpp b/glm/gtx/verbose_operator.hpp index 0a2f0e31..3780f42a 100644 --- a/glm/gtx/verbose_operator.hpp +++ b/glm/gtx/verbose_operator.hpp @@ -51,27 +51,27 @@ namespace glm /// @{ //! Addition of two values - //! From GLM_GTX_verbose_operator extension. + /// @see gtx_verbose_operator extension. template genTypeT add(genTypeT const & a, genTypeU const & b); //! Substration of two values - //! From GLM_GTX_verbose_operator extension. + /// @see gtx_verbose_operator extension. template genTypeT sub(genTypeT const & a, genTypeU const & b); //! Multiplication of two values - //! From GLM_GTX_verbose_operator extension. + /// @see gtx_verbose_operator extension. template genTypeT mul(genTypeT const & a, genTypeU const & b); //! Division of two values - //! From GLM_GTX_verbose_operator extension. + /// @see gtx_verbose_operator extension. template genTypeT div(genTypeT const & a, genTypeU const & b); //! Multiplication and addition of three values - //! From GLM_GTX_verbose_operator extension. + /// @see gtx_verbose_operator extension. template genTypeT mad(genTypeT const & a, genTypeU const & b, genTypeV const & c); diff --git a/glm/gtx/wrap.hpp b/glm/gtx/wrap.hpp index a6713273..5b29008b 100644 --- a/glm/gtx/wrap.hpp +++ b/glm/gtx/wrap.hpp @@ -50,18 +50,18 @@ namespace glm /// @addtogroup gtx_wrap /// @{ - //! Simulate GL_CLAMP OpenGL wrap mode - //! From GLM_GTX_wrap extension. + /// Simulate GL_CLAMP OpenGL wrap mode + /// @see gtx_wrap extension. template genType clamp(genType const & Texcoord); - //! Simulate GL_REPEAT OpenGL wrap mode - //! From GLM_GTX_wrap extension. + /// Simulate GL_REPEAT OpenGL wrap mode + /// @see gtx_wrap extension. template genType repeat(genType const & Texcoord); - //! Simulate GL_MIRROR_REPEAT OpenGL wrap mode - //! From GLM_GTX_wrap extension. + /// Simulate GL_MIRROR_REPEAT OpenGL wrap mode + /// @see gtx_wrap extension. template genType mirrorRepeat(genType const & Texcoord);