~sircmpwn/public-inbox

This thread contains a patchset. You're looking at the original emails, but you may wish to use the patch review UI. Review patch
2 2

[PATCH wayland-book] Fix subsurface Z-order documentation

Joshua Watt
Details
Message ID
<20210429141329.8135-1-JPEWhacker@gmail.com>
DKIM signature
pass
Download raw message
Patch: +7 -6
A subsurface is not restricted to being placed above the parent surface;
it may be placed above or below any sibling surface or the parent
surface itself.
---
 src/surfaces-in-depth/subsurfaces.md | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/src/surfaces-in-depth/subsurfaces.md b/src/surfaces-in-depth/subsurfaces.md
index fda148c..bebc173 100644
--- a/src/surfaces-in-depth/subsurfaces.md
+++ b/src/surfaces-in-depth/subsurfaces.md
@@ -1,10 +1,9 @@
# Subsurfaces

There's only one[^1] surface role defined in the core Wayland protocol,
`wayland.xml`: subsurfaces. Subsurfaces are surfaces shown on top of their
parent surface. They have a position relative to the parent surface - which
needn't be constrained by the bounds of their parent surface - and a z-order
relative to each other.
`wayland.xml`: subsurfaces. They have an X, Y position relative to the parent
surface - which needn't be constrained by the bounds of their parent surface -
and a Z-order relative to their siblings and parent surface.

Some use-cases for this feature include playing a video surface in its native
pixel format with an RGBA user-interface or subtitles shown on top, using an
@@ -50,8 +49,10 @@ Manipulating these children is done through the `wl_subsurface` interface:
<request name="set_desync" />
```

The position and z-order requests here are fairly self-explanatory. However,
the synchronization of the various properties of a `wl_subsurface` requires some
A subsurface's z-order may be changed by placing it above or below any sibling
surface that shares the same parent, or the parent surface itself.

The synchronization of the various properties of a `wl_subsurface` requires some
explanation. These position and z-order properties are synchronized with the
parent surface's lifecycle. When a `wl_surface.commit` request is sent for the
main surface, all of its subsurfaces have changes to their position and z-order
-- 
2.31.1
Details
Message ID
<jrQlwXxwubQlYVb9BcBwiqSe2jhLxriaZmThJ6yqrfmr2EB7AZmEamtUP5o419dEfWP1wBp0gh8bfiXOr2yMPu634_DIS0pBetdI-_oE8ws=@emersion.fr>
In-Reply-To
<20210429141329.8135-1-JPEWhacker@gmail.com> (view parent)
DKIM signature
pass
Download raw message
Looks good to me!
Details
Message ID
<CB09YH6PFGFG.2SQSS9TNUWU5S@taiga>
In-Reply-To
<20210429141329.8135-1-JPEWhacker@gmail.com> (view parent)
DKIM signature
pass
Download raw message
Thanks!

To git@git.sr.ht:~sircmpwn/wayland-book
   68a821c..  master -> master
Reply to thread Export thread (mbox)