fdo-mirrors/libei
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libinput/libei.git synced 2026-02-04 14:10:27 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

proto: add a blurb about events to send during stop_emulating

Browse source 
This should've been specified from day one but better late than never.
Since stop_emulating is supposed to signal termination of a client
emulating input, a logical assumption is that the device is set back to
neutral. Let's point it out that the real behavior is within EIS but
clients should behave predictably.

Part-of: <https://gitlab.freedesktop.org/libinput/libei/-/merge_requests/368>
This commit is contained in:
Peter Hutterer 2025-12-10 15:17:22 +10:00 • committed by Marge Bot
parent 57064f6846
commit 180c9f2890
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
proto/protocol.xml
View file

@ -645,6 +645,12 @@
It is a protocol violation to send this request for a client
of an ei_handshake.context_type other than sender.
It is up to the EIS implementation to reset the device state when a
stop_emulating event is received. The recommendation is that the device
is set to a neutral state such that all touches, buttons, keys are logically up.
A client should send the corresponding events before stop_emulating
to avoid any ambiguity on event interpretation.
</description>
<arg name="last_serial" type="uint32" summary="the last serial sent by the EIS implementation"/>
</request>
@ -1247,6 +1253,10 @@
It is a protocol violation to send this request for a client
of an ei_handshake.context_type other than sender.
A client should send a ei_button.button release event before
ei_device.stop_emulating to avoid any ambiguity on interpretation
of button events.
</description>
<arg name="button" type="uint32" summary="button code"/>
<arg name="state" type="uint32" enum="button_state"/>
@ -1323,6 +1333,10 @@
It is a protocol violation to send this request for a client
of an ei_handshake.context_type other than sender.
A client should send a ei_key.key release event before
ei_device.stop_emulating to avoid any ambiguity on interpretation
of key events.
</description>
<arg name="key" type="uint32" summary="the key code"/>
<arg name="state" type="uint32" enum="key_state" summary="logical state of the key"/>
@ -1475,6 +1489,10 @@
It is a protocol violation to send a touch down in the same
frame as a touch motion or touch up.
A client should send a ei_touch.up or ei_touch.cancel event before
ei_device.stop_emulating to avoid any ambiguity on interpretation of touch
events.
</description>
<arg name="touchid" type="uint32" summary="a unique touch id to identify this touch"/>
<arg name="x" type="float" summary="touch x coordinate in logical pixels"/>