normalize_dot.hpp 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. /// @ref gtx_normalize_dot
  2. /// @file glm/gtx/normalize_dot.hpp
  3. ///
  4. /// @see core (dependence)
  5. /// @see gtx_fast_square_root (dependence)
  6. ///
  7. /// @defgroup gtx_normalize_dot GLM_GTX_normalize_dot
  8. /// @ingroup gtx
  9. ///
  10. /// Include <glm/gtx/normalize_dot.hpp> to use the features of this extension.
  11. ///
  12. /// Dot product of vectors that need to be normalize with a single square root.
  13. #pragma once
  14. // Dependency:
  15. #include "../gtx/fast_square_root.hpp"
  16. #ifndef GLM_ENABLE_EXPERIMENTAL
  17. # error "GLM: GLM_GTX_normalize_dot 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."
  18. #elif GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
  19. # pragma message("GLM: GLM_GTX_normalize_dot extension included")
  20. #endif
  21. namespace glm
  22. {
  23. /// @addtogroup gtx_normalize_dot
  24. /// @{
  25. /// Normalize parameters and returns the dot product of x and y.
  26. /// It's faster that dot(normalize(x), normalize(y)).
  27. ///
  28. /// @see gtx_normalize_dot extension.
  29. template<length_t L, typename T, qualifier Q>
  30. GLM_FUNC_DECL T normalizeDot(vec<L, T, Q> const& x, vec<L, T, Q> const& y);
  31. /// Normalize parameters and returns the dot product of x and y.
  32. /// Faster that dot(fastNormalize(x), fastNormalize(y)).
  33. ///
  34. /// @see gtx_normalize_dot extension.
  35. template<length_t L, typename T, qualifier Q>
  36. GLM_FUNC_DECL T fastNormalizeDot(vec<L, T, Q> const& x, vec<L, T, Q> const& y);
  37. /// @}
  38. }//namespace glm
  39. #include "normalize_dot.inl"