diff options
Diffstat (limited to 'external/include/glm/glm.hpp')
| -rw-r--r-- | external/include/glm/glm.hpp | 66 |
1 files changed, 52 insertions, 14 deletions
diff --git a/external/include/glm/glm.hpp b/external/include/glm/glm.hpp index 021a360..cfd0ce2 100644 --- a/external/include/glm/glm.hpp +++ b/external/include/glm/glm.hpp @@ -1,20 +1,20 @@ /// @ref core /// @file glm/glm.hpp /// -/// @defgroup core GLM Core +/// @defgroup core Core features /// -/// @brief The core of GLM, which implements exactly and only the GLSL specification to the degree possible. +/// @brief Features that implement in C++ the GLSL specification as closely as possible. /// /// The GLM core consists of @ref core_types "C++ types that mirror GLSL types" and -/// C++ functions that mirror the GLSL functions. It also includes -/// @ref core_precision "a set of precision-based types" that can be used in the appropriate +/// C++ functions that mirror the GLSL functions. It also includes +/// @ref core_precision "a set of qualifier-based types" that can be used in the appropriate /// functions. The C++ types are all based on a basic set of @ref core_template "template types". /// /// 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 /// (pdf file)</a>. /// -/// GLM core functionnalities 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_types Types /// @@ -27,30 +27,68 @@ /// /// @defgroup core_precision Precision types /// -/// @brief Non-GLSL types that are used to define precision-based types. +/// @brief Non-GLSL types that are used to define qualifier-based types. /// -/// The GLSL language allows the user to define the precision of a particular variable. -/// In OpenGL's GLSL, these precision qualifiers have no effect; they are there for compatibility -/// with OpenGL ES's precision qualifiers, where they @em do have an effect. +/// The GLSL language allows the user to define the qualifier of a particular variable. +/// 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. /// -/// C++ has no language equivalent to precision qualifiers. So GLM provides the next-best thing: -/// a number of typedefs of the @ref core_template that use a particular precision. +/// C++ has no language equivalent to qualifier qualifiers. So GLM provides the next-best thing: +/// a number of typedefs of the @ref core_template that use a particular qualifier. /// -/// None of these types make any guarantees about the actual precision used. +/// None of these types make any guarantees about the actual qualifier used. /// /// @ingroup core /// /// @defgroup core_template Template types /// -/// @brief The generic template types used as the basis for the core types. +/// @brief The generic template types used as the basis for the core types. /// /// These types are all templates used to define the actual @ref core_types. -/// These templetes are implementation details of GLM types and should not be used explicitly. +/// These templates are implementation details of GLM types and should not be used explicitly. /// /// @ingroup core +/// +/// @defgroup ext Stable extensions +/// +/// @brief Additional features not specified by GLSL specification. +/// +/// EXT extensions are fully tested and documented. +/// +/// 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. +/// +/// @defgroup gtc Recommended extensions +/// +/// @brief Additional features not specified by GLSL specification. +/// +/// GTC extensions aim to be stable with tests and documentation. +/// +/// 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. +/// +/// @defgroup gtx Experimental extensions +/// +/// @brief Experimental features not specified by GLSL specification. +/// +/// Experimental extensions are useful functions and types, but the development of +/// their API and functionality is not necessarily stable. They can change +/// substantially between versions. Backwards compatibility is not much of an issue +/// for them. +/// +/// 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. +/// +/// @mainpage OpenGL Mathematics (GLM) +/// - Website: <a href="https://glm.g-truc.net">glm.g-truc.net</a> +/// - <a href="modules.html">GLM API documentation</a> +/// - <a href="https://github.com/g-truc/glm/blob/master/manual.md">GLM Manual</a> #include "detail/_fixes.hpp" +#include "detail/setup.hpp" + #pragma once #include <cmath> |