diff --git a/glm/detail/func_common.hpp b/glm/detail/func_common.hpp index 483fe2a9..ac19db82 100644 --- a/glm/detail/func_common.hpp +++ b/glm/detail/func_common.hpp @@ -6,6 +6,8 @@ /// @defgroup core_func_common Common functions /// @ingroup core /// +/// Include to use these core features. +/// /// These all operate component-wise. The description is per component. #pragma once diff --git a/glm/detail/func_exponential.hpp b/glm/detail/func_exponential.hpp index 8de5839e..9bb415b9 100644 --- a/glm/detail/func_exponential.hpp +++ b/glm/detail/func_exponential.hpp @@ -6,6 +6,8 @@ /// @defgroup core_func_exponential Exponential functions /// @ingroup core /// +/// Include to use these core features. +/// /// These all operate component-wise. The description is per component. #pragma once diff --git a/glm/detail/func_geometric.hpp b/glm/detail/func_geometric.hpp index 1bc5a6b5..17df9f2f 100644 --- a/glm/detail/func_geometric.hpp +++ b/glm/detail/func_geometric.hpp @@ -6,6 +6,8 @@ /// @defgroup core_func_geometric Geometric functions /// @ingroup core /// +/// Include to use these core features. +/// /// These operate on vectors as vectors, not component-wise. #pragma once diff --git a/glm/detail/func_integer.hpp b/glm/detail/func_integer.hpp index 5690afe1..857bc37d 100644 --- a/glm/detail/func_integer.hpp +++ b/glm/detail/func_integer.hpp @@ -6,6 +6,8 @@ /// @defgroup core_func_integer Integer functions /// @ingroup core /// +/// Include to use these core features. +/// /// These all operate component-wise. The description is per component. /// The notation [a, b] means the set of bits from bit-number a through bit-number /// b, inclusive. The lowest-order bit is bit 0. diff --git a/glm/detail/func_matrix.hpp b/glm/detail/func_matrix.hpp index c37d10e3..aafd1e73 100644 --- a/glm/detail/func_matrix.hpp +++ b/glm/detail/func_matrix.hpp @@ -6,6 +6,8 @@ /// @defgroup core_func_matrix Matrix functions /// @ingroup core /// +/// Include to use these core features. +/// /// For each of the following built-in matrix functions, there is both a /// single-qualifier floating point version, where all arguments and return values /// are single qualifier, and a double-qualifier floating version, where all diff --git a/glm/detail/func_packing.hpp b/glm/detail/func_packing.hpp index 55e63049..6e85c8a4 100644 --- a/glm/detail/func_packing.hpp +++ b/glm/detail/func_packing.hpp @@ -7,6 +7,8 @@ /// @defgroup core_func_packing Floating-Point Pack and Unpack Functions /// @ingroup core /// +/// Include to use these core features. +/// /// These functions do not operate component-wise, rather as described in each case. #pragma once diff --git a/glm/detail/func_trigonometric.hpp b/glm/detail/func_trigonometric.hpp index 68e9024c..c66c992d 100644 --- a/glm/detail/func_trigonometric.hpp +++ b/glm/detail/func_trigonometric.hpp @@ -6,6 +6,8 @@ /// @defgroup core_func_trigonometric Angle and Trigonometry Functions /// @ingroup core /// +/// Include to use these core features. +/// /// Function parameters specified as angle are assumed to be in units of radians. /// In no case will any of these functions result in a divide by zero error. If /// the divisor of a ratio is 0, then results will be undefined. diff --git a/glm/detail/func_vector_relational.hpp b/glm/detail/func_vector_relational.hpp index ce2c980c..0d8cd129 100644 --- a/glm/detail/func_vector_relational.hpp +++ b/glm/detail/func_vector_relational.hpp @@ -6,6 +6,8 @@ /// @defgroup core_func_vector_relational Vector Relational Functions /// @ingroup core /// +/// Include to use these core features. +/// /// Relational and equality operators (<, <=, >, >=, ==, !=) are defined to /// operate on scalars and produce scalar Boolean results. For vector results, /// use the following built-in functions. diff --git a/glm/ext.hpp b/glm/ext.hpp index 64574541..aa1732d0 100644 --- a/glm/ext.hpp +++ b/glm/ext.hpp @@ -40,7 +40,6 @@ #include "./gtc/color_space.hpp" #include "./gtc/constants.hpp" #include "./gtc/epsilon.hpp" -#include "./gtc/functions.hpp" #include "./gtc/integer.hpp" #include "./gtc/matrix_access.hpp" #include "./gtc/matrix_integer.hpp" @@ -77,6 +76,7 @@ #include "./gtx/fast_exponential.hpp" #include "./gtx/fast_square_root.hpp" #include "./gtx/fast_trigonometry.hpp" +#include "./gtx/functions.hpp" #include "./gtx/gradient_paint.hpp" #include "./gtx/handed_coordinate_space.hpp" #include "./gtx/integer.hpp" diff --git a/glm/gtc/bitfield.hpp b/glm/gtc/bitfield.hpp index 93fb1080..cfc9667e 100644 --- a/glm/gtc/bitfield.hpp +++ b/glm/gtc/bitfield.hpp @@ -7,9 +7,9 @@ /// @defgroup gtc_bitfield GLM_GTC_bitfield /// @ingroup gtc /// -/// @brief Allow to perform bit operations on integer values +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Allow to perform bit operations on integer values #include "../detail/setup.hpp" diff --git a/glm/gtc/color_space.hpp b/glm/gtc/color_space.hpp index 3d9a5715..56cbc8fc 100644 --- a/glm/gtc/color_space.hpp +++ b/glm/gtc/color_space.hpp @@ -7,9 +7,9 @@ /// @defgroup gtc_color_space GLM_GTC_color_space /// @ingroup gtc /// -/// @brief Allow to perform bit operations on integer values +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Allow to perform bit operations on integer values #pragma once diff --git a/glm/gtc/constants.hpp b/glm/gtc/constants.hpp index dd8f2856..482cf8dc 100644 --- a/glm/gtc/constants.hpp +++ b/glm/gtc/constants.hpp @@ -5,10 +5,10 @@ /// /// @defgroup gtc_constants GLM_GTC_constants /// @ingroup gtc +/// +/// Include to use the features of this extension. /// -/// @brief Provide a list of constants and precomputed useful values. -/// -/// need to be included to use these features. +/// Provide a list of constants and precomputed useful values. #pragma once diff --git a/glm/gtc/epsilon.hpp b/glm/gtc/epsilon.hpp index 9cf6fc30..8e932a44 100644 --- a/glm/gtc/epsilon.hpp +++ b/glm/gtc/epsilon.hpp @@ -6,10 +6,10 @@ /// /// @defgroup gtc_epsilon GLM_GTC_epsilon /// @ingroup gtc +/// +/// Include to use the features of this extension. /// -/// @brief Comparison functions for a user defined epsilon values. -/// -/// need to be included to use these functionalities. +/// Comparison functions for a user defined epsilon values. #pragma once diff --git a/glm/gtc/integer.hpp b/glm/gtc/integer.hpp index 5778e5de..c598fdb3 100644 --- a/glm/gtc/integer.hpp +++ b/glm/gtc/integer.hpp @@ -7,9 +7,9 @@ /// @defgroup gtc_integer GLM_GTC_integer /// @ingroup gtc /// -/// @brief Allow to perform bit operations on integer values +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// @brief Allow to perform bit operations on integer values #pragma once diff --git a/glm/gtc/matrix_access.hpp b/glm/gtc/matrix_access.hpp index 48beb8b8..3a67cff6 100644 --- a/glm/gtc/matrix_access.hpp +++ b/glm/gtc/matrix_access.hpp @@ -5,9 +5,10 @@ /// /// @defgroup gtc_matrix_access GLM_GTC_matrix_access /// @ingroup gtc -/// +/// +/// Include to use the features of this extension. +/// /// Defines functions to access rows or columns of a matrix easily. -/// need to be included to use these functionalities. #pragma once diff --git a/glm/gtc/matrix_integer.hpp b/glm/gtc/matrix_integer.hpp index 13139b84..863b7b40 100644 --- a/glm/gtc/matrix_integer.hpp +++ b/glm/gtc/matrix_integer.hpp @@ -6,8 +6,9 @@ /// @defgroup gtc_matrix_integer GLM_GTC_matrix_integer /// @ingroup gtc /// +/// Include to use the features of this extension. +/// /// Defines a number of matrices with integer types. -/// need to be included to use these functionalities. #pragma once diff --git a/glm/gtc/matrix_inverse.hpp b/glm/gtc/matrix_inverse.hpp index 1f64efeb..0350c1d6 100644 --- a/glm/gtc/matrix_inverse.hpp +++ b/glm/gtc/matrix_inverse.hpp @@ -6,8 +6,9 @@ /// @defgroup gtc_matrix_inverse GLM_GTC_matrix_inverse /// @ingroup gtc /// +/// Include to use the features of this extension. +/// /// Defines additional matrix inverting functions. -/// need to be included to use these functionalities. #pragma once diff --git a/glm/gtc/matrix_transform.hpp b/glm/gtc/matrix_transform.hpp index c1caf04f..0d620b94 100644 --- a/glm/gtc/matrix_transform.hpp +++ b/glm/gtc/matrix_transform.hpp @@ -8,15 +8,15 @@ /// @defgroup gtc_matrix_transform GLM_GTC_matrix_transform /// @ingroup gtc /// -/// @brief Defines functions that generate common transformation matrices. +/// Include to use the features of this extension. +/// +/// Defines functions that generate common transformation matrices. /// /// The matrices generated by this extension use standard OpenGL fixed-function /// conventions. For example, the lookAt function generates a transform from world /// space into the specific eye space that the projective matrix functions /// (perspective, ortho, etc) are designed to expect. The OpenGL compatibility /// specifications defines the particular layout of this eye space. -/// -/// need to be included to use these functionalities. #pragma once diff --git a/glm/gtc/noise.hpp b/glm/gtc/noise.hpp index b80124ed..b4a33bb6 100644 --- a/glm/gtc/noise.hpp +++ b/glm/gtc/noise.hpp @@ -6,12 +6,13 @@ /// @defgroup gtc_noise GLM_GTC_noise /// @ingroup gtc /// +/// Include to use the features of this extension. +/// /// Defines 2D, 3D and 4D procedural noise functions /// Based on the work of Stefan Gustavson and Ashima Arts on "webgl-noise": /// https://github.com/ashima/webgl-noise /// Following Stefan Gustavson's paper "Simplex noise demystified": /// http://www.itn.liu.se/~stegu/simplexnoise/simplexnoise.pdf -/// need to be included to use these functionalities. #pragma once diff --git a/glm/gtc/packing.hpp b/glm/gtc/packing.hpp index ac529c2b..ebc80b56 100644 --- a/glm/gtc/packing.hpp +++ b/glm/gtc/packing.hpp @@ -6,10 +6,10 @@ /// @defgroup gtc_packing GLM_GTC_packing /// @ingroup gtc /// -/// @brief This extension provides a set of function to convert vertors to packed -/// formats. +/// Include to use the features of this extension. /// -/// need to be included to use these features. +/// This extension provides a set of function to convert vertors to packed +/// formats. #pragma once diff --git a/glm/gtc/quaternion.hpp b/glm/gtc/quaternion.hpp index 34e3d568..b43ec04d 100644 --- a/glm/gtc/quaternion.hpp +++ b/glm/gtc/quaternion.hpp @@ -7,9 +7,9 @@ /// @defgroup gtc_quaternion GLM_GTC_quaternion /// @ingroup gtc /// -/// @brief Defines a templated quaternion type and several quaternion operations. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Defines a templated quaternion type and several quaternion operations. #pragma once diff --git a/glm/gtc/random.hpp b/glm/gtc/random.hpp index 65adb18a..fdda8313 100644 --- a/glm/gtc/random.hpp +++ b/glm/gtc/random.hpp @@ -7,9 +7,9 @@ /// @defgroup gtc_random GLM_GTC_random /// @ingroup gtc /// -/// @brief Generate random number from various distribution methods. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Generate random number from various distribution methods. #pragma once diff --git a/glm/gtc/reciprocal.hpp b/glm/gtc/reciprocal.hpp index 6b09e06b..848f5c94 100644 --- a/glm/gtc/reciprocal.hpp +++ b/glm/gtc/reciprocal.hpp @@ -6,9 +6,9 @@ /// @defgroup gtc_reciprocal GLM_GTC_reciprocal /// @ingroup gtc /// -/// @brief Define secant, cosecant and cotangent functions. +/// Include to use the features of this extension. /// -/// need to be included to use these features. +/// Define secant, cosecant and cotangent functions. #pragma once diff --git a/glm/gtc/round.hpp b/glm/gtc/round.hpp index 77bcabd8..5947e167 100644 --- a/glm/gtc/round.hpp +++ b/glm/gtc/round.hpp @@ -7,9 +7,9 @@ /// @defgroup gtc_round GLM_GTC_round /// @ingroup gtc /// -/// @brief rounding value to specific boundings +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Rounding value to specific boundings #pragma once diff --git a/glm/gtc/type_aligned.hpp b/glm/gtc/type_aligned.hpp index 73ce3d5d..7e51ce19 100644 --- a/glm/gtc/type_aligned.hpp +++ b/glm/gtc/type_aligned.hpp @@ -6,8 +6,9 @@ /// @defgroup gtc_type_aligned GLM_GTC_type_aligned /// @ingroup gtc /// -/// @brief Aligned types. -/// need to be included to use these features. +/// Include to use the features of this extension. +/// +/// Aligned types allowing SIMD optimizations of vectors and matrices types #pragma once diff --git a/glm/gtc/type_precision.hpp b/glm/gtc/type_precision.hpp index 4efcc5ac..e442dc5a 100644 --- a/glm/gtc/type_precision.hpp +++ b/glm/gtc/type_precision.hpp @@ -7,12 +7,12 @@ /// @defgroup gtc_type_precision GLM_GTC_type_precision /// @ingroup gtc /// -/// @brief Defines specific C++-based qualifier types. +/// Include to use the features of this extension. +/// +/// Defines specific C++-based qualifier types. /// /// @ref core_precision defines types based on GLSL's qualifier qualifiers. This /// extension defines types based on explicitly-sized C++ data types. -/// -/// need to be included to use these functionalities. #pragma once diff --git a/glm/gtc/type_ptr.hpp b/glm/gtc/type_ptr.hpp index a9b13044..31baf0a8 100644 --- a/glm/gtc/type_ptr.hpp +++ b/glm/gtc/type_ptr.hpp @@ -7,7 +7,9 @@ /// @defgroup gtc_type_ptr GLM_GTC_type_ptr /// @ingroup gtc /// -/// @brief Handles the interaction between pointers and vector, matrix types. +/// Include to use the features of this extension. +/// +/// Handles the interaction between pointers and vector, matrix types. /// /// This extension defines an overloaded function, glm::value_ptr, which /// takes any of the \ref core_template "core template types". It returns @@ -28,7 +30,7 @@ /// glUniformMatrix4fv(uniformMatrixLoc, 1, GL_FALSE, glm::value_ptr(someMatrix)); /// @endcode /// -/// need to be included to use these functionalities. +/// need to be included to use the features of this extension. #pragma once diff --git a/glm/gtc/ulp.hpp b/glm/gtc/ulp.hpp index b9c6a6c4..648a4ab4 100644 --- a/glm/gtc/ulp.hpp +++ b/glm/gtc/ulp.hpp @@ -6,10 +6,11 @@ /// @defgroup gtc_ulp GLM_GTC_ulp /// @ingroup gtc /// -/// @brief Allow the measurement of the accuracy of a function against a reference +/// Include to use the features of this extension. +/// +/// Allow the measurement of the accuracy of a function against a reference /// implementation. This extension works on floating-point data and provide results /// in ULP. -/// need to be included to use these features. #pragma once diff --git a/glm/gtc/vec1.hpp b/glm/gtc/vec1.hpp index 21a882a7..77d3dff0 100644 --- a/glm/gtc/vec1.hpp +++ b/glm/gtc/vec1.hpp @@ -5,9 +5,10 @@ /// /// @defgroup gtc_vec1 GLM_GTC_vec1 /// @ingroup gtc +/// +/// Include to use the features of this extension. /// -/// @brief Add vec1, ivec1, uvec1 and bvec1 types. -/// need to be included to use these functionalities. +/// Add vec1, ivec1, uvec1 and bvec1 types. #pragma once diff --git a/glm/gtx/associated_min_max.hpp b/glm/gtx/associated_min_max.hpp index c5e2f12e..0c9935f3 100644 --- a/glm/gtx/associated_min_max.hpp +++ b/glm/gtx/associated_min_max.hpp @@ -6,9 +6,10 @@ /// /// @defgroup gtx_associated_min_max GLM_GTX_associated_min_max /// @ingroup gtx +/// +/// Include to use the features of this extension. /// /// @brief Min and max functions that return associated values not the compared onces. -/// need to be included to use these functionalities. #pragma once diff --git a/glm/gtx/bit.hpp b/glm/gtx/bit.hpp index ccbd5f69..1447fa00 100644 --- a/glm/gtx/bit.hpp +++ b/glm/gtx/bit.hpp @@ -5,10 +5,10 @@ /// /// @defgroup gtx_bit GLM_GTX_bit /// @ingroup gtx +/// +/// Include to use the features of this extension. /// -/// @brief Allow to perform bit operations on integer values -/// -/// need to be included to use these functionalities. +/// Allow to perform bit operations on integer values #pragma once diff --git a/glm/gtx/closest_point.hpp b/glm/gtx/closest_point.hpp index 3b4ba1c0..6859bb96 100644 --- a/glm/gtx/closest_point.hpp +++ b/glm/gtx/closest_point.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_closest_point GLM_GTX_closest_point /// @ingroup gtx /// -/// @brief Find the point on a straight line which is the closet of a point. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Find the point on a straight line which is the closet of a point. #pragma once diff --git a/glm/gtx/color_encoding.hpp b/glm/gtx/color_encoding.hpp index a094bc37..b57b3beb 100644 --- a/glm/gtx/color_encoding.hpp +++ b/glm/gtx/color_encoding.hpp @@ -7,9 +7,9 @@ /// @defgroup gtx_color_encoding GLM_GTX_color_encoding /// @ingroup gtx /// -/// @brief Allow to perform bit operations on integer values +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// @brief Allow to perform bit operations on integer values #pragma once diff --git a/glm/gtx/color_space.hpp b/glm/gtx/color_space.hpp index de7df32b..d1e655c3 100644 --- a/glm/gtx/color_space.hpp +++ b/glm/gtx/color_space.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_color_space GLM_GTX_color_space /// @ingroup gtx /// -/// @brief Related to RGB to HSV conversions and operations. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Related to RGB to HSV conversions and operations. #pragma once diff --git a/glm/gtx/color_space_YCoCg.hpp b/glm/gtx/color_space_YCoCg.hpp index 0a701adf..e82cbd8b 100644 --- a/glm/gtx/color_space_YCoCg.hpp +++ b/glm/gtx/color_space_YCoCg.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_color_space_YCoCg GLM_GTX_color_space_YCoCg /// @ingroup gtx /// -/// @brief RGB to YCoCg conversions and operations +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// RGB to YCoCg conversions and operations #pragma once diff --git a/glm/gtx/common.hpp b/glm/gtx/common.hpp index 25e4517b..8081bff7 100644 --- a/glm/gtx/common.hpp +++ b/glm/gtx/common.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_common GLM_GTX_common /// @ingroup gtx /// -/// @brief Provide functions to increase the compatibility with Cg and HLSL languages +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// @brief Provide functions to increase the compatibility with Cg and HLSL languages #pragma once diff --git a/glm/gtx/compatibility.hpp b/glm/gtx/compatibility.hpp index d5a6ee22..e5b60399 100644 --- a/glm/gtx/compatibility.hpp +++ b/glm/gtx/compatibility.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_compatibility GLM_GTX_compatibility /// @ingroup gtx /// -/// @brief Provide functions to increase the compatibility with Cg and HLSL languages +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Provide functions to increase the compatibility with Cg and HLSL languages #pragma once diff --git a/glm/gtx/component_wise.hpp b/glm/gtx/component_wise.hpp index fc52d1cd..39bab5d5 100644 --- a/glm/gtx/component_wise.hpp +++ b/glm/gtx/component_wise.hpp @@ -8,9 +8,9 @@ /// @defgroup gtx_component_wise GLM_GTX_component_wise /// @ingroup gtx /// -/// @brief Operations between components of a type +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Operations between components of a type #pragma once diff --git a/glm/gtx/dual_quaternion.hpp b/glm/gtx/dual_quaternion.hpp index 5ca9a752..c4343e9d 100644 --- a/glm/gtx/dual_quaternion.hpp +++ b/glm/gtx/dual_quaternion.hpp @@ -9,9 +9,9 @@ /// @defgroup gtx_dual_quaternion GLM_GTX_dual_quaternion /// @ingroup gtx /// -/// @brief Defines a templated dual-quaternion type and several dual-quaternion operations. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Defines a templated dual-quaternion type and several dual-quaternion operations. #pragma once diff --git a/glm/gtx/euler_angles.hpp b/glm/gtx/euler_angles.hpp index 9486065a..e66e9281 100644 --- a/glm/gtx/euler_angles.hpp +++ b/glm/gtx/euler_angles.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_euler_angles GLM_GTX_euler_angles /// @ingroup gtx /// -/// @brief Build matrices from Euler angles. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Build matrices from Euler angles. #pragma once diff --git a/glm/gtx/extend.hpp b/glm/gtx/extend.hpp index 078b7429..eda4e470 100644 --- a/glm/gtx/extend.hpp +++ b/glm/gtx/extend.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_extend GLM_GTX_extend /// @ingroup gtx /// -/// @brief Extend a position from a source to a position at a defined length. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Extend a position from a source to a position at a defined length. #pragma once diff --git a/glm/gtx/extended_min_max.hpp b/glm/gtx/extended_min_max.hpp index 9525ba72..4103d1db 100644 --- a/glm/gtx/extended_min_max.hpp +++ b/glm/gtx/extended_min_max.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_extented_min_max GLM_GTX_extented_min_max /// @ingroup gtx /// -/// Min and max functions for 3 to 4 parameters. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Min and max functions for 3 to 4 parameters. #pragma once diff --git a/glm/gtx/exterior_product.hpp b/glm/gtx/exterior_product.hpp index c5a9d60d..8376a520 100644 --- a/glm/gtx/exterior_product.hpp +++ b/glm/gtx/exterior_product.hpp @@ -6,10 +6,10 @@ /// /// @defgroup gtx_exterior_product GLM_GTX_exterior_product /// @ingroup gtx +/// +/// Include to use the features of this extension. /// /// @brief Allow to perform bit operations on integer values -/// -/// need to be included to use these functionalities. #pragma once diff --git a/glm/gtx/fast_exponential.hpp b/glm/gtx/fast_exponential.hpp index 2bf9dc54..2d4918e7 100644 --- a/glm/gtx/fast_exponential.hpp +++ b/glm/gtx/fast_exponential.hpp @@ -7,9 +7,9 @@ /// @defgroup gtx_fast_exponential GLM_GTX_fast_exponential /// @ingroup gtx /// -/// @brief Fast but less accurate implementations of exponential based functions. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Fast but less accurate implementations of exponential based functions. #pragma once diff --git a/glm/gtx/fast_square_root.hpp b/glm/gtx/fast_square_root.hpp index 994f1f90..1e1ec3cf 100644 --- a/glm/gtx/fast_square_root.hpp +++ b/glm/gtx/fast_square_root.hpp @@ -6,11 +6,11 @@ /// @defgroup gtx_fast_square_root GLM_GTX_fast_square_root /// @ingroup gtx /// -/// @brief Fast but less accurate implementations of square root based functions. +/// Include to use the features of this extension. +/// +/// Fast but less accurate implementations of square root based functions. /// - Sqrt optimisation based on Newton's method, /// www.gamedev.net/community/forums/topic.asp?topic id=139956 -/// -/// need to be included to use these functionalities. #pragma once diff --git a/glm/gtx/fast_trigonometry.hpp b/glm/gtx/fast_trigonometry.hpp index d78de725..739065fb 100644 --- a/glm/gtx/fast_trigonometry.hpp +++ b/glm/gtx/fast_trigonometry.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_fast_trigonometry GLM_GTX_fast_trigonometry /// @ingroup gtx /// -/// @brief Fast but less accurate implementations of trigonometric functions. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Fast but less accurate implementations of trigonometric functions. #pragma once diff --git a/glm/gtc/functions.hpp b/glm/gtx/functions.hpp similarity index 68% rename from glm/gtc/functions.hpp rename to glm/gtx/functions.hpp index 7f8260ad..afe816e6 100644 --- a/glm/gtc/functions.hpp +++ b/glm/gtx/functions.hpp @@ -1,15 +1,15 @@ -/// @ref gtc_functions -/// @file glm/gtc/functions.hpp +/// @ref gtx_functions +/// @file glm/gtx/functions.hpp /// /// @see core (dependence) /// @see gtc_quaternion (dependence) /// -/// @defgroup gtc_functions GLM_GTC_functions -/// @ingroup gtc +/// @defgroup gtx_functions GLM_GTX_functions +/// @ingroup gtx +/// +/// Include to use the features of this extension. /// -/// @brief List of useful common functions. -/// -/// need to be included to use these functionalities. +/// List of useful common functions. #pragma once @@ -19,12 +19,12 @@ #include "../detail/type_vec2.hpp" #if GLM_MESSAGES == GLM_MESSAGES_ENABLED && !defined(GLM_EXT_INCLUDED) -# pragma message("GLM: GLM_GTC_functions extension included") +# pragma message("GLM: GLM_GTX_functions extension included") #endif namespace glm { - /// @addtogroup gtc_functions + /// @addtogroup gtx_functions /// @{ /// 1D gauss function diff --git a/glm/gtc/functions.inl b/glm/gtx/functions.inl similarity index 93% rename from glm/gtc/functions.inl rename to glm/gtx/functions.inl index 4dc42aa1..ecd83967 100644 --- a/glm/gtc/functions.inl +++ b/glm/gtx/functions.inl @@ -1,5 +1,5 @@ -/// @ref gtc_functions -/// @file glm/gtc/functions.inl +/// @ref gtx_functions +/// @file glm/gtx/functions.inl #include "../detail/func_exponential.hpp" diff --git a/glm/gtx/gradient_paint.hpp b/glm/gtx/gradient_paint.hpp index ed1925be..2713cec0 100644 --- a/glm/gtx/gradient_paint.hpp +++ b/glm/gtx/gradient_paint.hpp @@ -7,8 +7,9 @@ /// @defgroup gtx_gradient_paint GLM_GTX_gradient_paint /// @ingroup gtx /// -/// @brief Functions that return the color of procedural gradient for specific coordinates. -/// need to be included to use these functionalities. +/// Include to use the features of this extension. +/// +/// Functions that return the color of procedural gradient for specific coordinates. #pragma once diff --git a/glm/gtx/handed_coordinate_space.hpp b/glm/gtx/handed_coordinate_space.hpp index e7dc9b35..1d0d4104 100644 --- a/glm/gtx/handed_coordinate_space.hpp +++ b/glm/gtx/handed_coordinate_space.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_handed_coordinate_space GLM_GTX_handed_coordinate_space /// @ingroup gtx /// -/// @brief To know if a set of three basis vectors defines a right or left-handed coordinate system. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// To know if a set of three basis vectors defines a right or left-handed coordinate system. #pragma once diff --git a/glm/gtx/hash.hpp b/glm/gtx/hash.hpp index ea051085..cfb79baa 100644 --- a/glm/gtx/hash.hpp +++ b/glm/gtx/hash.hpp @@ -5,10 +5,10 @@ /// /// @defgroup gtx_hash GLM_GTX_hash /// @ingroup gtx +/// +/// Include to use the features of this extension. /// -/// @brief Add std::hash support for glm types -/// -/// need to be included to use these functionalities. +/// Add std::hash support for glm types #pragma once diff --git a/glm/gtx/hash.inl b/glm/gtx/hash.inl index 33193165..5370e5d1 100644 --- a/glm/gtx/hash.inl +++ b/glm/gtx/hash.inl @@ -8,7 +8,7 @@ /// /// @brief Add std::hash support for glm types /// -/// need to be included to use these functionalities. +/// need to be included to use the features of this extension. namespace glm { namespace detail diff --git a/glm/gtx/integer.hpp b/glm/gtx/integer.hpp index 47a2ad3c..96637a13 100644 --- a/glm/gtx/integer.hpp +++ b/glm/gtx/integer.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_integer GLM_GTX_integer /// @ingroup gtx /// -/// @brief Add support for integer for core functions +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Add support for integer for core functions #pragma once diff --git a/glm/gtx/intersect.hpp b/glm/gtx/intersect.hpp index e331b228..851efa23 100644 --- a/glm/gtx/intersect.hpp +++ b/glm/gtx/intersect.hpp @@ -7,9 +7,9 @@ /// @defgroup gtx_intersect GLM_GTX_intersect /// @ingroup gtx /// -/// @brief Add intersection functions +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Add intersection functions #pragma once diff --git a/glm/gtx/io.hpp b/glm/gtx/io.hpp index 0f49bc2c..49a1ec11 100644 --- a/glm/gtx/io.hpp +++ b/glm/gtx/io.hpp @@ -8,14 +8,14 @@ /// /// @defgroup gtx_io GLM_GTX_io /// @ingroup gtx +/// +/// Include to use the features of this extension. /// -/// @brief std::[w]ostream support for glm types +/// std::[w]ostream support for glm types /// /// std::[w]ostream support for glm types + qualifier/width/etc. manipulators /// based on howard hinnant's std::chrono io proposal /// [http://home.roadrunner.com/~hinnant/bloomington/chrono_io.html] -/// -/// needs to be included to use these functionalities. #pragma once diff --git a/glm/gtx/log_base.hpp b/glm/gtx/log_base.hpp index 7e7847e8..e873e356 100644 --- a/glm/gtx/log_base.hpp +++ b/glm/gtx/log_base.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_log_base GLM_GTX_log_base /// @ingroup gtx /// -/// @brief Logarithm for any base. base can be a vector or a scalar. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Logarithm for any base. base can be a vector or a scalar. #pragma once diff --git a/glm/gtx/matrix_cross_product.hpp b/glm/gtx/matrix_cross_product.hpp index dda68832..967743b8 100644 --- a/glm/gtx/matrix_cross_product.hpp +++ b/glm/gtx/matrix_cross_product.hpp @@ -7,9 +7,9 @@ /// @defgroup gtx_matrix_cross_product GLM_GTX_matrix_cross_product /// @ingroup gtx /// -/// @brief Build cross product matrices +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Build cross product matrices #pragma once diff --git a/glm/gtx/matrix_decompose.hpp b/glm/gtx/matrix_decompose.hpp index 6ef92606..b7ec0e83 100644 --- a/glm/gtx/matrix_decompose.hpp +++ b/glm/gtx/matrix_decompose.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_matrix_decompose GLM_GTX_matrix_decompose /// @ingroup gtx /// -/// @brief Decomposes a model matrix to translations, rotation and scale components +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Decomposes a model matrix to translations, rotation and scale components #pragma once diff --git a/glm/gtx/matrix_factorisation.hpp b/glm/gtx/matrix_factorisation.hpp index e8b40c79..e30a7746 100644 --- a/glm/gtx/matrix_factorisation.hpp +++ b/glm/gtx/matrix_factorisation.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_matrix_factorisation GLM_GTX_matrix_factorisation /// @ingroup gtx /// -/// @brief Functions to factor matrices in various forms +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Functions to factor matrices in various forms #pragma once diff --git a/glm/gtx/matrix_interpolation.hpp b/glm/gtx/matrix_interpolation.hpp index fbd68ebd..69473d35 100644 --- a/glm/gtx/matrix_interpolation.hpp +++ b/glm/gtx/matrix_interpolation.hpp @@ -7,9 +7,9 @@ /// @defgroup gtx_matrix_interpolation GLM_GTX_matrix_interpolation /// @ingroup gtx /// -/// @brief Allows to directly interpolate two exiciting matrices. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Allows to directly interpolate two exiciting matrices. #pragma once diff --git a/glm/gtx/matrix_major_storage.hpp b/glm/gtx/matrix_major_storage.hpp index d722b0e9..7f264a59 100644 --- a/glm/gtx/matrix_major_storage.hpp +++ b/glm/gtx/matrix_major_storage.hpp @@ -7,9 +7,9 @@ /// @defgroup gtx_matrix_major_storage GLM_GTX_matrix_major_storage /// @ingroup gtx /// -/// @brief Build matrices with specific matrix order, row or column +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Build matrices with specific matrix order, row or column #pragma once diff --git a/glm/gtx/matrix_operation.hpp b/glm/gtx/matrix_operation.hpp index 66930421..bce938bb 100644 --- a/glm/gtx/matrix_operation.hpp +++ b/glm/gtx/matrix_operation.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_matrix_operation GLM_GTX_matrix_operation /// @ingroup gtx /// -/// @brief Build diagonal matrices from vectors. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Build diagonal matrices from vectors. #pragma once diff --git a/glm/gtx/matrix_query.hpp b/glm/gtx/matrix_query.hpp index 1fb41ca6..5df5f52f 100644 --- a/glm/gtx/matrix_query.hpp +++ b/glm/gtx/matrix_query.hpp @@ -7,9 +7,9 @@ /// @defgroup gtx_matrix_query GLM_GTX_matrix_query /// @ingroup gtx /// -/// @brief Query to evaluate matrix properties +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Query to evaluate matrix properties #pragma once diff --git a/glm/gtx/matrix_transform_2d.hpp b/glm/gtx/matrix_transform_2d.hpp index c0c31296..239ab9f4 100644 --- a/glm/gtx/matrix_transform_2d.hpp +++ b/glm/gtx/matrix_transform_2d.hpp @@ -7,9 +7,9 @@ /// @defgroup gtx_matrix_transform_2d GLM_GTX_matrix_transform_2d /// @ingroup gtx /// -/// @brief Defines functions that generate common 2d transformation matrices. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Defines functions that generate common 2d transformation matrices. #pragma once diff --git a/glm/gtx/mixed_product.hpp b/glm/gtx/mixed_product.hpp index f56895d8..58562aab 100644 --- a/glm/gtx/mixed_product.hpp +++ b/glm/gtx/mixed_product.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_mixed_product GLM_GTX_mixed_producte /// @ingroup gtx /// -/// @brief Mixed product of 3 vectors. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Mixed product of 3 vectors. #pragma once diff --git a/glm/gtx/norm.hpp b/glm/gtx/norm.hpp index 9cb9b294..fe47dbbb 100644 --- a/glm/gtx/norm.hpp +++ b/glm/gtx/norm.hpp @@ -7,9 +7,9 @@ /// @defgroup gtx_norm GLM_GTX_norm /// @ingroup gtx /// -/// @brief Various ways to compute vector norms. -/// -/// need to be included to use these functionalities. +/// Include to use the features of this extension. +/// +/// Various ways to compute vector norms. #pragma once diff --git a/glm/gtx/normal.hpp b/glm/gtx/normal.hpp index 08776254..15cec9c2 100644 --- a/glm/gtx/normal.hpp +++ b/glm/gtx/normal.hpp @@ -7,9 +7,9 @@ /// @defgroup gtx_normal GLM_GTX_normal /// @ingroup gtx /// -/// @brief Compute the normal of a triangle. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Compute the normal of a triangle. #pragma once diff --git a/glm/gtx/normalize_dot.hpp b/glm/gtx/normalize_dot.hpp index 02882dbd..86048e70 100644 --- a/glm/gtx/normalize_dot.hpp +++ b/glm/gtx/normalize_dot.hpp @@ -7,9 +7,9 @@ /// @defgroup gtx_normalize_dot GLM_GTX_normalize_dot /// @ingroup gtx /// -/// @brief Dot product of vectors that need to be normalize with a single square root. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Dot product of vectors that need to be normalize with a single square root. #pragma once diff --git a/glm/gtx/number_precision.hpp b/glm/gtx/number_precision.hpp index 54cb891f..3732a56c 100644 --- a/glm/gtx/number_precision.hpp +++ b/glm/gtx/number_precision.hpp @@ -8,9 +8,9 @@ /// @defgroup gtx_number_precision GLM_GTX_number_precision /// @ingroup gtx /// -/// @brief Defined size types. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Defined size types. #pragma once diff --git a/glm/gtx/optimum_pow.hpp b/glm/gtx/optimum_pow.hpp index 38e0327d..eb09f1c3 100644 --- a/glm/gtx/optimum_pow.hpp +++ b/glm/gtx/optimum_pow.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_optimum_pow GLM_GTX_optimum_pow /// @ingroup gtx /// -/// @brief Integer exponentiation of power functions. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Integer exponentiation of power functions. #pragma once diff --git a/glm/gtx/orthonormalize.hpp b/glm/gtx/orthonormalize.hpp index dd6494ab..2a684ee4 100644 --- a/glm/gtx/orthonormalize.hpp +++ b/glm/gtx/orthonormalize.hpp @@ -7,9 +7,9 @@ /// @defgroup gtx_orthonormalize GLM_GTX_orthonormalize /// @ingroup gtx /// -/// @brief Orthonormalize matrices. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Orthonormalize matrices. #pragma once diff --git a/glm/gtx/perpendicular.hpp b/glm/gtx/perpendicular.hpp index 6402a211..35601ac7 100644 --- a/glm/gtx/perpendicular.hpp +++ b/glm/gtx/perpendicular.hpp @@ -7,9 +7,9 @@ /// @defgroup gtx_perpendicular GLM_GTX_perpendicular /// @ingroup gtx /// -/// @brief Perpendicular of a vector from other one +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Perpendicular of a vector from other one #pragma once diff --git a/glm/gtx/polar_coordinates.hpp b/glm/gtx/polar_coordinates.hpp index 6e8ed9c6..b8421db4 100644 --- a/glm/gtx/polar_coordinates.hpp +++ b/glm/gtx/polar_coordinates.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_polar_coordinates GLM_GTX_polar_coordinates /// @ingroup gtx /// -/// @brief Conversion from Euclidean space to polar space and revert. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Conversion from Euclidean space to polar space and revert. #pragma once diff --git a/glm/gtx/projection.hpp b/glm/gtx/projection.hpp index a984f419..9a24abf9 100644 --- a/glm/gtx/projection.hpp +++ b/glm/gtx/projection.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_projection GLM_GTX_projection /// @ingroup gtx /// -/// @brief Projection of a vector to other one +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Projection of a vector to other one #pragma once diff --git a/glm/gtx/quaternion.hpp b/glm/gtx/quaternion.hpp index a4fcf486..fba1eb80 100644 --- a/glm/gtx/quaternion.hpp +++ b/glm/gtx/quaternion.hpp @@ -7,9 +7,9 @@ /// @defgroup gtx_quaternion GLM_GTX_quaternion /// @ingroup gtx /// -/// @brief Extented quaternion types and functions +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Extented quaternion types and functions #pragma once diff --git a/glm/gtx/range.hpp b/glm/gtx/range.hpp index 7e466f1e..3ab5faee 100644 --- a/glm/gtx/range.hpp +++ b/glm/gtx/range.hpp @@ -5,10 +5,10 @@ /// @defgroup gtx_range GLM_GTX_range /// @ingroup gtx /// -/// @brief Defines begin and end for vectors and matrices. Useful for range-based for loop. -/// The range is defined over the elements, not over columns or rows (e.g. mat4 has 16 elements). +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Defines begin and end for vectors and matrices. Useful for range-based for loop. +/// The range is defined over the elements, not over columns or rows (e.g. mat4 has 16 elements). #pragma once diff --git a/glm/gtx/raw_data.hpp b/glm/gtx/raw_data.hpp index 410a9771..fb34c8cb 100644 --- a/glm/gtx/raw_data.hpp +++ b/glm/gtx/raw_data.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_raw_data GLM_GTX_raw_data /// @ingroup gtx /// -/// @brief Projection of a vector to other one +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Projection of a vector to other one #pragma once diff --git a/glm/gtx/rotate_normalized_axis.hpp b/glm/gtx/rotate_normalized_axis.hpp index bd750e80..eee90d6e 100644 --- a/glm/gtx/rotate_normalized_axis.hpp +++ b/glm/gtx/rotate_normalized_axis.hpp @@ -8,9 +8,9 @@ /// @defgroup gtx_rotate_normalized_axis GLM_GTX_rotate_normalized_axis /// @ingroup gtx /// -/// @brief Quaternions and matrices rotations around normalized axis. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Quaternions and matrices rotations around normalized axis. #pragma once diff --git a/glm/gtx/rotate_vector.hpp b/glm/gtx/rotate_vector.hpp index 1cb8a7db..c8ace89e 100644 --- a/glm/gtx/rotate_vector.hpp +++ b/glm/gtx/rotate_vector.hpp @@ -7,9 +7,9 @@ /// @defgroup gtx_rotate_vector GLM_GTX_rotate_vector /// @ingroup gtx /// -/// @brief Function to directly rotate a vector +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Function to directly rotate a vector #pragma once diff --git a/glm/gtx/scalar_multiplication.hpp b/glm/gtx/scalar_multiplication.hpp index 0511634d..b73edf67 100644 --- a/glm/gtx/scalar_multiplication.hpp +++ b/glm/gtx/scalar_multiplication.hpp @@ -2,7 +2,9 @@ /// @file glm/gtx/scalar_multiplication.hpp /// @author Joshua Moerman /// -/// @brief Enables scalar multiplication for all types +/// Include to use the features of this extension. +/// +/// Enables scalar multiplication for all types /// /// Since GLSL is very strict about types, the following (often used) combinations do not work: /// double * vec4 diff --git a/glm/gtx/scalar_relational.hpp b/glm/gtx/scalar_relational.hpp index a06ca37a..7fc8c1cc 100644 --- a/glm/gtx/scalar_relational.hpp +++ b/glm/gtx/scalar_relational.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_scalar_relational GLM_GTX_scalar_relational /// @ingroup gtx /// -/// @brief Extend a position from a source to a position at a defined length. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Extend a position from a source to a position at a defined length. #pragma once diff --git a/glm/gtx/spline.hpp b/glm/gtx/spline.hpp index 7b807ec1..f96d7e07 100644 --- a/glm/gtx/spline.hpp +++ b/glm/gtx/spline.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_spline GLM_GTX_spline /// @ingroup gtx /// -/// @brief Spline functions +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Spline functions #pragma once diff --git a/glm/gtx/std_based_type.hpp b/glm/gtx/std_based_type.hpp index 70530bbe..55a2f074 100644 --- a/glm/gtx/std_based_type.hpp +++ b/glm/gtx/std_based_type.hpp @@ -7,8 +7,9 @@ /// @defgroup gtx_std_based_type GLM_GTX_std_based_type /// @ingroup gtx /// -/// @brief Adds vector types based on STL value types. -/// need to be included to use these functionalities. +/// Include to use the features of this extension. +/// +/// Adds vector types based on STL value types. #pragma once diff --git a/glm/gtx/string_cast.hpp b/glm/gtx/string_cast.hpp index 41f8cc7a..4b4e280f 100644 --- a/glm/gtx/string_cast.hpp +++ b/glm/gtx/string_cast.hpp @@ -8,9 +8,10 @@ /// @defgroup gtx_string_cast GLM_GTX_string_cast /// @ingroup gtx /// -/// @brief Setup strings for GLM type values +/// Include to use the features of this extension. +/// +/// Setup strings for GLM type values /// -/// need to be included to use these functionalities. /// This extension is not supported with CUDA #pragma once diff --git a/glm/gtx/transform.hpp b/glm/gtx/transform.hpp index dd314c2b..d23b99ce 100644 --- a/glm/gtx/transform.hpp +++ b/glm/gtx/transform.hpp @@ -9,9 +9,9 @@ /// @defgroup gtx_transform GLM_GTX_transform /// @ingroup gtx /// -/// @brief Add transformation matrices +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Add transformation matrices #pragma once diff --git a/glm/gtx/transform2.hpp b/glm/gtx/transform2.hpp index c7c447ca..85f5bea4 100644 --- a/glm/gtx/transform2.hpp +++ b/glm/gtx/transform2.hpp @@ -7,9 +7,9 @@ /// @defgroup gtx_transform2 GLM_GTX_transform2 /// @ingroup gtx /// -/// @brief Add extra transformation matrices +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Add extra transformation matrices #pragma once diff --git a/glm/gtx/type_aligned.hpp b/glm/gtx/type_aligned.hpp index 5b3d8614..803915bb 100644 --- a/glm/gtx/type_aligned.hpp +++ b/glm/gtx/type_aligned.hpp @@ -7,11 +7,11 @@ /// @defgroup gtx_type_aligned GLM_GTX_type_aligned /// @ingroup gtx /// -/// @brief Defines aligned types. +/// Include to use the features of this extension. +/// +/// Defines aligned types. /// /// @ref core_precision defines aligned types. -/// -/// need to be included to use these functionalities. #pragma once diff --git a/glm/gtx/type_trait.hpp b/glm/gtx/type_trait.hpp index 1bb77992..08dcc1a7 100644 --- a/glm/gtx/type_trait.hpp +++ b/glm/gtx/type_trait.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_type_trait GLM_GTX_type_trait /// @ingroup gtx /// -/// @brief Defines traits for each type. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Defines traits for each type. #pragma once diff --git a/glm/gtx/vec_swizzle.hpp b/glm/gtx/vec_swizzle.hpp index 7a2f4046..daebac38 100644 --- a/glm/gtx/vec_swizzle.hpp +++ b/glm/gtx/vec_swizzle.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_vec_swizzle GLM_GTX_vec_swizzle /// @ingroup gtx /// -/// @brief Functions to perform swizzle operation. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Functions to perform swizzle operation. #pragma once diff --git a/glm/gtx/vector_angle.hpp b/glm/gtx/vector_angle.hpp index 47f2f13f..401a47eb 100644 --- a/glm/gtx/vector_angle.hpp +++ b/glm/gtx/vector_angle.hpp @@ -8,9 +8,9 @@ /// @defgroup gtx_vector_angle GLM_GTX_vector_angle /// @ingroup gtx /// -/// @brief Compute angle between vectors +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Compute angle between vectors #pragma once diff --git a/glm/gtx/vector_query.hpp b/glm/gtx/vector_query.hpp index 93579109..6560eaa5 100644 --- a/glm/gtx/vector_query.hpp +++ b/glm/gtx/vector_query.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_vector_query GLM_GTX_vector_query /// @ingroup gtx /// -/// @brief Query informations of vector types +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Query informations of vector types #pragma once diff --git a/glm/gtx/wrap.hpp b/glm/gtx/wrap.hpp index 67231c45..2c4b55df 100644 --- a/glm/gtx/wrap.hpp +++ b/glm/gtx/wrap.hpp @@ -6,9 +6,9 @@ /// @defgroup gtx_wrap GLM_GTX_wrap /// @ingroup gtx /// -/// @brief Wrapping mode of texture coordinates. +/// Include to use the features of this extension. /// -/// need to be included to use these functionalities. +/// Wrapping mode of texture coordinates. #pragma once diff --git a/manual.md b/manual.md index 4cd827d4..11712fdc 100644 --- a/manual.md +++ b/manual.md @@ -29,23 +29,22 @@ + [4.2. GLM_GTC_color_space](#section4_2) + [4.3. GLM_GTC_constants](#section4_3) + [4.4. GLM_GTC_epsilon](#section4_4) -+ [4.5. GLM_GTC_functions](#section4_5) -+ [4.6. GLM_GTC_integer](#section4_6) -+ [4.7. GLM_GTC_matrix_access](#section4_7) -+ [4.8. GLM_GTC_matrix_integer](#section4_8) -+ [4.9. GLM_GTC_matrix_inverse](#section4_9) -+ [4.10. GLM_GTC_matrix_transform](#section4_10) -+ [4.11. GLM_GTC_noise](#section4_11) -+ [4.12. GLM_GTC_packing](#section4_12) -+ [4.13. GLM_GTC_quaternion](#section4_13) -+ [4.14. GLM_GTC_random](#section4_14) -+ [4.15. GLM_GTC_reciprocal](#section4_15) -+ [4.16. GLM_GTC_round](#section4_16) -+ [4.17. GLM_GTC_type_alignment](#section4_17) -+ [4.18. GLM_GTC_type_precision](#section4_18) -+ [4.19. GLM_GTC_type_ptr](#section4_19) -+ [4.20. GLM_GTC_ulp](#section4_20) -+ [4.21. GLM_GTC_vec1](#section4_21) ++ [4.5. GLM_GTC_integer](#section4_5) ++ [4.6. GLM_GTC_matrix_access](#section4_6) ++ [4.7. GLM_GTC_matrix_integer](#section4_7) ++ [4.8. GLM_GTC_matrix_inverse](#section4_8) ++ [4.9. GLM_GTC_matrix_transform](#section4_9) ++ [4.10. GLM_GTC_noise](#section4_10) ++ [4.11. GLM_GTC_packing](#section4_11) ++ [4.12. GLM_GTC_quaternion](#section4_12) ++ [4.13. GLM_GTC_random](#section4_13) ++ [4.14. GLM_GTC_reciprocal](#section4_14) ++ [4.15. GLM_GTC_round](#section4_15) ++ [4.16. GLM_GTC_type_alignment](#section4_16) ++ [4.17. GLM_GTC_type_precision](#section4_17) ++ [4.18. GLM_GTC_type_ptr](#section4_18) ++ [4.19. GLM_GTC_ulp](#section4_19) ++ [4.20. GLM_GTC_vec1](#section4_20) + [5. OpenGL interoperability](#section5) + [5.1. GLM Replacements for deprecated OpenGL functions](#section5_1) + [5.2. GLM Replacements for GPU functions](#section5_2) @@ -578,37 +577,31 @@ Approximate equality comparisons for floating-point numbers, possibly with a use <glm/gtc/epsilon.hpp> need to be included to use these features. -### 4.5. GLM\_GTC\_functions - -Useful functions. - -<glm/gtc/functions.hpp> need to be included to use these features. - -### 4.6. GLM\_GTC\_integer +### 4.5. GLM\_GTC\_integer Integer variants of core GLM functions. <glm/gtc/integer.hpp> need to be included to use these features. -### 4.7. GLM\_GTC\_matrix\_access +### 4.6. GLM\_GTC\_matrix\_access Functions to conveniently access the individual rows or columns of a matrix. <glm/gtc/matrix\_access.hpp> need to be included to use these features. -### 4.8. GLM\_GTC\_matrix\_integer +### 4.7. GLM\_GTC\_matrix\_integer Integer matrix types similar to the core floating-point matrices. Some operations (such as inverse and determinant) are not supported. <glm/gtc/matrix\_integer.hpp> need to be included to use these features. -### 4.9. GLM\_GTC\_matrix\_inverse +### 4.8. GLM\_GTC\_matrix\_inverse Additional matrix inverse functions. <glm/gtc/matrix\_inverse.hpp> need to be included to use these features. -### 4.10. GLM\_GTC\_matrix\_transform +### 4.9. GLM\_GTC\_matrix\_transform Matrix transformation functions that follow the OpenGL fixed-function conventions. @@ -619,7 +612,7 @@ projective matrix functions (***perspective***, ***ortho***, etc) are designed t <glm/gtc/matrix\_transform.hpp> need to be included to use these features. -### 4.11. GLM\_GTC\_noise +### 4.10. GLM\_GTC\_noise Define 2D, 3D and 4D procedural noise functions. @@ -627,53 +620,53 @@ Define 2D, 3D and 4D procedural noise functions. ![](/doc/manual/noise-simplex1.jpg) -Figure 4.11.1: glm::simplex(glm::vec2(x / 16.f, y / 16.f)); +Figure 4.10.1: glm::simplex(glm::vec2(x / 16.f, y / 16.f)); ![](/doc/manual/noise-simplex2.jpg) -Figure 4.11.2: glm::simplex(glm::vec3(x / 16.f, y / 16.f, 0.5f)); +Figure 4.10.2: glm::simplex(glm::vec3(x / 16.f, y / 16.f, 0.5f)); ![](/doc/manual/noise-simplex3.jpg) -Figure 4.11.3: glm::simplex(glm::vec4(x / 16.f, y / 16.f, 0.5f, 0.5f)); +Figure 4.10.3: glm::simplex(glm::vec4(x / 16.f, y / 16.f, 0.5f, 0.5f)); ![](/doc/manual/noise-perlin1.jpg) -Figure 4.11.4: glm::perlin(glm::vec2(x / 16.f, y / 16.f)); +Figure 4.10.4: glm::perlin(glm::vec2(x / 16.f, y / 16.f)); ![](/doc/manual/noise-perlin2.jpg) -Figure 4.11.5: glm::perlin(glm::vec3(x / 16.f, y / 16.f, 0.5f)); +Figure 4.10.5: glm::perlin(glm::vec3(x / 16.f, y / 16.f, 0.5f)); ![](/doc/manual/noise-perlin3.jpg) -Figure 4.11.6: glm::perlin(glm::vec4(x / 16.f, y / 16.f, 0.5f, 0.5f))); +Figure 4.10.6: glm::perlin(glm::vec4(x / 16.f, y / 16.f, 0.5f, 0.5f))); ![](/doc/manual/noise-perlin4.png) -Figure 4.11.7: glm::perlin(glm::vec2(x / 16.f, y / 16.f), glm::vec2(2.0f)); +Figure 4.10.7: glm::perlin(glm::vec2(x / 16.f, y / 16.f), glm::vec2(2.0f)); ![](/doc/manual/noise-perlin5.png) -Figure 4.11.8: glm::perlin(glm::vec3(x / 16.f, y / 16.f, 0.5f), glm::vec3(2.0f)); +Figure 4.10.8: glm::perlin(glm::vec3(x / 16.f, y / 16.f, 0.5f), glm::vec3(2.0f)); ![](/doc/manual/noise-perlin6.png) -Figure 4.11.9: glm::perlin(glm::vec4(x / 16.f, y / 16.f, glm::vec2(0.5f)), glm::vec4(2.0f)); +Figure 4.10.9: glm::perlin(glm::vec4(x / 16.f, y / 16.f, glm::vec2(0.5f)), glm::vec4(2.0f)); -### 4.12. GLM\_GTC\_packing +### 4.11. GLM\_GTC\_packing Convert scalar and vector types to and from packed formats, saving space at the cost of precision. However, packing a value into a format that it was previously unpacked from is guaranteed to be lossless. <glm/gtc/packing.hpp> need to be included to use these features. -### 4.13. GLM\_GTC\_quaternion +### 4.12. GLM\_GTC\_quaternion Quaternions and operations upon thereof. <glm/gtc/quaternion.hpp> need to be included to use these features. -### 4.14. GLM\_GTC\_random +### 4.13. GLM\_GTC\_random Probability distributions in up to four dimensions. @@ -681,47 +674,47 @@ Probability distributions in up to four dimensions. ![](/doc/manual/random-linearrand.png) -Figure 4.14.1: glm::vec4(glm::linearRand(glm::vec2(-1), glm::vec2(1)), 0, 1); +Figure 4.13.1: glm::vec4(glm::linearRand(glm::vec2(-1), glm::vec2(1)), 0, 1); ![](/doc/manual/random-circularrand.png) -Figure 4.14.2: glm::vec4(glm::circularRand(1.0f), 0, 1); +Figure 4.13.2: glm::vec4(glm::circularRand(1.0f), 0, 1); ![](/doc/manual/random-sphericalrand.png) -Figure 4.14.3: glm::vec4(glm::sphericalRand(1.0f), 1); +Figure 4.13.3: glm::vec4(glm::sphericalRand(1.0f), 1); ![](/doc/manual/random-diskrand.png) -Figure 4.14.4: glm::vec4(glm::diskRand(1.0f), 0, 1); +Figure 4.13.4: glm::vec4(glm::diskRand(1.0f), 0, 1); ![](/doc/manual/random-ballrand.png) -Figure 4.14.5: glm::vec4(glm::ballRand(1.0f), 1); +Figure 4.13.5: glm::vec4(glm::ballRand(1.0f), 1); ![](/doc/manual/random-gaussrand.png) -Figure 4.14.6: glm::vec4(glm::gaussRand(glm::vec3(0), glm::vec3(1)), 1); +Figure 4.13.6: glm::vec4(glm::gaussRand(glm::vec3(0), glm::vec3(1)), 1); -### 4.15. GLM\_GTC\_reciprocal +### 4.14. GLM\_GTC\_reciprocal Reciprocal trigonometric functions (e.g. secant, cosecant, tangent). -<glm/gtc/reciprocal.hpp> need to be included to use these functionalities. +<glm/gtc/reciprocal.hpp> need to be included to use the features of this extension. -### 4.16. GLM\_GTC\_round +### 4.15. GLM\_GTC\_round Various rounding operations and common special cases thereof. -<glm/gtc/round.hpp> need to be included to use these functionalities. +<glm/gtc/round.hpp> need to be included to use the features of this extension. -### 4.17. GLM\_GTC\_type\_aligned +### 4.16. GLM\_GTC\_type\_aligned Aligned vector types. -<glm/gtc/type\_aligned.hpp> need to be included to use these functionalities. +<glm/gtc/type\_aligned.hpp> need to be included to use the features of this extension. -### 4.18. GLM\_GTC\_type\_precision +### 4.17. GLM\_GTC\_type\_precision Vector and matrix types with defined precisions, e.g. i8vec4, which is a 4D vector of signed 8-bit integers. @@ -787,9 +780,9 @@ Available defines for 64-bit floating-point types (glm::f64vec\*, glm::f64mat\*, * GLM\_PRECISION\_MEDIUMP\_FLOAT64: Medium precision * GLM\_PRECISION\_HIGHP\_FLOAT64: High precision (default) -<glm/gtc/type\_precision.hpp> need to be included to use these functionalities. +<glm/gtc/type\_precision.hpp> need to be included to use the features of this extension. -### 4.19. GLM\_GTC\_type\_ptr +### 4.18. GLM\_GTC\_type\_ptr Facilitate interactions between pointers to basic types (e.g. float*) and GLM types (e.g. mat4). @@ -827,13 +820,13 @@ implicit cast in this example. However cast operators may produce programs runni <glm/gtc/type\_ptr.hpp> need to be included to use these features. -### 4.20. GLM\_GTC\_ulp +### 4.19. GLM\_GTC\_ulp Measure a function's accuracy given a reference implementation of it. This extension works on floating-point data and provides results in [ULP](http://ljk.imag.fr/membres/Carine.Lucas/TPScilab/JMMuller/ulp-toms.pdf). <glm/gtc/ulp.hpp> need to be included to use these features. -### 4.21. GLM\_GTC\_vec1 +### 4.20. GLM\_GTC\_vec1 Add \*vec1 types. diff --git a/readme.md b/readme.md index 0da3a236..4c922a70 100644 --- a/readme.md +++ b/readme.md @@ -67,6 +67,7 @@ glm::mat4 camera(float Translate, glm::vec2 const& Rotate) - No more default initialization of vector, matrix and quaternion types - Added lowp variant of GTC_color_space convertLinearToSRGB #419 - Replaced the manual by a markdown version #458 +- Improved API documentation #668 - Optimized GTC_packing implementation - Optimized GTC_noise functions - Optimized GTC_color_space HSV to RGB conversions diff --git a/test/gtc/CMakeLists.txt b/test/gtc/CMakeLists.txt index ab26247a..4aef24a8 100644 --- a/test/gtc/CMakeLists.txt +++ b/test/gtc/CMakeLists.txt @@ -2,7 +2,6 @@ glmCreateTestGTC(gtc_bitfield) glmCreateTestGTC(gtc_color_space) glmCreateTestGTC(gtc_constants) glmCreateTestGTC(gtc_epsilon) -glmCreateTestGTC(gtc_functions) glmCreateTestGTC(gtc_integer) glmCreateTestGTC(gtc_matrix_access) glmCreateTestGTC(gtc_matrix_integer) diff --git a/test/gtx/CMakeLists.txt b/test/gtx/CMakeLists.txt index 7bf81756..4f7629a4 100644 --- a/test/gtx/CMakeLists.txt +++ b/test/gtx/CMakeLists.txt @@ -14,6 +14,7 @@ glmCreateTestGTC(gtx_exterior_product) glmCreateTestGTC(gtx_fast_exponential) glmCreateTestGTC(gtx_fast_square_root) glmCreateTestGTC(gtx_fast_trigonometry) +glmCreateTestGTC(gtx_functions) glmCreateTestGTC(gtx_gradient_paint) glmCreateTestGTC(gtx_handed_coordinate_space) glmCreateTestGTC(gtx_integer) diff --git a/test/gtc/gtc_functions.cpp b/test/gtx/gtx_functions.cpp similarity index 94% rename from test/gtc/gtc_functions.cpp rename to test/gtx/gtx_functions.cpp index 3e0b3c88..2fd6f6e6 100644 --- a/test/gtc/gtc_functions.cpp +++ b/test/gtx/gtx_functions.cpp @@ -1,4 +1,4 @@ -#include +#include #include int test_gauss_1d()