1.0.0 API documentation
constants.hpp
Go to the documentation of this file.
1 
13 #pragma once
14 
15 // Dependencies
16 #include "../ext/scalar_constants.hpp"
17 
18 #if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
19 # pragma message("GLM: GLM_GTC_constants extension included")
20 #endif
21 
22 namespace glm
23 {
26 
29  template<typename genType>
30  GLM_FUNC_DECL GLM_CONSTEXPR genType zero();
31 
34  template<typename genType>
35  GLM_FUNC_DECL GLM_CONSTEXPR genType one();
36 
39  template<typename genType>
40  GLM_FUNC_DECL GLM_CONSTEXPR genType two_pi();
41 
44  template<typename genType>
45  GLM_FUNC_DECL GLM_CONSTEXPR genType tau();
46 
49  template<typename genType>
50  GLM_FUNC_DECL GLM_CONSTEXPR genType root_pi();
51 
54  template<typename genType>
55  GLM_FUNC_DECL GLM_CONSTEXPR genType half_pi();
56 
59  template<typename genType>
60  GLM_FUNC_DECL GLM_CONSTEXPR genType three_over_two_pi();
61 
64  template<typename genType>
65  GLM_FUNC_DECL GLM_CONSTEXPR genType quarter_pi();
66 
69  template<typename genType>
70  GLM_FUNC_DECL GLM_CONSTEXPR genType one_over_pi();
71 
74  template<typename genType>
75  GLM_FUNC_DECL GLM_CONSTEXPR genType one_over_two_pi();
76 
79  template<typename genType>
80  GLM_FUNC_DECL GLM_CONSTEXPR genType two_over_pi();
81 
84  template<typename genType>
85  GLM_FUNC_DECL GLM_CONSTEXPR genType four_over_pi();
86 
89  template<typename genType>
90  GLM_FUNC_DECL GLM_CONSTEXPR genType two_over_root_pi();
91 
94  template<typename genType>
95  GLM_FUNC_DECL GLM_CONSTEXPR genType one_over_root_two();
96 
99  template<typename genType>
100  GLM_FUNC_DECL GLM_CONSTEXPR genType root_half_pi();
101 
104  template<typename genType>
105  GLM_FUNC_DECL GLM_CONSTEXPR genType root_two_pi();
106 
109  template<typename genType>
110  GLM_FUNC_DECL GLM_CONSTEXPR genType root_ln_four();
111 
114  template<typename genType>
115  GLM_FUNC_DECL GLM_CONSTEXPR genType e();
116 
119  template<typename genType>
120  GLM_FUNC_DECL GLM_CONSTEXPR genType euler();
121 
124  template<typename genType>
125  GLM_FUNC_DECL GLM_CONSTEXPR genType root_two();
126 
129  template<typename genType>
130  GLM_FUNC_DECL GLM_CONSTEXPR genType root_three();
131 
134  template<typename genType>
135  GLM_FUNC_DECL GLM_CONSTEXPR genType root_five();
136 
139  template<typename genType>
140  GLM_FUNC_DECL GLM_CONSTEXPR genType ln_two();
141 
144  template<typename genType>
145  GLM_FUNC_DECL GLM_CONSTEXPR genType ln_ten();
146 
149  template<typename genType>
150  GLM_FUNC_DECL GLM_CONSTEXPR genType ln_ln_two();
151 
154  template<typename genType>
155  GLM_FUNC_DECL GLM_CONSTEXPR genType third();
156 
159  template<typename genType>
160  GLM_FUNC_DECL GLM_CONSTEXPR genType two_thirds();
161 
164  template<typename genType>
165  GLM_FUNC_DECL GLM_CONSTEXPR genType golden_ratio();
166 
168 } //namespace glm
169 
170 #include "constants.inl"
glm::root_five
GLM_FUNC_DECL GLM_CONSTEXPR genType root_five()
Return sqrt(5).
glm::ln_ln_two
GLM_FUNC_DECL GLM_CONSTEXPR genType ln_ln_two()
Return ln(ln(2)).
glm::one_over_root_two
GLM_FUNC_DECL GLM_CONSTEXPR genType one_over_root_two()
Return 1 / sqrt(2).
glm::four_over_pi
GLM_FUNC_DECL GLM_CONSTEXPR genType four_over_pi()
Return 4 / pi.
glm::one
GLM_FUNC_DECL GLM_CONSTEXPR genType one()
Return 1.
glm::two_pi
GLM_FUNC_DECL GLM_CONSTEXPR genType two_pi()
Return pi * 2.
glm::root_two_pi
GLM_FUNC_DECL GLM_CONSTEXPR genType root_two_pi()
Return sqrt(2 * pi).
glm::third
GLM_FUNC_DECL GLM_CONSTEXPR genType third()
Return 1 / 3.
glm::root_ln_four
GLM_FUNC_DECL GLM_CONSTEXPR genType root_ln_four()
Return sqrt(ln(4)).
glm::half_pi
GLM_FUNC_DECL GLM_CONSTEXPR genType half_pi()
Return pi / 2.
glm::quarter_pi
GLM_FUNC_DECL GLM_CONSTEXPR genType quarter_pi()
Return pi / 4.
glm::root_pi
GLM_FUNC_DECL GLM_CONSTEXPR genType root_pi()
Return square root of pi.
glm::golden_ratio
GLM_FUNC_DECL GLM_CONSTEXPR genType golden_ratio()
Return the golden ratio constant.
glm::ln_two
GLM_FUNC_DECL GLM_CONSTEXPR genType ln_two()
Return ln(2).
glm::three_over_two_pi
GLM_FUNC_DECL GLM_CONSTEXPR genType three_over_two_pi()
Return pi / 2 * 3.
glm::two_over_root_pi
GLM_FUNC_DECL GLM_CONSTEXPR genType two_over_root_pi()
Return 2 / sqrt(pi).
glm::ln_ten
GLM_FUNC_DECL GLM_CONSTEXPR genType ln_ten()
Return ln(10).
glm::root_two
GLM_FUNC_DECL GLM_CONSTEXPR genType root_two()
Return sqrt(2).
glm::root_three
GLM_FUNC_DECL GLM_CONSTEXPR genType root_three()
Return sqrt(3).
glm::one_over_pi
GLM_FUNC_DECL GLM_CONSTEXPR genType one_over_pi()
Return 1 / pi.
glm::root_half_pi
GLM_FUNC_DECL GLM_CONSTEXPR genType root_half_pi()
Return sqrt(pi / 2).
glm::euler
GLM_FUNC_DECL GLM_CONSTEXPR genType euler()
Return Euler's constant.
glm::zero
GLM_FUNC_DECL GLM_CONSTEXPR genType zero()
Return 0.
glm::e
GLM_FUNC_DECL GLM_CONSTEXPR genType e()
Return e constant.
glm::one_over_two_pi
GLM_FUNC_DECL GLM_CONSTEXPR genType one_over_two_pi()
Return 1 / (pi * 2).
glm::tau
GLM_FUNC_DECL GLM_CONSTEXPR genType tau()
Return unit-circle circumference, or pi * 2.
glm::two_thirds
GLM_FUNC_DECL GLM_CONSTEXPR genType two_thirds()
Return 2 / 3.
glm::two_over_pi
GLM_FUNC_DECL GLM_CONSTEXPR genType two_over_pi()
Return 2 / pi.