Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenlib / BLI_easing.h
1 /*
2  * Copyright © 2001 Robert Penner
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  *   * Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  *
11  *   * Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  *
15  *   * Neither the name of the author nor the names of contributors may be
16  *     used to endorse or promote products derived from this software without
17  *     specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
23  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef __BLI_EASING_H__
32 #define __BLI_EASING_H__
33
34 /** \file \ingroup bli
35  */
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 float BLI_easing_back_ease_in(float time, float begin, float change, float duration, float overshoot);
42 float BLI_easing_back_ease_out(float time, float begin, float change, float duration, float overshoot);
43 float BLI_easing_back_ease_in_out(float time, float begin, float change, float duration, float overshoot);
44 float BLI_easing_bounce_ease_out(float time, float begin, float change, float duration);
45 float BLI_easing_bounce_ease_in(float time, float begin, float change, float duration);
46 float BLI_easing_bounce_ease_in_out(float time, float begin, float change, float duration);
47 float BLI_easing_circ_ease_in(float time, float begin, float change, float duration);
48 float BLI_easing_circ_ease_out(float time, float begin, float change, float duration);
49 float BLI_easing_circ_ease_in_out(float time, float begin, float change, float duration);
50 float BLI_easing_cubic_ease_in(float time, float begin, float change, float duration);
51 float BLI_easing_cubic_ease_out(float time, float begin, float change, float duration);
52 float BLI_easing_cubic_ease_in_out(float time, float begin, float change, float duration);
53 float BLI_easing_elastic_ease_in(float time, float begin, float change, float duration, float amplitude, float period);
54 float BLI_easing_elastic_ease_out(float time, float begin, float change, float duration, float amplitude, float period);
55 float BLI_easing_elastic_ease_in_out(float time, float begin, float change, float duration, float amplitude, float period);
56 float BLI_easing_expo_ease_in(float time, float begin, float change, float duration);
57 float BLI_easing_expo_ease_out(float time, float begin, float change, float duration);
58 float BLI_easing_expo_ease_in_out(float time, float begin, float change, float duration);
59 float BLI_easing_linear_ease(float time, float begin, float change, float duration);
60 float BLI_easing_quad_ease_in(float time, float begin, float change, float duration);
61 float BLI_easing_quad_ease_out(float time, float begin, float change, float duration);
62 float BLI_easing_quad_ease_in_out(float time, float begin, float change, float duration);
63 float BLI_easing_quart_ease_in(float time, float begin, float change, float duration);
64 float BLI_easing_quart_ease_out(float time, float begin, float change, float duration);
65 float BLI_easing_quart_ease_in_out(float time, float begin, float change, float duration);
66 float BLI_easing_quint_ease_in(float time, float begin, float change, float duration);
67 float BLI_easing_quint_ease_out(float time, float begin, float change, float duration);
68 float BLI_easing_quint_ease_in_out(float time, float begin, float change, float duration);
69 float BLI_easing_sine_ease_in(float time, float begin, float change, float duration);
70 float BLI_easing_sine_ease_out(float time, float begin, float change, float duration);
71 float BLI_easing_sine_ease_in_out(float time, float begin, float change, float duration);
72
73 #ifdef __cplusplus
74 }
75 #endif
76
77 #endif  /* __BLI_EASING_H__ */