Fix documentation for libinput_log_set_handler
[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 <stdbool.h>
29 #include <stdint.h>
30
31 struct motion_params {
32         double dx, dy; /* in units/ms @ 400dpi */
33 };
34
35 struct motion_filter;
36
37 void
38 filter_dispatch(struct motion_filter *filter,
39                 struct motion_params *motion,
40                 void *data, uint64_t time);
41 void
42 filter_destroy(struct motion_filter *filter);
43
44 bool
45 filter_set_speed(struct motion_filter *filter,
46                  double speed);
47 double
48 filter_get_speed(struct motion_filter *filter);
49
50 typedef double (*accel_profile_func_t)(struct motion_filter *filter,
51                                        void *data,
52                                        double velocity,
53                                        uint64_t time);
54
55 struct motion_filter *
56 create_pointer_accelerator_filter(accel_profile_func_t filter);
57
58
59 /*
60  * Pointer acceleration profiles.
61  */
62
63 double
64 pointer_accel_profile_linear(struct motion_filter *filter,
65                              void *data,
66                              double speed_in,
67                              uint64_t time);
68 #endif /* FILTER_H */