1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
/*
* Copyright © Canonical Ltd.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 2 or 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MIR_TOOLKIT_TOUCH_EVENT_H_
#define MIR_TOOLKIT_TOUCH_EVENT_H_
#ifdef __cplusplus
extern "C" {
#endif
/**
* An event type describing a change in touch device state.
*/
typedef struct MirTouchEvent MirTouchEvent;
/**
* An identifier for a touch-point. TouchId's are unique per-gesture.
* That is to say, once a touch has gone down at time T, no other touch will
* use that touch's ID until all touches at time T have come up.
*/
typedef int32_t MirTouchId;
/**
* Retrieve the modifier keys pressed when the touch action occured.
*
* \param [in] event The key event
* \return The modifier mask
*/
MirInputEventModifiers mir_touch_event_modifiers(MirTouchEvent const* event);
/**
* Retrieve the number of touches reported for a given touch event. Each touch
* is said to be index in the event and may be accessed by index 0, 1, ... , (touch_count - 1)
*
* \param [in] event The touch event
* \return The number of touches
*/
unsigned int mir_touch_event_point_count(MirTouchEvent const* event);
/**
* Retrieve the TouchID for a touch at given index.
*
* \param [in] event The touch event
* \param [in] touch_index The touch index. Must be less than (touch_count - 1).
* \return ID of the touch at index
*/
MirTouchId mir_touch_event_id(MirTouchEvent const* event, size_t touch_index);
/**
* Retrieve the action which occured for a touch at given index.
*
* \param [in] event The touch event
* \param [in] touch_index The touch index. Must be less than (touch_count - 1).
* \return Action performed for the touch at index.
*/
MirTouchAction mir_touch_event_action(MirTouchEvent const* event, size_t touch_index);
/**
* Retrieve the tooltype for touch at given index.
*
* \param [in] event The touch event
* \param [in] touch_index The touch index. Must be less than (touch_count - 1).
* \return Tooltype used for the touch at index
*/
MirTouchTooltype mir_touch_event_tooltype(MirTouchEvent const* event,
size_t touch_index);
/**
* Retrieve the axis value for a given axis on an indexed touch.
*
* \param [in] event The touch event
* \param [in] touch_index The touch index. Must be less than (touch_count - 1).
* \param [in] axis The axis to retreive a value from
* \return The value of the given axis
*/
float mir_touch_event_axis_value(MirTouchEvent const* event,
size_t touch_index, MirTouchAxis axis);
/**
* Retrieve the corresponding input event.
*
* \param [in] event The touch event
* \return The input event
*/
MirInputEvent const* mir_touch_event_input_event(MirTouchEvent const* event);
#ifdef __cplusplus
}
#endif
#endif /* MIR_TOOLKIT_TOUCH_EVENT_H_ */
|
