summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2016-05-24 11:47:48 +1000
committerPeter Hutterer <peter.hutterer@who-t.net>2016-05-24 14:40:48 +1000
commit40e3fe23849e90e50c6bdb4e848b7be120c101a1 (patch)
tree616139cdaa55fd5bf2f58cc83dfac670114064c3 /src
parentc2dfe504ed7110e1cf85c52f7b8495dc0b5f08d8 (diff)
doc: update ref/unref behavior for the tablet tool
Brings it in line with the rest of libinput. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Diffstat (limited to 'src')
-rw-r--r--src/libinput.h11
1 files changed, 7 insertions, 4 deletions
diff --git a/src/libinput.h b/src/libinput.h
index 1922ef4b..ed3eb7d7 100644
--- a/src/libinput.h
+++ b/src/libinput.h
@@ -1901,10 +1901,13 @@ libinput_event_tablet_tool_get_y_transformed(struct libinput_event_tablet_tool *
*
* Returns the tool that was in use during this event.
*
- * If the caller holds at least one reference (see
- * libinput_tablet_tool_ref()), this struct is used whenever the
- * tools enters proximity. Otherwise, if no references remain when the tool
- * leaves proximity, the tool may be destroyed.
+ * The returned tablet tool is not refcounted and may become invalid after
+ * the next call to libinput. Use libinput_tablet_tool_ref() and
+ * libinput_tablet_tool_unref() to continue using the handle outside of the
+ * immediate scope.
+ *
+ * If the caller holds at least one reference, this struct is used
+ * whenever the tools enters proximity again.
*
* @note Physical tool tracking requires hardware support. If unavailable,
* libinput creates one tool per type per tablet. See @ref