diff --git a/glm/common.hpp b/glm/common.hpp index 39318769..fa5a5088 100644 --- a/glm/common.hpp +++ b/glm/common.hpp @@ -138,25 +138,9 @@ namespace glm template GLM_FUNC_DECL vec fract(vec const& x); - /// Modulus. Returns x - y * floor(x / y) - /// for each component in x using the floating point value y. - /// - /// @tparam genType Floating-point scalar or vector types. - /// - /// @see GLSL mod man page - /// @see GLSL 4.20.8 specification, section 8.3 Common Functions template GLM_FUNC_DECL genType mod(genType x, genType y); - /// Modulus. Returns x - y * floor(x / y) - /// for each component in x using the floating point value y. - /// - /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector - /// @tparam T Floating-point scalar types - /// @tparam Q Value from qualifier enum - /// - /// @see GLSL mod man page - /// @see GLSL 4.20.8 specification, section 8.3 Common Functions template GLM_FUNC_DECL vec mod(vec const& x, T y); @@ -164,7 +148,7 @@ namespace glm /// for each component in x using the floating point value y. /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector - /// @tparam T Floating-point scalar types + /// @tparam T Floating-point scalar types, include glm/gtc/integer for integer scalar types support /// @tparam Q Value from qualifier enum /// /// @see GLSL mod man page diff --git a/glm/gtc/integer.hpp b/glm/gtc/integer.hpp index a8e4b7a8..c231d543 100644 --- a/glm/gtc/integer.hpp +++ b/glm/gtc/integer.hpp @@ -35,36 +35,12 @@ namespace glm template GLM_FUNC_DECL genIUType log2(genIUType x); - /// Modulus. Returns x % y - /// for each component in x using the floating point value y. - /// - /// @tparam genIUType Integer-point scalar or vector types. - /// - /// @see gtc_integer - /// @see GLSL mod man page - /// @see GLSL 4.20.8 specification, section 8.3 Common Functions template GLM_FUNC_DECL genIUType mod(genIUType x, genIUType y); - /// Modulus. Returns x % y - /// for each component in x using the floating point value y. - /// - /// @tparam T Integer scalar types. - /// - /// @see gtc_integer - /// @see GLSL mod man page - /// @see GLSL 4.20.8 specification, section 8.3 Common Functions template GLM_FUNC_DECL vec mod(vec const& x, T y); - /// Modulus. Returns x % y - /// for each component in x using the floating point value y. - /// - /// @tparam T Integer scalar types. - /// - /// @see gtc_integer - /// @see GLSL mod man page - /// @see GLSL 4.20.8 specification, section 8.3 Common Functions template GLM_FUNC_DECL vec mod(vec const& x, vec const& y); diff --git a/glm/gtc/round.hpp b/glm/gtc/round.hpp index 5947e167..d8d04c3e 100644 --- a/glm/gtc/round.hpp +++ b/glm/gtc/round.hpp @@ -34,7 +34,7 @@ namespace glm /// /// @see gtc_round template - GLM_FUNC_DECL bool isPowerOfTwo(genIUType Value); + GLM_FUNC_DECL bool isPowerOfTwo(genIUType v); /// Return true if the value is a power of two number. /// @@ -44,14 +44,14 @@ namespace glm /// /// @see gtc_round template - GLM_FUNC_DECL vec isPowerOfTwo(vec const& value); + GLM_FUNC_DECL vec isPowerOfTwo(vec const& v); /// Return the power of two number which value is just higher the input value, /// round up to a power of two. /// /// @see gtc_round template - GLM_FUNC_DECL genIUType ceilPowerOfTwo(genIUType Value); + GLM_FUNC_DECL genIUType ceilPowerOfTwo(genIUType v); /// Return the power of two number which value is just higher the input value, /// round up to a power of two. @@ -62,14 +62,14 @@ namespace glm /// /// @see gtc_round template - GLM_FUNC_DECL vec ceilPowerOfTwo(vec const& value); + GLM_FUNC_DECL vec ceilPowerOfTwo(vec const& v); /// Return the power of two number which value is just lower the input value, /// round down to a power of two. /// /// @see gtc_round template - GLM_FUNC_DECL genIUType floorPowerOfTwo(genIUType Value); + GLM_FUNC_DECL genIUType floorPowerOfTwo(genIUType v); /// Return the power of two number which value is just lower the input value, /// round down to a power of two. @@ -80,13 +80,13 @@ namespace glm /// /// @see gtc_round template - GLM_FUNC_DECL vec floorPowerOfTwo(vec const& value); + GLM_FUNC_DECL vec floorPowerOfTwo(vec const& v); /// Return the power of two number which value is the closet to the input value. /// /// @see gtc_round template - GLM_FUNC_DECL genIUType roundPowerOfTwo(genIUType Value); + GLM_FUNC_DECL genIUType roundPowerOfTwo(genIUType v); /// Return the power of two number which value is the closet to the input value. /// @@ -96,13 +96,13 @@ namespace glm /// /// @see gtc_round template - GLM_FUNC_DECL vec roundPowerOfTwo(vec const& value); + GLM_FUNC_DECL vec roundPowerOfTwo(vec const& v); /// Return true if the 'Value' is a multiple of 'Multiple'. /// /// @see gtc_round template - GLM_FUNC_DECL bool isMultiple(genIUType Value, genIUType Multiple); + GLM_FUNC_DECL bool isMultiple(genIUType v, genIUType Multiple); /// Return true if the 'Value' is a multiple of 'Multiple'. /// @@ -112,7 +112,7 @@ namespace glm /// /// @see gtc_round template - GLM_FUNC_DECL vec isMultiple(vec const& Value, T Multiple); + GLM_FUNC_DECL vec isMultiple(vec const& v, T Multiple); /// Return true if the 'Value' is a multiple of 'Multiple'. /// @@ -122,67 +122,79 @@ namespace glm /// /// @see gtc_round template - GLM_FUNC_DECL vec isMultiple(vec const& Value, vec const& Multiple); + GLM_FUNC_DECL vec isMultiple(vec const& v, vec const& Multiple); /// Higher multiple number of Source. /// /// @tparam genType Floating-point or integer scalar or vector types. + /// + /// @param v Source value to which is applied the function /// @param Multiple Must be a null or positive value /// /// @see gtc_round template - GLM_FUNC_DECL genType ceilMultiple(genType Source, genType Multiple); + GLM_FUNC_DECL genType ceilMultiple(genType v, genType Multiple); /// Higher multiple number of Source. /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point or integer scalar types /// @tparam Q Value from qualifier enum + /// + /// @param v Source values to which is applied the function /// @param Multiple Must be a null or positive value /// /// @see gtc_round template - GLM_FUNC_DECL vec ceilMultiple(vec const& Source, vec const& Multiple); + GLM_FUNC_DECL vec ceilMultiple(vec const& v, vec const& Multiple); /// Lower multiple number of Source. /// /// @tparam genType Floating-point or integer scalar or vector types. + /// + /// @param v Source value to which is applied the function /// @param Multiple Must be a null or positive value /// /// @see gtc_round template - GLM_FUNC_DECL genType floorMultiple(genType Source, genType Multiple); + GLM_FUNC_DECL genType floorMultiple(genType v, genType Multiple); /// Lower multiple number of Source. /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point or integer scalar types /// @tparam Q Value from qualifier enum + /// + /// @param v Source values to which is applied the function /// @param Multiple Must be a null or positive value /// /// @see gtc_round template - GLM_FUNC_DECL vec floorMultiple(vec const& Source, vec const& Multiple); + GLM_FUNC_DECL vec floorMultiple(vec const& v, vec const& Multiple); /// Lower multiple number of Source. /// /// @tparam genType Floating-point or integer scalar or vector types. + /// + /// @param v Source value to which is applied the function /// @param Multiple Must be a null or positive value /// /// @see gtc_round template - GLM_FUNC_DECL genType roundMultiple(genType Source, genType Multiple); + GLM_FUNC_DECL genType roundMultiple(genType v, genType Multiple); /// Lower multiple number of Source. /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point or integer scalar types /// @tparam Q Value from qualifier enum + /// + /// @param v Source values to which is applied the function /// @param Multiple Must be a null or positive value /// /// @see gtc_round template - GLM_FUNC_DECL vec roundMultiple(vec const& Source, vec const& Multiple); + GLM_FUNC_DECL vec roundMultiple(vec const& v, vec const& Multiple); /// @} } //namespace glm