component_wise.hpp 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. /// @ref gtx_component_wise
  2. /// @file glm/gtx/component_wise.hpp
  3. /// @date 2007-05-21 / 2011-06-07
  4. /// @author Christophe Riccio
  5. ///
  6. /// @see core (dependence)
  7. ///
  8. /// @defgroup gtx_component_wise GLM_GTX_component_wise
  9. /// @ingroup gtx
  10. ///
  11. /// Include <glm/gtx/component_wise.hpp> to use the features of this extension.
  12. ///
  13. /// Operations between components of a type
  14. #pragma once
  15. // Dependencies
  16. #include "../detail/setup.hpp"
  17. #include "../detail/qualifier.hpp"
  18. #if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
  19. # ifndef GLM_ENABLE_EXPERIMENTAL
  20. # pragma message("GLM: GLM_GTX_component_wise 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_component_wise extension included")
  23. # endif
  24. #endif
  25. namespace glm
  26. {
  27. /// @addtogroup gtx_component_wise
  28. /// @{
  29. /// Convert an integer vector to a normalized float vector.
  30. /// If the parameter value type is already a floating qualifier type, the value is passed through.
  31. /// @see gtx_component_wise
  32. template<typename floatType, length_t L, typename T, qualifier Q>
  33. GLM_FUNC_DECL vec<L, floatType, Q> compNormalize(vec<L, T, Q> const& v);
  34. /// Convert a normalized float vector to an integer vector.
  35. /// If the parameter value type is already a floating qualifier type, the value is passed through.
  36. /// @see gtx_component_wise
  37. template<length_t L, typename T, typename floatType, qualifier Q>
  38. GLM_FUNC_DECL vec<L, T, Q> compScale(vec<L, floatType, Q> const& v);
  39. /// Add all vector components together.
  40. /// @see gtx_component_wise
  41. template<typename genType>
  42. GLM_FUNC_DECL typename genType::value_type compAdd(genType const& v);
  43. /// Multiply all vector components together.
  44. /// @see gtx_component_wise
  45. template<typename genType>
  46. GLM_FUNC_DECL typename genType::value_type compMul(genType const& v);
  47. /// Find the minimum value between single vector components.
  48. /// @see gtx_component_wise
  49. template<typename genType>
  50. GLM_FUNC_DECL typename genType::value_type compMin(genType const& v);
  51. /// Find the maximum value between single vector components.
  52. /// @see gtx_component_wise
  53. template<typename genType>
  54. GLM_FUNC_DECL typename genType::value_type compMax(genType const& v);
  55. /// @}
  56. }//namespace glm
  57. #include "component_wise.inl"