Document that the delta from pointer events is accelerated

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>

diff --git a/src/libinput.h b/src/libinput.h
index 3cd8e7b..1e8ae67 100644 (file)
--- a/src/libinput.h
+++ b/src/libinput.h
@@ -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.
  *