fdo-mirrors/libinput
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libinput/libinput.git synced 2025-12-30 17:40:11 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: update ref/unref behavior for the tablet tool

Browse source 
Brings it in line with the rest of libinput.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
(cherry picked from commit 40e3fe2384)
This commit is contained in:
Peter Hutterer 2016-05-24 11:47:48 +10:00
parent 5acd9a373b
commit 23bacd16c3
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
src/libinput.h
View file

@ -1889,10 +1889,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