Mir
touch_event.h
Go to the documentation of this file.
1/*
2 * Copyright © 2014 Canonical Ltd.
3 *
4 * This program is free software: you can redistribute it and/or modify it
5 * under the terms of the GNU Lesser General Public License version 2 or 3,
6 * as published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU Lesser General Public License for more details.
12 *
13 * You should have received a copy of the GNU Lesser General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 *
16 * Authored by: Robert Carr <robert.carr@canonical.com>
17 */
18
19#ifndef MIR_TOOLKIT_TOUCH_EVENT_H_
20#define MIR_TOOLKIT_TOUCH_EVENT_H_
21
22#ifdef __cplusplus
27extern "C" {
28#endif
29
34
40typedef int32_t MirTouchId;
41
45typedef enum {
46 /* This touch point is going up */
48 /* This touch point is going down */
50 /* Axis values have changed on this touch point */
52
55
59typedef enum {
60/* Axis representing the x coordinate for the touch */
62/* Axis representing the y coordinate for the touch */
64/* Axis representing pressure of the touch */
66/* Axis representing the length of the major axis of an ellipse
67 centered at the touch point */
69/* Axis representing the length of the minor axis of an ellipse
70 centered at the touch point */
72/* Axis representing the diameter of a circle centered on the touch
73 point */
75
78
82typedef enum {
83// Tool type could not be determined
85// Touch is made with a finger
87// Touch is made with a stylus
89
92
100
109
117MirTouchId mir_touch_event_id(MirTouchEvent const* event, size_t touch_index);
118
126MirTouchAction mir_touch_event_action(MirTouchEvent const* event, size_t touch_index);
127
136 size_t touch_index);
137
138
148 size_t touch_index, MirTouchAxis axis);
149
157
158#ifdef __cplusplus
159}
161#endif
162
163#endif /* MIR_TOOLKIT_TOUCH_EVENT_H_ */
unsigned int mir_touch_event_point_count(MirTouchEvent const *event)
Retrieve the number of touches reported for a given touch event.
MirTouchAction mir_touch_event_action(MirTouchEvent const *event, size_t touch_index)
Retrieve the action which occured for a touch at given index.
MirTouchTooltype mir_touch_event_tooltype(MirTouchEvent const *event, size_t touch_index)
Retrieve the tooltype for touch at given index.
MirInputEventModifiers mir_touch_event_modifiers(MirTouchEvent const *event)
Retrieve the modifier keys pressed when the touch action occured.
float mir_touch_event_axis_value(MirTouchEvent const *event, size_t touch_index, MirTouchAxis axis)
Retrieve the axis value for a given axis on an indexed touch.
int32_t MirTouchId
An identifier for a touch-point.
Definition: touch_event.h:40
struct MirInputEvent MirInputEvent
Definition: event.h:70
MirTouchAxis
Identifiers for touch axis.
Definition: touch_event.h:59
MirTouchId mir_touch_event_id(MirTouchEvent const *event, size_t touch_index)
Retrieve the TouchID for a touch at given index.
MirTouchTooltype
Identifiers for per-touch tool types.
Definition: touch_event.h:82
MirTouchAction
Possible per touch actions for state changing.
Definition: touch_event.h:45
struct MirTouchEvent MirTouchEvent
An event type describing a change in touch device state.
Definition: touch_event.h:33
MirInputEvent const * mir_touch_event_input_event(MirTouchEvent const *event)
Retrieve the corresponding input event.
unsigned int MirInputEventModifiers
Definition: input_event.h:67
@ mir_touch_axis_y
Definition: touch_event.h:63
@ mir_touch_axis_pressure
Definition: touch_event.h:65
@ mir_touch_axis_touch_minor
Definition: touch_event.h:71
@ mir_touch_axes
Definition: touch_event.h:76
@ mir_touch_axis_touch_major
Definition: touch_event.h:68
@ mir_touch_axis_x
Definition: touch_event.h:61
@ mir_touch_axis_size
Definition: touch_event.h:74
@ mir_touch_tooltype_finger
Definition: touch_event.h:86
@ mir_touch_tooltypes
Definition: touch_event.h:90
@ mir_touch_tooltype_stylus
Definition: touch_event.h:88
@ mir_touch_tooltype_unknown
Definition: touch_event.h:84
@ mir_touch_action_down
Definition: touch_event.h:49
@ mir_touch_actions
Definition: touch_event.h:53
@ mir_touch_action_up
Definition: touch_event.h:47
@ mir_touch_action_change
Definition: touch_event.h:51

Copyright © 2012-2022 Canonical Ltd.
Generated on Wed Dec 28 21:01:08 UTC 2022
This documentation is licensed under the GPL version 2 or 3.