0.9.9 API documenation
easing.hpp
Go to the documentation of this file.
1 
17 #pragma once
18 
19 // Dependency:
20 #include "../glm.hpp"
21 #include "../detail/setup.hpp"
22 #include "../detail/qualifier.hpp"
23 #include "../detail/type_int.hpp"
24 #include "../gtc/constants.hpp"
25 
26 #ifndef GLM_ENABLE_EXPERIMENTAL
27 # 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."
28 #endif
29 
30 #if GLM_MESSAGES == GLM_MESSAGES_ENABLED && !defined(GLM_EXT_INCLUDED)
31 # pragma message("GLM: GLM_GTX_easing extension included")
32 #endif
33 
34 namespace glm{
37 
40  template <typename genType>
41  GLM_FUNC_DECL genType linearInterpolation(genType const & a);
42 
45  template <typename genType>
46  GLM_FUNC_DECL genType quadraticEaseIn(genType const & a);
47 
50  template <typename genType>
51  GLM_FUNC_DECL genType quadraticEaseOut(genType const & a);
52 
57  template <typename genType>
58  GLM_FUNC_DECL genType quadraticEaseInOut(genType const & a);
59 
61  template <typename genType>
62  GLM_FUNC_DECL genType cubicEaseIn(genType const & a);
63 
66  template <typename genType>
67  GLM_FUNC_DECL genType cubicEaseOut(genType const & a);
68 
73  template <typename genType>
74  GLM_FUNC_DECL genType cubicEaseInOut(genType const & a);
75 
78  template <typename genType>
79  GLM_FUNC_DECL genType quarticEaseIn(genType const & a);
80 
83  template <typename genType>
84  GLM_FUNC_DECL genType quarticEaseOut(genType const & a);
85 
90  template <typename genType>
91  GLM_FUNC_DECL genType quarticEaseInOut(genType const & a);
92 
95  template <typename genType>
96  GLM_FUNC_DECL genType quinticEaseIn(genType const & a);
97 
100  template <typename genType>
101  GLM_FUNC_DECL genType quinticEaseOut(genType const & a);
102 
107  template <typename genType>
108  GLM_FUNC_DECL genType quinticEaseInOut(genType const & a);
109 
112  template <typename genType>
113  GLM_FUNC_DECL genType sineEaseIn(genType const & a);
114 
117  template <typename genType>
118  GLM_FUNC_DECL genType sineEaseOut(genType const & a);
119 
122  template <typename genType>
123  GLM_FUNC_DECL genType sineEaseInOut(genType const & a);
124 
127  template <typename genType>
128  GLM_FUNC_DECL genType circularEaseIn(genType const & a);
129 
132  template <typename genType>
133  GLM_FUNC_DECL genType circularEaseOut(genType const & a);
134 
139  template <typename genType>
140  GLM_FUNC_DECL genType circularEaseInOut(genType const & a);
141 
144  template <typename genType>
145  GLM_FUNC_DECL genType exponentialEaseIn(genType const & a);
146 
149  template <typename genType>
150  GLM_FUNC_DECL genType exponentialEaseOut(genType const & a);
151 
156  template <typename genType>
157  GLM_FUNC_DECL genType exponentialEaseInOut(genType const & a);
158 
161  template <typename genType>
162  GLM_FUNC_DECL genType elasticEaseIn(genType const & a);
163 
166  template <typename genType>
167  GLM_FUNC_DECL genType elasticEaseOut(genType const & a);
168 
173  template <typename genType>
174  GLM_FUNC_DECL genType elasticEaseInOut(genType const & a);
175 
177  template <typename genType>
178  GLM_FUNC_DECL genType backEaseIn(genType const& a);
179 
181  template <typename genType>
182  GLM_FUNC_DECL genType backEaseOut(genType const& a);
183 
185  template <typename genType>
186  GLM_FUNC_DECL genType backEaseInOut(genType const& a);
187 
191  template <typename genType>
192  GLM_FUNC_DECL genType backEaseIn(genType const& a, genType const& o);
193 
197  template <typename genType>
198  GLM_FUNC_DECL genType backEaseOut(genType const& a, genType const& o);
199 
203  template <typename genType>
204  GLM_FUNC_DECL genType backEaseInOut(genType const& a, genType const& o);
205 
207  template <typename genType>
208  GLM_FUNC_DECL genType bounceEaseIn(genType const& a);
209 
211  template <typename genType>
212  GLM_FUNC_DECL genType bounceEaseOut(genType const& a);
213 
215  template <typename genType>
216  GLM_FUNC_DECL genType bounceEaseInOut(genType const& a);
217 
219 }//namespace glm
220 
221 #include "easing.inl"
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::quarticEaseOut
GLM_FUNC_DECL genType quarticEaseOut(genType const &a)
Modelled after the quartic y = 1 - (x - 1)^4.
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, 0.5) y = (1/2)(sqrt(-(2x - 3)*(2x - 1)) + 1) ; [0.5, 1].
glm::quadraticEaseIn
GLM_FUNC_DECL genType quadraticEaseIn(genType const &a)
Modelled after the parabola y = x^2.
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::exponentialEaseIn
GLM_FUNC_DECL genType exponentialEaseIn(genType const &a)
Modelled after the exponential function y = 2^(10(x - 1))
glm::backEaseOut
GLM_FUNC_DECL genType backEaseOut(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::backEaseInOut
GLM_FUNC_DECL genType backEaseInOut(genType const &a, genType const &o)
glm::bounceEaseInOut
GLM_FUNC_DECL genType bounceEaseInOut(genType const &a)
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
Definition: common.hpp:20
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, 10 * ((2*x) - 1)) ; [0,0.5) y = (1/2)*(sin(-13pi/2*((2x-1)+1))*pow(2,-10(2*x-1)) + 2) ; [0.5, 1].
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::circularEaseIn
GLM_FUNC_DECL genType circularEaseIn(genType const &a)
Modelled after shifted quadrant IV of unit circle.
glm::backEaseIn
GLM_FUNC_DECL genType backEaseIn(genType const &a, genType const &o)
glm::quinticEaseOut
GLM_FUNC_DECL genType quinticEaseOut(genType const &a)
Modelled after the quintic y = (x - 1)^5 + 1.
glm::sineEaseInOut
GLM_FUNC_DECL genType sineEaseInOut(genType const &a)
Modelled after half sine wave.
glm::cubicEaseOut
GLM_FUNC_DECL genType cubicEaseOut(genType const &a)
Modelled after the cubic y = (x - 1)^3 + 1.
glm::linearInterpolation
GLM_FUNC_DECL genType linearInterpolation(genType const &a)
Modelled after the line y = x.
glm::exponentialEaseOut
GLM_FUNC_DECL genType exponentialEaseOut(genType const &a)
Modelled after the exponential function y = -2^(-10x) + 1.
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::circularEaseOut
GLM_FUNC_DECL genType circularEaseOut(genType const &a)
Modelled after shifted quadrant II of unit circle.
glm::bounceEaseIn
GLM_FUNC_DECL genType bounceEaseIn(genType const &a)
glm::quinticEaseIn
GLM_FUNC_DECL genType quinticEaseIn(genType const &a)
Modelled after the quintic y = x^5.
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::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::sineEaseOut
GLM_FUNC_DECL genType sineEaseOut(genType const &a)
Modelled after quarter-cycle of sine wave (different phase)
glm::bounceEaseOut
GLM_FUNC_DECL genType bounceEaseOut(genType const &a)
Generated by   doxygen 1.8.10