anulax
/
glm
1
0
Fork 0
Code Issues Pull Requests Packages project_board Releases Wiki Activity

Improved doxygen API doc

Browse Source
master
Christophe Riccio ago%!(EXTRA string=7 years)
parent f6be32ed0d
commit 0b974f0d00
80 changed files with 125 additions and 98 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 1
      glm/common.hpp
  2. 2
      glm/ext/matrix_double2x2.hpp
  3. 2
      glm/ext/matrix_double2x2_precision.hpp
  4. 2
      glm/ext/matrix_double2x3.hpp
  5. 2
      glm/ext/matrix_double2x3_precision.hpp
  6. 2
      glm/ext/matrix_double2x4.hpp
  7. 2
      glm/ext/matrix_double2x4_precision.hpp
  8. 2
      glm/ext/matrix_double3x2.hpp
  9. 2
      glm/ext/matrix_double3x2_precision.hpp
  10. 2
      glm/ext/matrix_double3x3.hpp
  11. 2
      glm/ext/matrix_double3x3_precision.hpp
  12. 2
      glm/ext/matrix_double3x4.hpp
  13. 2
      glm/ext/matrix_double3x4_precision.hpp
  14. 2
      glm/ext/matrix_double4x2.hpp
  15. 2
      glm/ext/matrix_double4x2_precision.hpp
  16. 2
      glm/ext/matrix_double4x3.hpp
  17. 2
      glm/ext/matrix_double4x3_precision.hpp
  18. 2
      glm/ext/matrix_double4x4.hpp
  19. 2
      glm/ext/matrix_double4x4_precision.hpp
  20. 2
      glm/ext/matrix_float2x2.hpp
  21. 2
      glm/ext/matrix_float2x2_precision.hpp
  22. 2
      glm/ext/matrix_float2x3.hpp
  23. 2
      glm/ext/matrix_float2x3_precision.hpp
  24. 2
      glm/ext/matrix_float2x4.hpp
  25. 2
      glm/ext/matrix_float2x4_precision.hpp
  26. 2
      glm/ext/matrix_float3x2_precision.hpp
  27. 2
      glm/ext/matrix_float3x3.hpp
  28. 2
      glm/ext/matrix_float3x3_precision.hpp
  29. 2
      glm/ext/matrix_float3x4.hpp
  30. 2
      glm/ext/matrix_float3x4_precision.hpp
  31. 2
      glm/ext/matrix_float4x2.hpp
  32. 2
      glm/ext/matrix_float4x2_precision.hpp
  33. 2
      glm/ext/matrix_float4x3.hpp
  34. 2
      glm/ext/matrix_float4x3_precision.hpp
  35. 2
      glm/ext/matrix_float4x4.hpp
  36. 2
      glm/ext/matrix_float4x4_precision.hpp
  37. 4
      glm/ext/matrix_transform.hpp
  38. 4
      glm/ext/quaternion_double_precision.hpp
  39. 4
      glm/ext/quaternion_geometric.hpp
  40. 4
      glm/ext/quaternion_relational.hpp
  41. 4
      glm/ext/quaternion_transform.hpp
  42. 4
      glm/ext/quaternion_trigonometric.hpp
  43. 2
      glm/ext/vector_bool2.hpp
  44. 2
      glm/ext/vector_bool2_precision.hpp
  45. 2
      glm/ext/vector_bool3.hpp
  46. 2
      glm/ext/vector_bool3_precision.hpp
  47. 2
      glm/ext/vector_bool4.hpp
  48. 2
      glm/ext/vector_bool4_precision.hpp
  49. 2
      glm/ext/vector_double1.hpp
  50. 2
      glm/ext/vector_double2.hpp
  51. 2
      glm/ext/vector_double2_precision.hpp
  52. 2
      glm/ext/vector_double3.hpp
  53. 2
      glm/ext/vector_double3_precision.hpp
  54. 2
      glm/ext/vector_double4.hpp
  55. 2
      glm/ext/vector_double4_precision.hpp
  56. 2
      glm/ext/vector_float1.hpp
  57. 4
      glm/ext/vector_float1_precision.hpp
  58. 2
      glm/ext/vector_float2.hpp
  59. 2
      glm/ext/vector_float2_precision.hpp
  60. 2
      glm/ext/vector_float3.hpp
  61. 2
      glm/ext/vector_float3_precision.hpp
  62. 2
      glm/ext/vector_float4.hpp
  63. 2
      glm/ext/vector_float4_precision.hpp
  64. 2
      glm/ext/vector_int1_precision.hpp
  65. 2
      glm/ext/vector_int2.hpp
  66. 2
      glm/ext/vector_int2_precision.hpp
  67. 2
      glm/ext/vector_int3.hpp
  68. 2
      glm/ext/vector_int3_precision.hpp
  69. 2
      glm/ext/vector_int4.hpp
  70. 2
      glm/ext/vector_int4_precision.hpp
  71. 4
      glm/ext/vector_uint1_precision.hpp
  72. 2
      glm/ext/vector_uint2.hpp
  73. 2
      glm/ext/vector_uint2_precision.hpp
  74. 2
      glm/ext/vector_uint3.hpp
  75. 2
      glm/ext/vector_uint3_precision.hpp
  76. 2
      glm/ext/vector_uint4.hpp
  77. 2
      glm/ext/vector_uint4_precision.hpp
  78. 49
      glm/glm.hpp
  79. 3
      glm/gtc/type_precision.hpp
  80. 2
      glm/gtx/type_aligned.hpp

1
glm/common.hpp
Unescape View File

@ -26,7 +26,6 @@ namespace glm
/// ///
/// @see <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/abs.xml">GLSL abs man page</a> /// @see <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/abs.xml">GLSL abs man page</a>
/// @see <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.3 Common Functions</a> /// @see <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.3 Common Functions</a>
/// @see qualifier
template<typename genType> template<typename genType>
GLM_FUNC_DECL GLM_CONSTEXPR genType abs(genType x); GLM_FUNC_DECL GLM_CONSTEXPR genType abs(genType x);

2
glm/ext/matrix_double2x2.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_matrix
/// @{ /// @{
/// 2 columns of 2 components matrix of double-precision floating-point numbers. /// 2 columns of 2 components matrix of double-precision floating-point numbers.

2
glm/ext/matrix_double2x2_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_matrix_precision
/// @{ /// @{
/// 2 columns of 2 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs. /// 2 columns of 2 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs.

2
glm/ext/matrix_double2x3.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_matrix
/// @{ /// @{
/// 2 columns of 3 components matrix of double-precision floating-point numbers. /// 2 columns of 3 components matrix of double-precision floating-point numbers.

2
glm/ext/matrix_double2x3_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_matrix_precision
/// @{ /// @{
/// 2 columns of 3 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs. /// 2 columns of 3 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs.

2
glm/ext/matrix_double2x4.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_matrix
/// @{ /// @{
/// 2 columns of 4 components matrix of double-precision floating-point numbers. /// 2 columns of 4 components matrix of double-precision floating-point numbers.

2
glm/ext/matrix_double2x4_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_matrix_precision
/// @{ /// @{
/// 2 columns of 4 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs. /// 2 columns of 4 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs.

2
glm/ext/matrix_double3x2.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_matrix
/// @{ /// @{
/// 3 columns of 2 components matrix of double-precision floating-point numbers. /// 3 columns of 2 components matrix of double-precision floating-point numbers.

2
glm/ext/matrix_double3x2_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_matrix_precision
/// @{ /// @{
/// 3 columns of 2 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs. /// 3 columns of 2 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs.

2
glm/ext/matrix_double3x3.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_matrix
/// @{ /// @{
/// 3 columns of 3 components matrix of double-precision floating-point numbers. /// 3 columns of 3 components matrix of double-precision floating-point numbers.

2
glm/ext/matrix_double3x3_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_matrix_precision
/// @{ /// @{
/// 3 columns of 3 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs. /// 3 columns of 3 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs.

2
glm/ext/matrix_double3x4.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_matrix
/// @{ /// @{
/// 3 columns of 4 components matrix of double-precision floating-point numbers. /// 3 columns of 4 components matrix of double-precision floating-point numbers.

2
glm/ext/matrix_double3x4_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_matrix_precision
/// @{ /// @{
/// 3 columns of 4 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs. /// 3 columns of 4 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs.

2
glm/ext/matrix_double4x2.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_matrix
/// @{ /// @{
/// 4 columns of 2 components matrix of double-precision floating-point numbers. /// 4 columns of 2 components matrix of double-precision floating-point numbers.

2
glm/ext/matrix_double4x2_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_matrix_precision
/// @{ /// @{
/// 4 columns of 2 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs. /// 4 columns of 2 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs.

2
glm/ext/matrix_double4x3.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_matrix
/// @{ /// @{
/// 4 columns of 3 components matrix of double-precision floating-point numbers. /// 4 columns of 3 components matrix of double-precision floating-point numbers.

2
glm/ext/matrix_double4x3_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_matrix_precision
/// @{ /// @{
/// 4 columns of 3 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs. /// 4 columns of 3 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs.

2
glm/ext/matrix_double4x4.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_matrix
/// @{ /// @{
/// 4 columns of 4 components matrix of double-precision floating-point numbers. /// 4 columns of 4 components matrix of double-precision floating-point numbers.

2
glm/ext/matrix_double4x4_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_matrix_precision
/// @{ /// @{
/// 4 columns of 4 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs. /// 4 columns of 4 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs.

2
glm/ext/matrix_float2x2.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_matrix
/// @{ /// @{
/// 2 columns of 2 components matrix of single-precision floating-point numbers. /// 2 columns of 2 components matrix of single-precision floating-point numbers.

2
glm/ext/matrix_float2x2_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_matrix_precision
/// @{ /// @{
/// 2 columns of 2 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs. /// 2 columns of 2 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs.

2
glm/ext/matrix_float2x3.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_matrix
/// @{ /// @{
/// 2 columns of 3 components matrix of single-precision floating-point numbers. /// 2 columns of 3 components matrix of single-precision floating-point numbers.

2
glm/ext/matrix_float2x3_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_matrix_precision
/// @{ /// @{
/// 2 columns of 3 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs. /// 2 columns of 3 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs.

2
glm/ext/matrix_float2x4.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_matrix
/// @{ /// @{
/// 2 columns of 4 components matrix of single-precision floating-point numbers. /// 2 columns of 4 components matrix of single-precision floating-point numbers.

2
glm/ext/matrix_float2x4_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_matrix_precision
/// @{ /// @{
/// 2 columns of 4 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs. /// 2 columns of 4 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs.

2
glm/ext/matrix_float3x2_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_matrix_precision
/// @{ /// @{
/// 3 columns of 2 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs. /// 3 columns of 2 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs.

2
glm/ext/matrix_float3x3.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_matrix
/// @{ /// @{
/// 3 columns of 3 components matrix of single-precision floating-point numbers. /// 3 columns of 3 components matrix of single-precision floating-point numbers.

2
glm/ext/matrix_float3x3_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_matrix_precision
/// @{ /// @{
/// 3 columns of 3 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs. /// 3 columns of 3 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs.

2
glm/ext/matrix_float3x4.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_matrix
/// @{ /// @{
/// 3 columns of 4 components matrix of single-precision floating-point numbers. /// 3 columns of 4 components matrix of single-precision floating-point numbers.

2
glm/ext/matrix_float3x4_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_matrix_precision
/// @{ /// @{
/// 3 columns of 4 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs. /// 3 columns of 4 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs.

2
glm/ext/matrix_float4x2.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_matrix
/// @{ /// @{
/// 4 columns of 2 components matrix of single-precision floating-point numbers. /// 4 columns of 2 components matrix of single-precision floating-point numbers.

2
glm/ext/matrix_float4x2_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_matrix_precision
/// @{ /// @{
/// 4 columns of 2 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs. /// 4 columns of 2 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs.

2
glm/ext/matrix_float4x3.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_matrix
/// @{ /// @{
/// 4 columns of 3 components matrix of single-precision floating-point numbers. /// 4 columns of 3 components matrix of single-precision floating-point numbers.

2
glm/ext/matrix_float4x3_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_matrix_precision
/// @{ /// @{
/// 4 columns of 3 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs. /// 4 columns of 3 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs.

2
glm/ext/matrix_float4x4.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @ingroup core /// @ingroup core_matrix
/// @{ /// @{
/// 4 columns of 4 components matrix of single-precision floating-point numbers. /// 4 columns of 4 components matrix of single-precision floating-point numbers.

2
glm/ext/matrix_float4x4_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_matrix_precision
/// @{ /// @{
/// 4 columns of 4 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs. /// 4 columns of 4 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs.

4
glm/ext/matrix_transform.hpp
Unescape View File

@ -4,8 +4,6 @@
/// @defgroup ext_matrix_transform GLM_EXT_matrix_transform /// @defgroup ext_matrix_transform GLM_EXT_matrix_transform
/// @ingroup ext /// @ingroup ext
/// ///
/// Include <glm/ext/matrix_transform.hpp> to use the features of this extension.
///
/// Defines functions that generate common transformation matrices. /// Defines functions that generate common transformation matrices.
/// ///
/// The matrices generated by this extension use standard OpenGL fixed-function /// The matrices generated by this extension use standard OpenGL fixed-function
@ -14,6 +12,8 @@
/// (perspective, ortho, etc) are designed to expect. The OpenGL compatibility /// (perspective, ortho, etc) are designed to expect. The OpenGL compatibility
/// specifications defines the particular layout of this eye space. /// specifications defines the particular layout of this eye space.
/// ///
/// Include <glm/ext/matrix_transform.hpp> to use the features of this extension.
///
/// @see ext_matrix_projection /// @see ext_matrix_projection
/// @see ext_matrix_clip_space /// @see ext_matrix_clip_space

4
glm/ext/quaternion_double_precision.hpp
Unescape View File

@ -4,9 +4,9 @@
/// @defgroup ext_quaternion_double_precision GLM_EXT_quaternion_double_precision /// @defgroup ext_quaternion_double_precision GLM_EXT_quaternion_double_precision
/// @ingroup ext /// @ingroup ext
/// ///
/// Include <glm/ext/quaternion_double_precision.hpp> to use the features of this extension.
///
/// Defines a templated quaternion type and several quaternion operations. /// Defines a templated quaternion type and several quaternion operations.
///
/// Include <glm/ext/quaternion_double_precision.hpp> to use the features of this extension.
#pragma once #pragma once

4
glm/ext/quaternion_geometric.hpp
Unescape View File

@ -4,10 +4,10 @@
/// @defgroup ext_quaternion_geometric GLM_EXT_quaternion_geometric /// @defgroup ext_quaternion_geometric GLM_EXT_quaternion_geometric
/// @ingroup ext /// @ingroup ext
/// ///
/// Include <glm/ext/quaternion_geometric.hpp> to use the features of this extension.
///
/// Defines a templated quaternion type and several quaternion operations. /// Defines a templated quaternion type and several quaternion operations.
/// ///
/// Include <glm/ext/quaternion_geometric.hpp> to use the features of this extension.
///
/// @see core_geometric /// @see core_geometric
/// @see ext_quaternion_float /// @see ext_quaternion_float
/// @see ext_quaternion_double /// @see ext_quaternion_double

4
glm/ext/quaternion_relational.hpp
Unescape View File

@ -4,10 +4,10 @@
/// @defgroup ext_quaternion_relational GLM_EXT_quaternion_relational /// @defgroup ext_quaternion_relational GLM_EXT_quaternion_relational
/// @ingroup ext /// @ingroup ext
/// ///
/// Include <glm/ext/quaternion_relational.hpp> to use the features of this extension.
///
/// Defines a templated quaternion type and several quaternion operations. /// Defines a templated quaternion type and several quaternion operations.
/// ///
/// Include <glm/ext/quaternion_relational.hpp> to use the features of this extension.
///
/// @see core_vector_relational /// @see core_vector_relational
/// @see ext_vector_relational /// @see ext_vector_relational
/// @see ext_matrix_relational /// @see ext_matrix_relational

4
glm/ext/quaternion_transform.hpp
Unescape View File

@ -4,10 +4,10 @@
/// @defgroup ext_quaternion_transform GLM_EXT_quaternion_transform /// @defgroup ext_quaternion_transform GLM_EXT_quaternion_transform
/// @ingroup ext /// @ingroup ext
/// ///
/// Include <glm/ext/quaternion_transform.hpp> to use the features of this extension.
///
/// Defines a templated quaternion type and several quaternion operations. /// Defines a templated quaternion type and several quaternion operations.
/// ///
/// Include <glm/ext/quaternion_transform.hpp> to use the features of this extension.
///
/// @see ext_quaternion_float /// @see ext_quaternion_float
/// @see ext_quaternion_double /// @see ext_quaternion_double
/// @see ext_quaternion_exponential /// @see ext_quaternion_exponential

4
glm/ext/quaternion_trigonometric.hpp
Unescape View File

@ -4,10 +4,10 @@
/// @defgroup ext_quaternion_trigonometric GLM_EXT_quaternion_trigonometric /// @defgroup ext_quaternion_trigonometric GLM_EXT_quaternion_trigonometric
/// @ingroup ext /// @ingroup ext
/// ///
/// Include <glm/ext/quaternion_trigonometric.hpp> to use the features of this extension.
///
/// Defines a templated quaternion type and several quaternion operations. /// Defines a templated quaternion type and several quaternion operations.
/// ///
/// Include <glm/ext/quaternion_trigonometric.hpp> to use the features of this extension.
///
/// @see ext_quaternion_float /// @see ext_quaternion_float
/// @see ext_quaternion_double /// @see ext_quaternion_double
/// @see ext_quaternion_exponential /// @see ext_quaternion_exponential

2
glm/ext/vector_bool2.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_vector
/// @{ /// @{
/// 2 components vector of boolean. /// 2 components vector of boolean.

2
glm/ext/vector_bool2_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_vector_precision
/// @{ /// @{
/// 2 components vector of high qualifier bool numbers. /// 2 components vector of high qualifier bool numbers.

2
glm/ext/vector_bool3.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_vector
/// @{ /// @{
/// 3 components vector of boolean. /// 3 components vector of boolean.

2
glm/ext/vector_bool3_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_vector_precision
/// @{ /// @{
/// 3 components vector of high qualifier bool numbers. /// 3 components vector of high qualifier bool numbers.

2
glm/ext/vector_bool4.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_vector
/// @{ /// @{
/// 4 components vector of boolean. /// 4 components vector of boolean.

2
glm/ext/vector_bool4_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_vector_precision
/// @{ /// @{
/// 4 components vector of high qualifier bool numbers. /// 4 components vector of high qualifier bool numbers.

2
glm/ext/vector_double1.hpp
Unescape View File

@ -4,7 +4,7 @@
/// @defgroup ext_vector_double1 GLM_EXT_vector_double1 /// @defgroup ext_vector_double1 GLM_EXT_vector_double1
/// @ingroup ext /// @ingroup ext
/// ///
/// Expose dvec1 vector type. /// Exposes double-precision floating point vector type with one component.
/// ///
/// Include <glm/ext/vector_double1.hpp> to use the features of this extension. /// Include <glm/ext/vector_double1.hpp> to use the features of this extension.
/// ///

2
glm/ext/vector_double2.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_vector
/// @{ /// @{
/// 2 components vector of double-precision floating-point numbers. /// 2 components vector of double-precision floating-point numbers.

2
glm/ext/vector_double2_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_vector_precision
/// @{ /// @{
/// 2 components vector of high double-qualifier floating-point numbers. /// 2 components vector of high double-qualifier floating-point numbers.

2
glm/ext/vector_double3.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_vector
/// @{ /// @{
/// 3 components vector of double-precision floating-point numbers. /// 3 components vector of double-precision floating-point numbers.

2
glm/ext/vector_double3_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_vector_precision
/// @{ /// @{
/// 3 components vector of high double-qualifier floating-point numbers. /// 3 components vector of high double-qualifier floating-point numbers.

2
glm/ext/vector_double4.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_vector
/// @{ /// @{
/// 4 components vector of double-precision floating-point numbers. /// 4 components vector of double-precision floating-point numbers.

2
glm/ext/vector_double4_precision.hpp
Unescape View File

@ -7,7 +7,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_vector_precision
/// @{ /// @{
/// 4 components vector of high double-qualifier floating-point numbers. /// 4 components vector of high double-qualifier floating-point numbers.

2
glm/ext/vector_float1.hpp
Unescape View File

@ -4,7 +4,7 @@
/// @defgroup ext_vector_float1 GLM_EXT_vector_float1 /// @defgroup ext_vector_float1 GLM_EXT_vector_float1
/// @ingroup ext /// @ingroup ext
/// ///
/// Floating point vector type with one component. /// Exposes single-precision floating point vector type with one component.
/// ///
/// Include <glm/ext/vector_float1.hpp> to use the features of this extension. /// Include <glm/ext/vector_float1.hpp> to use the features of this extension.
/// ///

4
glm/ext/vector_float1_precision.hpp
Unescape View File

@ -4,10 +4,10 @@
/// @defgroup ext_vector_float1_precision GLM_EXT_vector_float1_precision /// @defgroup ext_vector_float1_precision GLM_EXT_vector_float1_precision
/// @ingroup ext /// @ingroup ext
/// ///
/// Include <glm/ext/vector_float1_precision.hpp> to use the features of this extension.
///
/// Exposes highp_vec1, mediump_vec1 and lowp_vec1 types. /// Exposes highp_vec1, mediump_vec1 and lowp_vec1 types.
/// ///
/// Include <glm/ext/vector_float1_precision.hpp> to use the features of this extension.
///
/// @see ext_vector_float1 extension. /// @see ext_vector_float1 extension.
#pragma once #pragma once

2
glm/ext/vector_float2.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_vector
/// @{ /// @{
/// 2 components vector of single-precision floating-point numbers. /// 2 components vector of single-precision floating-point numbers.

2
glm/ext/vector_float2_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_vector_precision
/// @{ /// @{
/// 2 components vector of high single-qualifier floating-point numbers. /// 2 components vector of high single-qualifier floating-point numbers.

2
glm/ext/vector_float3.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_vector
/// @{ /// @{
/// 3 components vector of single-precision floating-point numbers. /// 3 components vector of single-precision floating-point numbers.

2
glm/ext/vector_float3_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_vector_precision
/// @{ /// @{
/// 3 components vector of high single-qualifier floating-point numbers. /// 3 components vector of high single-qualifier floating-point numbers.

2
glm/ext/vector_float4.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_vector
/// @{ /// @{
/// 4 components vector of single-precision floating-point numbers. /// 4 components vector of single-precision floating-point numbers.

2
glm/ext/vector_float4_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_vector_precision
/// @{ /// @{
/// 4 components vector of high single-qualifier floating-point numbers. /// 4 components vector of high single-qualifier floating-point numbers.

2
glm/ext/vector_int1_precision.hpp
Unescape View File

@ -4,7 +4,7 @@
/// @defgroup ext_vector_int1_precision GLM_EXT_vector_int1_precision /// @defgroup ext_vector_int1_precision GLM_EXT_vector_int1_precision
/// @ingroup ext /// @ingroup ext
/// ///
/// Add Exposes highp_ivec1, mediump_ivec1 and lowp_ivec1 types. /// Exposes highp_ivec1, mediump_ivec1 and lowp_ivec1 types.
/// ///
/// Include <glm/ext/vector_int1_precision.hpp> to use the features of this extension. /// Include <glm/ext/vector_int1_precision.hpp> to use the features of this extension.

2
glm/ext/vector_int2.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_vector
/// @{ /// @{
/// 2 components vector of signed integer numbers. /// 2 components vector of signed integer numbers.

2
glm/ext/vector_int2_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_vector_precision
/// @{ /// @{
/// 2 components vector of high qualifier signed integer numbers. /// 2 components vector of high qualifier signed integer numbers.

2
glm/ext/vector_int3.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_vector
/// @{ /// @{
/// 3 components vector of signed integer numbers. /// 3 components vector of signed integer numbers.

2
glm/ext/vector_int3_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_vector_precision
/// @{ /// @{
/// 3 components vector of high qualifier signed integer numbers. /// 3 components vector of high qualifier signed integer numbers.

2
glm/ext/vector_int4.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_vector
/// @{ /// @{
/// 4 components vector of signed integer numbers. /// 4 components vector of signed integer numbers.

2
glm/ext/vector_int4_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_vector_precision
/// @{ /// @{
/// 4 components vector of high qualifier signed integer numbers. /// 4 components vector of high qualifier signed integer numbers.

4
glm/ext/vector_uint1_precision.hpp
Unescape View File

@ -4,9 +4,9 @@
/// @defgroup ext_vector_uint1_precision GLM_EXT_vector_uint1_precision /// @defgroup ext_vector_uint1_precision GLM_EXT_vector_uint1_precision
/// @ingroup ext /// @ingroup ext
/// ///
/// Include <glm/ext/vector_uint1_precision.hpp> to use the features of this extension. /// Exposes highp_uvec1, mediump_uvec1 and lowp_uvec1 types.
/// ///
/// Add Exposes highp_uvec1, mediump_uvec1 and lowp_uvec1 types. /// Include <glm/ext/vector_uint1_precision.hpp> to use the features of this extension.
#pragma once #pragma once

2
glm/ext/vector_uint2.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_vector
/// @{ /// @{
/// 2 components vector of unsigned integer numbers. /// 2 components vector of unsigned integer numbers.

2
glm/ext/vector_uint2_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_vector_precision
/// @{ /// @{
/// 2 components vector of high qualifier unsigned integer numbers. /// 2 components vector of high qualifier unsigned integer numbers.

2
glm/ext/vector_uint3.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_vector
/// @{ /// @{
/// 3 components vector of unsigned integer numbers. /// 3 components vector of unsigned integer numbers.

2
glm/ext/vector_uint3_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_vector_precision
/// @{ /// @{
/// 3 components vector of high qualifier unsigned integer numbers. /// 3 components vector of high qualifier unsigned integer numbers.

2
glm/ext/vector_uint4.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core /// @addtogroup core_vector
/// @{ /// @{
/// 4 components vector of unsigned integer numbers. /// 4 components vector of unsigned integer numbers.

2
glm/ext/vector_uint4_precision.hpp
Unescape View File

@ -6,7 +6,7 @@
namespace glm namespace glm
{ {
/// @addtogroup core_precision /// @addtogroup core_vector_precision
/// @{ /// @{
/// 4 components vector of high qualifier unsigned integer numbers. /// 4 components vector of high qualifier unsigned integer numbers.

49
glm/glm.hpp
Unescape View File

@ -6,9 +6,7 @@
/// @brief Features that implement in C++ the GLSL specification as closely as possible. /// @brief Features that implement in C++ the GLSL specification as closely as possible.
/// ///
/// The GLM core consists of C++ types that mirror GLSL types and /// The GLM core consists of C++ types that mirror GLSL types and
/// C++ functions that mirror the GLSL functions. It also includes /// C++ functions that mirror the GLSL functions.
/// @ref core_precision "a set of qualifier-based types" that can be used in the appropriate
/// functions.
/// ///
/// The best documentation for GLM Core is the current GLSL specification, /// The best documentation for GLM Core is the current GLSL specification,
/// <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.clean.pdf">version 4.2 /// <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.clean.pdf">version 4.2
@ -16,13 +14,21 @@
/// ///
/// GLM core functionalities require <glm/glm.hpp> to be included to be used. /// GLM core functionalities require <glm/glm.hpp> to be included to be used.
/// ///
/// @defgroup core_precision Precision types
/// ///
/// @brief Non-GLSL types that are used to define qualifier-based types. /// @defgroup core_vector Vector types
/// ///
/// The GLSL language allows the user to define the qualifier of a particular variable. /// Vector types of two to four components with an exhaustive set of operators.
/// In OpenGL's GLSL, these qualifier qualifiers have no effect; they are there for compatibility ///
/// with OpenGL ES's qualifier qualifiers, where they @em do have an effect. /// @ingroup core
///
///
/// @defgroup core_vector_precision Vector types with precision qualifiers
///
/// @brief Vector types with precision qualifiers which may result in various precision in term of ULPs
///
/// GLSL allows defining qualifiers for particular variables.
/// With OpenGL's GLSL, these qualifiers have no effect; they are there for compatibility,
/// with OpenGL ES's GLSL, these qualifiers do have an effect.
/// ///
/// C++ has no language equivalent to qualifier qualifiers. So GLM provides the next-best thing: /// C++ has no language equivalent to qualifier qualifiers. So GLM provides the next-best thing:
/// a number of typedefs that use a particular qualifier. /// a number of typedefs that use a particular qualifier.
@ -31,6 +37,31 @@
/// ///
/// @ingroup core /// @ingroup core
/// ///
///
/// @defgroup core_matrix Matrix types
///
/// Matrix types of with C columns and R rows where C and R are values between 2 to 4 included.
/// These types have exhaustive sets of operators.
///
/// @ingroup core
///
///
/// @defgroup core_matrix_precision Matrix types with precision qualifiers
///
/// @brief Matrix types with precision qualifiers which may result in various precision in term of ULPs
///
/// GLSL allows defining qualifiers for particular variables.
/// With OpenGL's GLSL, these qualifiers have no effect; they are there for compatibility,
/// with OpenGL ES's GLSL, these qualifiers do have an effect.
///
/// C++ has no language equivalent to qualifier qualifiers. So GLM provides the next-best thing:
/// a number of typedefs that use a particular qualifier.
///
/// None of these types make any guarantees about the actual qualifier used.
///
/// @ingroup core
///
///
/// @defgroup ext Stable extensions /// @defgroup ext Stable extensions
/// ///
/// @brief Additional features not specified by GLSL specification. /// @brief Additional features not specified by GLSL specification.
@ -40,6 +71,7 @@
/// Even if it's highly unrecommended, it's possible to include all the extensions at once by /// Even if it's highly unrecommended, it's possible to include all the extensions at once by
/// including <glm/ext.hpp>. Otherwise, each extension needs to be included a specific file. /// including <glm/ext.hpp>. Otherwise, each extension needs to be included a specific file.
/// ///
///
/// @defgroup gtc Recommended extensions /// @defgroup gtc Recommended extensions
/// ///
/// @brief Additional features not specified by GLSL specification. /// @brief Additional features not specified by GLSL specification.
@ -49,6 +81,7 @@
/// Even if it's highly unrecommended, it's possible to include all the extensions at once by /// Even if it's highly unrecommended, it's possible to include all the extensions at once by
/// including <glm/ext.hpp>. Otherwise, each extension needs to be included a specific file. /// including <glm/ext.hpp>. Otherwise, each extension needs to be included a specific file.
/// ///
///
/// @defgroup gtx Experimental extensions /// @defgroup gtx Experimental extensions
/// ///
/// @brief Experimental features not specified by GLSL specification. /// @brief Experimental features not specified by GLSL specification.

3
glm/gtc/type_precision.hpp
Unescape View File

@ -10,9 +10,6 @@
/// Include <glm/gtc/type_precision.hpp> to use the features of this extension. /// Include <glm/gtc/type_precision.hpp> to use the features of this extension.
/// ///
/// Defines specific C++-based qualifier types. /// 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.
#pragma once #pragma once

2
glm/gtx/type_aligned.hpp
Unescape View File

@ -10,8 +10,6 @@
/// Include <glm/gtx/type_aligned.hpp> to use the features of this extension. /// Include <glm/gtx/type_aligned.hpp> to use the features of this extension.
/// ///
/// Defines aligned types. /// Defines aligned types.
///
/// @ref core_precision defines aligned types.
#pragma once #pragma once

Write Preview
Loading…
Cancel
Save