9
3

common.hpp 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  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. #if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
  19. # ifndef GLM_ENABLE_EXPERIMENTAL
  20. # pragma message("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.")
  21. # else
  22. # pragma message("GLM: GLM_GTX_common extension included")
  23. # endif
  24. #endif
  25. namespace glm
  26. {
  27. /// @addtogroup gtx_common
  28. /// @{
  29. /// Returns true if x is a denormalized number
  30. /// Numbers whose absolute value is too small to be represented in the normal format are represented in an alternate, denormalized format.
  31. /// This format is less precise but can represent values closer to zero.
  32. ///
  33. /// @tparam genType Floating-point scalar or vector types.
  34. ///
  35. /// @see <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/isnan.xml">GLSL isnan man page</a>
  36. /// @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>
  37. template<typename genType>
  38. GLM_FUNC_DECL typename genType::bool_type isdenormal(genType const& x);
  39. /// Similar to 'mod' but with a different rounding and integer support.
  40. /// Returns 'x - y * trunc(x/y)' instead of 'x - y * floor(x/y)'
  41. ///
  42. /// @see <a href="http://stackoverflow.com/questions/7610631/glsl-mod-vs-hlsl-fmod">GLSL mod vs HLSL fmod</a>
  43. /// @see <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a>
  44. template<length_t L, typename T, qualifier Q>
  45. GLM_FUNC_DECL vec<L, T, Q> fmod(vec<L, T, Q> const& v);
  46. /// Returns whether vector components values are within an interval. A open interval excludes its endpoints, and is denoted with square brackets.
  47. ///
  48. /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector
  49. /// @tparam T Floating-point or integer scalar types
  50. /// @tparam Q Value from qualifier enum
  51. ///
  52. /// @see ext_vector_relational
  53. template <length_t L, typename T, qualifier Q>
  54. 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);
  55. /// Returns whether vector components values are within an interval. A closed interval includes its endpoints, and is denoted with square brackets.
  56. ///
  57. /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector
  58. /// @tparam T Floating-point or integer scalar types
  59. /// @tparam Q Value from qualifier enum
  60. ///
  61. /// @see ext_vector_relational
  62. template <length_t L, typename T, qualifier Q>
  63. 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);
  64. /// @}
  65. }//namespace glm
  66. #include "common.inl"