[PATCH weston 07/17] xdg-shell: Document that xdg_surface.set_window_geometry needs a commit

[Pekka Paalanen]

On Tue,  7 Apr 2015 17:01:22 +0800
Jonas Ådahl <jadahl at gmail.com> wrote:

> Signed-off-by: Jonas Ådahl <jadahl at gmail.com>
> ---
>  protocol/xdg-shell.xml | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/protocol/xdg-shell.xml b/protocol/xdg-shell.xml
> index d316e06..d013803 100644
> --- a/protocol/xdg-shell.xml
> +++ b/protocol/xdg-shell.xml
> @@ -370,6 +370,9 @@
>          portions like drop-shadows which should be ignored for the
>          purposes of aligning, placing and constraining windows.
>  
> +        The window geometry is double buffered, and will be applied the
> +        time wl_surface.commit of the corresponding wl_surface is called.
> +
>          Once the window geometry of the surface is set once, it is not
>          possible to unset it, and it will remain the same until
>          set_window_geometry is called again, even if a new subsurface or

Yeah, I think this is ok. I was thinking about sub-surfaces, where
applying state is not always directly linked to wl_surface.commit on
that surface, but an xdg surface cannot be a sub-surface.

However, this will bring yet more complication for the future buffer
queueing extension: is geometry queued? does latching a buffer from the
queue apply pending geometry?

But I suppose we have fight that bridge when we get to it.

Reviewed-by: Pekka Paalanen <pekka.paalanen at collabora.co.uk>

This isn't an actual protocol break on the wire either... I think it
would be safe to say that this doesn't require a version bump. Clients
not aware of this might glitch a little, but that's all, right?


Thanks,
pq