fdo-mirrors/libei
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libinput/libei.git synced 2026-01-03 17:20:11 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: fix the documentation for the eis capabilities

Browse source
This commit is contained in:
Peter Hutterer 2022-03-04 11:52:03 +10:00
parent 30895bd825
commit d695cf1ab7
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
src/libei.h
View file

@ -123,15 +123,16 @@ struct ei_region;
/**
* @enum ei_device_capability
*
* The set of supported capabilities. A device may have one or more
* capabilities but never zero - a EIS implementation must reject any
* device with zero capabilities.
* The set of supported capabilities. A device may have zero or more
* capabilities, a device with perceived zero capabilities is typically a
* device with capabilities unsupported by the client.
*
* Capabilities are requested by the client but the EIS
* implementation may further reduce the capabilities. For example, a client
* may request the pointer and keyboard capability but only the former is
* permitted by the server. Any keyboard events sent by such a device events
* will be treated as client bug and discarded.
* Capabilities are initialized by the EIS implementation but the client may
* further reduce the requested capabilities, see ei_seat_drop_capability().
* For example, a client may bind to a seat with the pointer and keyboard
* capability but only the former is permitted by the EIS implementation.
* Keyboard events sent through such a device will be treated as client bug
* and discarded.
*
* See eis_device_has_capability().
*