coreModules.doxy 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. /*!
  2. \defgroup core GLM Core
  3. \brief The core of GLM, which implements exactly and only the GLSL specification to the degree possible.
  4. The GLM core consists of \ref core_types "C++ types that mirror GLSL types",
  5. \ref core_funcs "C++ functions that mirror the GLSL functions". It also includes
  6. \ref core_precision "a set of precision-based types" that can be used in the appropriate
  7. functions. The C++ types are all based on a basic set of \ref core_template "template types".
  8. The best documentation for GLM Core is the current GLSL specification,
  9. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.10.6.clean.pdf">version 4.1
  10. (pdf file)</a>.
  11. There are a few \ref pg_differences "differences" between GLM core and GLSL.
  12. GLM core functionnalities requires <glm/glm.hpp> to be included to be used.
  13. **/
  14. /*!
  15. \defgroup core_types Types
  16. \brief The standard types defined by the specification.
  17. These types are all typedefs of more generalized, template types. To see the definiton
  18. of these template types, go to \ref core_template.
  19. \ingroup core
  20. **/
  21. /*!
  22. \defgroup core_precision Precision types
  23. \brief Non-GLSL types that are used to define precision-based types.
  24. The GLSL language allows the user to define the precision of a particular variable.
  25. In OpenGL's GLSL, these precision qualifiers have no effect; they are there for compatibility
  26. with OpenGL ES's precision qualifiers, where they \em do have an effect.
  27. C++ has no language equivalent to precision qualifiers. So GLM provides the next-best thing:
  28. a number of typedefs of the \ref core_template that use a particular precision.
  29. None of these types make any guarantees about the actual precision used.
  30. \ingroup core
  31. **/
  32. /*!
  33. \defgroup core_template Template types
  34. \brief The generic template types used as the basis for the core types.
  35. These types are all templates used to define the actual \ref core_types.
  36. These templetes are implementation details of GLM types and should not be used explicitly.
  37. \ingroup core
  38. **/
  39. /*!
  40. \defgroup core_funcs Functions
  41. \brief The functions defined by the specification.
  42. \ingroup core
  43. **/