diff options
| author | Michel Dänzer <mdaenzer@redhat.com> | 2025-01-21 15:27:22 +0100 |
|---|---|---|
| committer | Simon Ser <contact@emersion.fr> | 2025-03-15 23:12:07 +0000 |
| commit | 6137c8c21383d7ebb92cf3331be56ca0aecccd5d (patch) | |
| tree | c9f7c7236c5a308ac2057a676686795881d17b95 | |
| parent | client: document get_listener behavior for dispatchers (diff) | |
| download | wayland-6137c8c21383d7ebb92cf3331be56ca0aecccd5d.tar wayland-6137c8c21383d7ebb92cf3331be56ca0aecccd5d.tar.gz wayland-6137c8c21383d7ebb92cf3331be56ca0aecccd5d.tar.bz2 wayland-6137c8c21383d7ebb92cf3331be56ca0aecccd5d.tar.lz wayland-6137c8c21383d7ebb92cf3331be56ca0aecccd5d.tar.xz wayland-6137c8c21383d7ebb92cf3331be56ca0aecccd5d.tar.zst wayland-6137c8c21383d7ebb92cf3331be56ca0aecccd5d.zip | |
protocol: Clarify wl_buffer.release description
Sebastian pointed out that the existing text could be read as
wl_buffer.destroy not being allowed before the wl_buffer.release event
arrives, contrary to what the wl_surface.attach description says.
Clarify to be consistent with the latter.
This is a follow-up for
https://gitlab.freedesktop.org/wayland/wayland/-/merge_requests/141 .
Signed-off-by: Michel Dänzer <mdaenzer@redhat.com>
v2:
* Simplify clarification, don't talk about callbacks. (Julian Orth)
* Add reference to details in the description of wl_surface.attach.
(Daniel Stone)
v3:
* Tweak clarification again. (Sebastian Wick)
v4:
* Make clarification even less ambiguous. (Simon Ser, Julian Orth)
v5:
* Just refer to the description of wl_surface.attach instead of trying
to clarify anything here. (Sebastian Wick)
| -rw-r--r-- | protocol/wayland.xml | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/protocol/wayland.xml b/protocol/wayland.xml index f32918e..1af51d3 100644 --- a/protocol/wayland.xml +++ b/protocol/wayland.xml @@ -501,8 +501,10 @@ <event name="release"> <description summary="compositor releases buffer"> Sent when this wl_buffer is no longer used by the compositor. - The client is now free to reuse or destroy this buffer and its - backing storage. + + For more information on when release events may or may not be sent, + and what consequences it has, please see the description of + wl_surface.attach. If a client receives a release event before the frame callback requested in the same wl_surface.commit that attaches this |