common.hpp 3.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. /// @ref gtx_common
  2. /// @file glm/gtx/common.hpp
  3. ///
  4. /// @see core (dependence)
  5. ///
  6. /// @defgroup gtx_common GLM_GTX_common
  7. /// @ingroup gtx
  8. ///
  9. /// Include <glm/gtx/common.hpp> to use the features of this extension.
  10. ///
  11. /// @brief Provide functions to increase the compatibility with Cg and HLSL languages
  12. #pragma once
  13. // Dependencies:
  14. #include "../vec2.hpp"
  15. #include "../vec3.hpp"
  16. #include "../vec4.hpp"
  17. #include "../gtc/vec1.hpp"
  18. #ifndef GLM_ENABLE_EXPERIMENTAL
  19. # error "GLM: GLM_GTX_common is an experimental extension and may change in the future. Use #define GLM_ENABLE_EXPERIMENTAL before including it, if you really want to use it."
  20. #elif GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
  21. # pragma message("GLM: GLM_GTX_common extension included")
  22. #endif
  23. namespace glm
  24. {
  25. /// @addtogroup gtx_common
  26. /// @{
  27. /// Returns true if x is a denormalized number
  28. /// Numbers whose absolute value is too small to be represented in the normal format are represented in an alternate, denormalized format.
  29. /// This format is less precise but can represent values closer to zero.
  30. ///
  31. /// @tparam genType Floating-point scalar or vector types.
  32. ///
  33. /// @see <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/isnan.xml">GLSL isnan man page</a>
  34. /// @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>
  35. template<typename genType>
  36. GLM_FUNC_DECL typename genType::bool_type isdenormal(genType const& x);
  37. /// Similar to 'mod' but with a different rounding and integer support.
  38. /// Returns 'x - y * trunc(x/y)' instead of 'x - y * floor(x/y)'
  39. ///
  40. /// @see <a href="http://stackoverflow.com/questions/7610631/glsl-mod-vs-hlsl-fmod">GLSL mod vs HLSL fmod</a>
  41. /// @see <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a>
  42. template<length_t L, typename T, qualifier Q>
  43. GLM_FUNC_DECL vec<L, T, Q> fmod(vec<L, T, Q> const& v);
  44. /// Returns whether vector components values are within an interval. A open interval excludes its endpoints, and is denoted with square brackets.
  45. ///
  46. /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector
  47. /// @tparam T Floating-point or integer scalar types
  48. /// @tparam Q Value from qualifier enum
  49. ///
  50. /// @see ext_vector_relational
  51. template <length_t L, typename T, qualifier Q>
  52. GLM_FUNC_DECL vec<L, bool, Q> openBounded(vec<L, T, Q> const& Value, vec<L, T, Q> const& Min, vec<L, T, Q> const& Max);
  53. /// Returns whether vector components values are within an interval. A closed interval includes its endpoints, and is denoted with square brackets.
  54. ///
  55. /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector
  56. /// @tparam T Floating-point or integer scalar types
  57. /// @tparam Q Value from qualifier enum
  58. ///
  59. /// @see ext_vector_relational
  60. template <length_t L, typename T, qualifier Q>
  61. GLM_FUNC_DECL vec<L, bool, Q> closeBounded(vec<L, T, Q> const& Value, vec<L, T, Q> const& Min, vec<L, T, Q> const& Max);
  62. /// @}
  63. }//namespace glm
  64. #include "common.inl"