Add a documentation note to update the slot after syncing

Clients may not care about the events generated during SYN_DROPPED, but the
current slot must be updated to avoid a client being out-of-date.
Same with tracking IDs, if they changed, the caller will likely have to update
some internal states.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Benjamin Tissoires <benjamin.tissoires@gmail.com>
This commit is contained in:
Peter Hutterer 2014-03-06 12:38:47 +10:00
parent 41334b5b40
commit 6ba45a0006

View file

@ -707,7 +707,11 @@ enum libevdev_read_status {
* If a device needs to be synced by the caller but the caller does not call
* with the @ref LIBEVDEV_READ_FLAG_SYNC flag set, all events from the diff are
* dropped after libevdev updates its internal state and event processing
* continues as normal.
* continues as normal. Note that the current slot and the state of touch
* points may have updated during the SYN_DROPPED event, it is strongly
* recommended that a caller ignoring all sync events calls
* libevdev_get_current_slot() and checks the ABS_MT_TRACKING_ID values for
* all slots.
*
* If a device has changed state without events being enqueued in libevdev,
* e.g. after changing the file descriptor, use the @ref