component_wise.hpp 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  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. #ifndef GLM_ENABLE_EXPERIMENTAL
  19. # error "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."
  20. #endif
  21. #if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
  22. # pragma message("GLM: GLM_GTX_component_wise extension included")
  23. #endif
  24. namespace glm
  25. {
  26. /// @addtogroup gtx_component_wise
  27. /// @{
  28. /// Convert an integer vector to a normalized float vector.
  29. /// If the parameter value type is already a floating qualifier type, the value is passed through.
  30. /// @see gtx_component_wise
  31. template<typename floatType, length_t L, typename T, qualifier Q>
  32. GLM_FUNC_DECL vec<L, floatType, Q> compNormalize(vec<L, T, Q> const& v);
  33. /// Convert a normalized float vector to an integer vector.
  34. /// If the parameter value type is already a floating qualifier type, the value is passed through.
  35. /// @see gtx_component_wise
  36. template<length_t L, typename T, typename floatType, qualifier Q>
  37. GLM_FUNC_DECL vec<L, T, Q> compScale(vec<L, floatType, Q> const& v);
  38. /// Add all vector components together.
  39. /// @see gtx_component_wise
  40. template<typename genType>
  41. GLM_FUNC_DECL typename genType::value_type compAdd(genType const& v);
  42. /// Multiply all vector components together.
  43. /// @see gtx_component_wise
  44. template<typename genType>
  45. GLM_FUNC_DECL typename genType::value_type compMul(genType const& v);
  46. /// Find the minimum value between single vector components.
  47. /// @see gtx_component_wise
  48. template<typename genType>
  49. GLM_FUNC_DECL typename genType::value_type compMin(genType const& v);
  50. /// Find the maximum value between single vector components.
  51. /// @see gtx_component_wise
  52. template<typename genType>
  53. GLM_FUNC_DECL typename genType::value_type compMax(genType const& v);
  54. /// @}
  55. }//namespace glm
  56. #include "component_wise.inl"