protocol: disambiguate key codes in wl_keyboard.key

Explain that wl_keyboard.key yields platform-specific key codes.
Some compositors use Linux key codes (defined in the
linux/input-event-codes.h header file, e.g. KEY_ESC), however
clients should not assume that this is always the case. The only
reliable way for clients to interpret key codes is to feed them
into a keyboard mapping.

Signed-off-by: Simon Ser <contact@emersion.fr>
This commit is contained in:
Simon Ser 2020-02-03 15:45:58 +01:00
parent 57b7c7d946
commit 1dfd2169da
No known key found for this signature in database
GPG Key ID: 0FDE7BE0E88F5E48

View File

@ -2240,6 +2240,9 @@
The time argument is a timestamp with millisecond The time argument is a timestamp with millisecond
granularity, with an undefined base. granularity, with an undefined base.
The key is a platform-specific key code that can be interpreted
by feeding it to the keyboard mapping (see the keymap event).
If this event produces a change in modifiers, then the resulting If this event produces a change in modifiers, then the resulting
wl_keyboard.modifiers event must be sent after this event. wl_keyboard.modifiers event must be sent after this event.
</description> </description>