Document that the delta from pointer events is accelerated

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
This commit is contained in:
Peter Hutterer 2014-07-23 18:03:15 +10:00
parent 61995348d9
commit d429da529c

View file

@ -427,6 +427,9 @@ libinput_event_pointer_get_time(struct libinput_event_pointer *event);
* events that are not of type LIBINPUT_EVENT_POINTER_MOTION, this function
* returns 0.
*
* If a device employs pointer acceleration, the delta returned by this
* function is the accelerated delta.
*
* @note It is an application bug to call this function for events other than
* LIBINPUT_EVENT_POINTER_MOTION.
*
@ -442,6 +445,9 @@ libinput_event_pointer_get_dx(struct libinput_event_pointer *event);
* events that are not of type LIBINPUT_EVENT_POINTER_MOTION, this function
* returns 0.
*
* If a device employs pointer acceleration, the delta returned by this
* function is the accelerated delta.
*
* @note It is an application bug to call this function for events other than
* LIBINPUT_EVENT_POINTER_MOTION.
*