xdg-toplevel-icon: clarify that wl_buffer.release is unused

The protocol as-is doesn't allow clients to mutate wl_buffers.
Let's make it clear that wl_buffer.release is not used for that
purpose. Buffer re-use can be added in a future protocol version
if desirable.

Add a small note to explain that no wl_buffer mutation implies no
wl_shm_pool's backing storage mutation as well.

Signed-off-by: Simon Ser <contact@emersion.fr>
Closes: https://gitlab.freedesktop.org/wayland/wayland-protocols/-/issues/201
This commit is contained in:
Simon Ser 2024-08-18 18:25:28 +02:00
parent b4a42c88f4
commit 6f5772fd69

View file

@ -190,7 +190,9 @@
The wl_buffer must be kept alive for as long as the xdg_toplevel_icon
it is associated with is not destroyed, otherwise a 'no_buffer' error
is raised. The buffer contents must not be modified after it was
assigned to the icon.
assigned to the icon. As a result, the region of the wl_shm_pool's
backing storage used for the wl_buffer must not be modified after this
request is sent. The wl_buffer.release event is unused.
If this request is made after the icon has been assigned to a toplevel
via 'set_icon', a 'immutable' error must be raised.