aboutsummaryrefslogtreecommitdiffstats
path: root/protocol
diff options
context:
space:
mode:
authorMarek Chalupa <mchqwerty@gmail.com>2015-03-30 06:10:22 -0400
committerPekka Paalanen <pekka.paalanen@collabora.co.uk>2015-03-30 14:23:18 +0300
commitc45be3d21e7231eec33c50f38d85fb4ac5fb74cc (patch)
tree7c6c339862b6ea3a04cf28bd5b7b91ac134b359f /protocol
parentAdd support for direct file reading and writing in wayland-scanner. (diff)
downloadwayland-c45be3d21e7231eec33c50f38d85fb4ac5fb74cc.tar
wayland-c45be3d21e7231eec33c50f38d85fb4ac5fb74cc.tar.gz
wayland-c45be3d21e7231eec33c50f38d85fb4ac5fb74cc.tar.bz2
wayland-c45be3d21e7231eec33c50f38d85fb4ac5fb74cc.tar.lz
wayland-c45be3d21e7231eec33c50f38d85fb4ac5fb74cc.tar.xz
wayland-c45be3d21e7231eec33c50f38d85fb4ac5fb74cc.tar.zst
wayland-c45be3d21e7231eec33c50f38d85fb4ac5fb74cc.zip
protocol: add better description of wl_pointer.release
Add note about what all wl_pointer.release does. Mainly that it destroys the proxy object, so programmer must not call wl_pointer_destroy() on the pointer any further. Signed-off-by: Marek Chalupa <mchqwerty@gmail.com> Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
Diffstat (limited to 'protocol')
-rw-r--r--protocol/wayland.xml8
1 files changed, 7 insertions, 1 deletions
diff --git a/protocol/wayland.xml b/protocol/wayland.xml
index 041e5f0..f52677f 100644
--- a/protocol/wayland.xml
+++ b/protocol/wayland.xml
@@ -1560,7 +1560,13 @@
<!-- Version 3 additions -->
<request name="release" type="destructor" since="3">
- <description summary="release the pointer object"/>
+ <description summary="release the pointer object">
+ Using this request client can tell the server that it is not going to
+ use the pointer object anymore.
+
+ This request destroys the pointer proxy object, so user must not call
+ wl_pointer_destroy() after using this request.
+ </description>
</request>
</interface>