fdo-mirrors/libinput
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libinput/libinput.git synced 2026-05-08 11:19:14 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Clarify proximity handling for tools always in proximity

Browse source 
No real effect on the code, but make clear what's going to happen.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
This commit is contained in:
Peter Hutterer 2015-02-10 16:13:51 +10:00
parent 90918f77e6
commit b9cdba6bd1
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
src/libinput.h
View file

@ -222,6 +222,16 @@ enum libinput_event_type {
/** /**
* Signals that a tool has come into proximity of a device with the @ref * Signals that a tool has come into proximity of a device with the @ref
* LIBINPUT_DEVICE_CAP_TABLET capability. * LIBINPUT_DEVICE_CAP_TABLET capability.
*
* Some tools may always be in proximity. For these tools, the @ref
* LIBINPUT_EVENT_TABLET_PROXIMITY_IN is sent only once after @ref
* LIBINPUT_EVENT_DEVICE_ADDED, and likewise the @ref
* LIBINPUT_EVENT_TABLET_PROXIMITY_OUT is sent only once before @ref
* LIBINPUT_EVENT_DEVICE_REMOVED.
*
* If the tool that comes into proximity supports x/y coordinates,
* libinput guarantees that both x and y are set in the proximity
* event.
*/ */
LIBINPUT_EVENT_TABLET_PROXIMITY_IN, LIBINPUT_EVENT_TABLET_PROXIMITY_IN,
/** /**
@ -232,6 +242,12 @@ enum libinput_event_type {
* are marked as released. Button release events for each button that * are marked as released. Button release events for each button that
* was held down on the stylus are sent before the initial proximity out * was held down on the stylus are sent before the initial proximity out
* event. * event.
*
* Some tools may always be in proximity. For these tools, the @ref
* LIBINPUT_EVENT_TABLET_PROXIMITY_IN is sent only once after @ref
* LIBINPUT_EVENT_DEVICE_ADDED, and likewise the @ref
* LIBINPUT_EVENT_TABLET_PROXIMITY_OUT is sent only once before @ref
* LIBINPUT_EVENT_DEVICE_REMOVED.
*/ */
LIBINPUT_EVENT_TABLET_PROXIMITY_OUT, LIBINPUT_EVENT_TABLET_PROXIMITY_OUT,
LIBINPUT_EVENT_TABLET_BUTTON LIBINPUT_EVENT_TABLET_BUTTON