summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2015-12-15 12:39:52 +1000
committerPeter Hutterer <peter.hutterer@who-t.net>2015-12-23 07:55:11 +1000
commitcbb9e9e809c14e70658d269b0af771ba93b1d507 (patch)
treecc5173adcc0f7def2f4c2cf32a97cb079a67257f /doc
parent7309fd0ed38170757946bf21e4542a249be0452c (diff)
tablet: add libinput_tablet_tool_is_unique()
For checking if a tablet tool can be uniquely identified by libinput. In practice this means checking for a nonzero serial number, but let's not restrict ourselves to allowing just that. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> Reviewed-by: Hans de Goede <hdegoede@redhat.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/tablet-support.dox4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/tablet-support.dox b/doc/tablet-support.dox
index ac56e47a..fbe778da 100644
--- a/doc/tablet-support.dox
+++ b/doc/tablet-support.dox
@@ -126,7 +126,9 @@ and @ref LIBINPUT_TABLET_TOOL_TYPE_LENS tools.
Some tools provide hardware information that enables libinput to uniquely
identify the physical device. For example, tools compatible with the Wacom
Intuos 4, Intuos 5, Intuos Pro and Cintiq series are uniquely identifiable
-through a serial number.
+through a serial number. libinput does not specify how a tool can be
+identified uniquely, a caller should use libinput_tablet_tool_is_unique() to
+check if the tool is unique.
libinput creates a struct libinput_tablet_tool on the first proximity in of
this tool. By default, this struct is destroyed on proximity out and