summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2016-05-24 11:33:50 +1000
committerPeter Hutterer <peter.hutterer@who-t.net>2016-05-24 14:40:44 +1000
commitc2dfe504ed7110e1cf85c52f7b8495dc0b5f08d8 (patch)
tree0a1bd39d2b4b9ee39039ab8a6651b5393fd8aad9 /src
parente1915b53b5c9c8989535080de775a3e7e3e7c395 (diff)
doc: update doc to explicitly state that the seat isn't referenced
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Diffstat (limited to 'src')
-rw-r--r--src/libinput.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/libinput.h b/src/libinput.h
index ab615601..1922ef4b 100644
--- a/src/libinput.h
+++ b/src/libinput.h
@@ -3078,6 +3078,11 @@ libinput_device_get_output_name(struct libinput_device *device);
* seat name pair at any given time, but if no external reference is kept, it
* may be destroyed if no device belonging to it is left.
*
+ * The returned seat is not refcounted and may become invalid after
+ * the next call to libinput. Use libinput_seat_ref() and
+ * libinput_seat_unref() to continue using the handle outside of the
+ * immediate scope.
+ *
* @param device A previously obtained device
* @return The seat this input device belongs to
*/