| 1.0.2 API documentation

easing.hpp
Go to the documentation of this file.
1
17 #pragma once
18
19 // Dependency:
20 #include "../glm.hpp"
21 #include "../gtc/constants.hpp"
22 #include "../detail/qualifier.hpp"
23
24 #ifndef GLM_ENABLE_EXPERIMENTAL
25 # error "GLM: GLM_GTX_easing 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."
26 #elif GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
27 # pragma message("GLM: GLM_GTX_easing extension included")
28 #endif
29
30 namespace glm{
33
36 template <typename genType>
37 GLM_FUNC_DECL genType linearInterpolation(genType const & a);
38
41 template <typename genType>
42 GLM_FUNC_DECL genType quadraticEaseIn(genType const & a);
43
46 template <typename genType>
47 GLM_FUNC_DECL genType quadraticEaseOut(genType const & a);
48
53 template <typename genType>
54 GLM_FUNC_DECL genType quadraticEaseInOut(genType const & a);
55
57 template <typename genType>
58 GLM_FUNC_DECL genType cubicEaseIn(genType const & a);
59
62 template <typename genType>
63 GLM_FUNC_DECL genType cubicEaseOut(genType const & a);
64
69 template <typename genType>
70 GLM_FUNC_DECL genType cubicEaseInOut(genType const & a);
71
74 template <typename genType>
75 GLM_FUNC_DECL genType quarticEaseIn(genType const & a);
76
79 template <typename genType>
80 GLM_FUNC_DECL genType quarticEaseOut(genType const & a);
81
86 template <typename genType>
87 GLM_FUNC_DECL genType quarticEaseInOut(genType const & a);
88
91 template <typename genType>
92 GLM_FUNC_DECL genType quinticEaseIn(genType const & a);
93
96 template <typename genType>
97 GLM_FUNC_DECL genType quinticEaseOut(genType const & a);
98
103 template <typename genType>
104 GLM_FUNC_DECL genType quinticEaseInOut(genType const & a);
105
108 template <typename genType>
109 GLM_FUNC_DECL genType sineEaseIn(genType const & a);
110
113 template <typename genType>
114 GLM_FUNC_DECL genType sineEaseOut(genType const & a);
115
118 template <typename genType>
119 GLM_FUNC_DECL genType sineEaseInOut(genType const & a);
120
123 template <typename genType>
124 GLM_FUNC_DECL genType circularEaseIn(genType const & a);
125
128 template <typename genType>
129 GLM_FUNC_DECL genType circularEaseOut(genType const & a);
130
135 template <typename genType>
136 GLM_FUNC_DECL genType circularEaseInOut(genType const & a);
137
140 template <typename genType>
141 GLM_FUNC_DECL genType exponentialEaseIn(genType const & a);
142
145 template <typename genType>
146 GLM_FUNC_DECL genType exponentialEaseOut(genType const & a);
147
152 template <typename genType>
153 GLM_FUNC_DECL genType exponentialEaseInOut(genType const & a);
154
157 template <typename genType>
158 GLM_FUNC_DECL genType elasticEaseIn(genType const & a);
159
162 template <typename genType>
163 GLM_FUNC_DECL genType elasticEaseOut(genType const & a);
164
169 template <typename genType>
170 GLM_FUNC_DECL genType elasticEaseInOut(genType const & a);
171
173 template <typename genType>
174 GLM_FUNC_DECL genType backEaseIn(genType const& a);
175
177 template <typename genType>
178 GLM_FUNC_DECL genType backEaseOut(genType const& a);
179
181 template <typename genType>
182 GLM_FUNC_DECL genType backEaseInOut(genType const& a);
183
187 template <typename genType>
188 GLM_FUNC_DECL genType backEaseIn(genType const& a, genType const& o);
189
193 template <typename genType>
194 GLM_FUNC_DECL genType backEaseOut(genType const& a, genType const& o);
195
199 template <typename genType>
200 GLM_FUNC_DECL genType backEaseInOut(genType const& a, genType const& o);
201
203 template <typename genType>
204 GLM_FUNC_DECL genType bounceEaseIn(genType const& a);
205
207 template <typename genType>
208 GLM_FUNC_DECL genType bounceEaseOut(genType const& a);
209
211 template <typename genType>
212 GLM_FUNC_DECL genType bounceEaseInOut(genType const& a);
213
215 }//namespace glm
216
217 #include "easing.inl"
glm::cubicEaseInOut
GLM_FUNC_DECL genType cubicEaseInOut(genType const &a)
Modelled after the piecewise cubic y = (1/2)((2x)^3) ; [0, 0.5) y = (1/2)((2x-2)^3 + 2) ; [0....
glm::exponentialEaseIn
GLM_FUNC_DECL genType exponentialEaseIn(genType const &a)
Modelled after the exponential function y = 2^(10(x - 1))
glm::quinticEaseIn
GLM_FUNC_DECL genType quinticEaseIn(genType const &a)
Modelled after the quintic y = x^5.
glm::backEaseIn
GLM_FUNC_DECL genType backEaseIn(genType const &a, genType const &o)
glm::backEaseInOut
GLM_FUNC_DECL genType backEaseInOut(genType const &a, genType const &o)
glm::quadraticEaseOut
GLM_FUNC_DECL genType quadraticEaseOut(genType const &a)
Modelled after the parabola y = -x^2 + 2x.
glm::circularEaseIn
GLM_FUNC_DECL genType circularEaseIn(genType const &a)
Modelled after shifted quadrant IV of unit circle.
glm::linearInterpolation
GLM_FUNC_DECL genType linearInterpolation(genType const &a)
Modelled after the line y = x.
glm::bounceEaseOut
GLM_FUNC_DECL genType bounceEaseOut(genType const &a)
glm::exponentialEaseInOut
GLM_FUNC_DECL genType exponentialEaseInOut(genType const &a)
Modelled after the piecewise exponential y = (1/2)2^(10(2x - 1)) ; [0,0.5) y = -(1/2)*2^(-10(2x - 1))...
glm::sineEaseInOut
GLM_FUNC_DECL genType sineEaseInOut(genType const &a)
Modelled after half sine wave.
glm::quarticEaseOut
GLM_FUNC_DECL genType quarticEaseOut(genType const &a)
Modelled after the quartic y = 1 - (x - 1)^4.
glm::sineEaseIn
GLM_FUNC_DECL genType sineEaseIn(genType const &a)
Modelled after quarter-cycle of sine wave.
glm::quadraticEaseInOut
GLM_FUNC_DECL genType quadraticEaseInOut(genType const &a)
Modelled after the piecewise quadratic y = (1/2)((2x)^2) ; [0, 0.5) y = -(1/2)((2x-1)*(2x-3) - 1) ; [...
glm::quinticEaseInOut
GLM_FUNC_DECL genType quinticEaseInOut(genType const &a)
Modelled after the piecewise quintic y = (1/2)((2x)^5) ; [0, 0.5) y = (1/2)((2x-2)^5 + 2) ; [0....
glm::backEaseOut
GLM_FUNC_DECL genType backEaseOut(genType const &a, genType const &o)
glm::circularEaseOut
GLM_FUNC_DECL genType circularEaseOut(genType const &a)
Modelled after shifted quadrant II of unit circle.
glm::bounceEaseInOut
GLM_FUNC_DECL genType bounceEaseInOut(genType const &a)
glm::bounceEaseIn
GLM_FUNC_DECL genType bounceEaseIn(genType const &a)
glm::cubicEaseOut
GLM_FUNC_DECL genType cubicEaseOut(genType const &a)
Modelled after the cubic y = (x - 1)^3 + 1.
glm::quadraticEaseIn
GLM_FUNC_DECL genType quadraticEaseIn(genType const &a)
Modelled after the parabola y = x^2.
glm::cubicEaseIn
GLM_FUNC_DECL genType cubicEaseIn(genType const &a)
Modelled after the cubic y = x^3.
glm::quarticEaseInOut
GLM_FUNC_DECL genType quarticEaseInOut(genType const &a)
Modelled after the piecewise quartic y = (1/2)((2x)^4) ; [0, 0.5) y = -(1/2)((2x-2)^4 - 2) ; [0....
glm::quinticEaseOut
GLM_FUNC_DECL genType quinticEaseOut(genType const &a)
Modelled after the quintic y = (x - 1)^5 + 1.
glm::elasticEaseInOut
GLM_FUNC_DECL genType elasticEaseInOut(genType const &a)
Modelled after the piecewise exponentially-damped sine wave: y = (1/2)*sin(13pi/2*(2*x))*pow(2,...
glm::circularEaseInOut
GLM_FUNC_DECL genType circularEaseInOut(genType const &a)
Modelled after the piecewise circular function y = (1/2)(1 - sqrt(1 - 4x^2)) ; [0,...
glm::sineEaseOut
GLM_FUNC_DECL genType sineEaseOut(genType const &a)
Modelled after quarter-cycle of sine wave (different phase)
glm::elasticEaseIn
GLM_FUNC_DECL genType elasticEaseIn(genType const &a)
Modelled after the damped sine wave y = sin(13pi/2*x)*pow(2, 10 * (x - 1))
glm::elasticEaseOut
GLM_FUNC_DECL genType elasticEaseOut(genType const &a)
Modelled after the damped sine wave y = sin(-13pi/2*(x + 1))*pow(2, -10x) + 1.
glm::quarticEaseIn
GLM_FUNC_DECL genType quarticEaseIn(genType const &a)
Modelled after the quartic x^4.
glm::exponentialEaseOut
GLM_FUNC_DECL genType exponentialEaseOut(genType const &a)
Modelled after the exponential function y = -2^(-10x) + 1.