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