Fix two doxygen errors
[platform/upstream/libinput.git] / src / filter.h
1 /*
2  * Copyright © 2012 Jonas Ådahl
3  *
4  * Permission to use, copy, modify, distribute, and sell this software and
5  * its documentation for any purpose is hereby granted without fee, provided
6  * that the above copyright notice appear in all copies and that both that
7  * copyright notice and this permission notice appear in supporting
8  * documentation, and that the name of the copyright holders not be used in
9  * advertising or publicity pertaining to distribution of the software
10  * without specific, written prior permission.  The copyright holders make
11  * no representations about the suitability of this software for any
12  * purpose.  It is provided "as is" without express or implied warranty.
13  *
14  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
15  * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
16  * FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
17  * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
18  * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
19  * CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
20  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21  */
22
23 #ifndef FILTER_H
24 #define FILTER_H
25
26 #include "config.h"
27
28 #include <stdint.h>
29
30 struct motion_params {
31         double dx, dy; /* in units/ms @ 400dpi */
32 };
33
34 struct motion_filter;
35
36 void
37 filter_dispatch(struct motion_filter *filter,
38                 struct motion_params *motion,
39                 void *data, uint64_t time);
40 void
41 filter_destroy(struct motion_filter *filter);
42
43
44 struct motion_filter_interface {
45         void (*filter)(struct motion_filter *filter,
46                        struct motion_params *motion,
47                        void *data, uint64_t time);
48         void (*destroy)(struct motion_filter *filter);
49 };
50
51 struct motion_filter {
52         struct motion_filter_interface *interface;
53 };
54
55 struct motion_filter *
56 create_linear_acceleration_filter(double speed);
57
58 typedef double (*accel_profile_func_t)(struct motion_filter *filter,
59                                        void *data,
60                                        double velocity,
61                                        uint64_t time);
62
63 struct motion_filter *
64 create_pointer_accelator_filter(accel_profile_func_t filter);
65
66
67 /*
68  * Pointer acceleration profiles.
69  */
70
71 /*
72  * Profile similar which is similar to nonaccelerated but with a smooth
73  * transition between accelerated and non-accelerated.
74  */
75 double
76 pointer_accel_profile_smooth_simple(struct motion_filter *filter,
77                                     void *data,
78                                     double velocity,
79                                     uint64_t time);
80
81 #endif /* FILTER_H */