fdo-mirrors/libevdev
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libevdev/libevdev.git synced 2025-12-25 00:00:15 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document the FORCE_SYNC behavior a bit better

Browse source 
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
(cherry picked from commit 0deacd5c1e)
This commit is contained in:
Peter Hutterer 2014-03-04 13:29:27 +10:00
parent 6ac3da05b8
commit 7991546398
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
libevdev/libevdev.h
View file

@ -699,6 +699,13 @@ enum libevdev_read_status {
* dropped after libevdev updates its internal state and event processing
* continues as normal.
*
* If a device has changed state without events being enqueued in libevdev,
* e.g. after changing the file descriptor, use the @ref
* LIBEVDEV_READ_FLAG_FORCE_SYNC flag. This triggers an internal sync of the
* device and libevdev_next_event() returns @ref LIBEVDEV_READ_STATUS_SYNC.
* Any state changes are available as events as described above. If
* @ref LIBEVDEV_READ_FLAG_FORCE_SYNC is set, the value of ev is undefined.
*
* @param dev The evdev device, already initialized with libevdev_set_fd()
* @param flags Set of flags to determine behaviour. If @ref LIBEVDEV_READ_FLAG_NORMAL
* is set, the next event is read in normal mode. If @ref LIBEVDEV_READ_FLAG_SYNC is