master
ブランチ master
ShaderPlayground / deps / glm / glm / gtx / norm.hpp
2.2 KB、76行 生 Blame 履歴
1/// @ref gtx_norm
2/// @file glm/gtx/norm.hpp
3///
4/// @see core (dependence)
5/// @see gtx_quaternion (dependence)
6///
7/// @defgroup gtx_norm GLM_GTX_norm
8/// @ingroup gtx
9///
10/// Include <glm/gtx/norm.hpp> to use the features of this extension.
11///
12/// Various ways to compute vector norms.
13
14#pragma once
15
16// Dependency:
17#include "../geometric.hpp"
18#include "../gtx/quaternion.hpp"
19
20#ifndef GLM_ENABLE_EXPERIMENTAL
21# error "GLM: GLM_GTX_norm 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."
22#endif
23
24#if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
25# pragma message("GLM: GLM_GTX_norm extension included")
26#endif
27
28namespace glm
29{
30 /// @addtogroup gtx_norm
31 /// @{
32
33 /// Returns the squared length of x.
34 /// From GLM_GTX_norm extension.
35 template<length_t L, typename T, qualifier Q>
36 GLM_FUNC_DECL T length2(vec<L, T, Q> const& x);
37
38 /// Returns the squared distance between p0 and p1, i.e., length2(p0 - p1).
39 /// From GLM_GTX_norm extension.
40 template<length_t L, typename T, qualifier Q>
41 GLM_FUNC_DECL T distance2(vec<L, T, Q> const& p0, vec<L, T, Q> const& p1);
42
43 //! Returns the L1 norm between x and y.
44 //! From GLM_GTX_norm extension.
45 template<typename T, qualifier Q>
46 GLM_FUNC_DECL T l1Norm(vec<3, T, Q> const& x, vec<3, T, Q> const& y);
47
48 //! Returns the L1 norm of v.
49 //! From GLM_GTX_norm extension.
50 template<typename T, qualifier Q>
51 GLM_FUNC_DECL T l1Norm(vec<3, T, Q> const& v);
52
53 //! Returns the L2 norm between x and y.
54 //! From GLM_GTX_norm extension.
55 template<typename T, qualifier Q>
56 GLM_FUNC_DECL T l2Norm(vec<3, T, Q> const& x, vec<3, T, Q> const& y);
57
58 //! Returns the L2 norm of v.
59 //! From GLM_GTX_norm extension.
60 template<typename T, qualifier Q>
61 GLM_FUNC_DECL T l2Norm(vec<3, T, Q> const& x);
62
63 //! Returns the L norm between x and y.
64 //! From GLM_GTX_norm extension.
65 template<typename T, qualifier Q>
66 GLM_FUNC_DECL T lxNorm(vec<3, T, Q> const& x, vec<3, T, Q> const& y, unsigned int Depth);
67
68 //! Returns the L norm of v.
69 //! From GLM_GTX_norm extension.
70 template<typename T, qualifier Q>
71 GLM_FUNC_DECL T lxNorm(vec<3, T, Q> const& x, unsigned int Depth);
72
73 /// @}
74}//namespace glm
75
76#include "norm.inl"