xdg-shell: Clarify set_fullscreen semantics

It was not explicitly specified (as it is in set/unset_maximize) that
the compositor will respond with a configure event when a client asks to
be fullscreened, and the meaning of the output parameter was somewhat
awkwardly described.

Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
Reviewed-by: Mike Blumenkrantz <zmike@samsung.com>
This commit is contained in:
Jonas Ådahl 2017-10-30 17:24:23 +08:00
parent 3c7dbb9646
commit a82ca1f35b

View file

@ -886,9 +886,16 @@
<description summary="set the window as fullscreen on an output">
Make the surface fullscreen.
You can specify an output that you would prefer to be fullscreen.
If this value is NULL, it's up to the compositor to choose which
display will be used to map this surface.
After requesting that the surface should be fullscreened, the
compositor will respond by emitting a configure event with the
"fullscreen" state and the required window geometry. The client must
also acknowledge the configure when committing the new content (see
ack_configure).
The output passed by the request indicates the client's preference as
to which display it should be set fullscreen on. If this value is NULL,
it's up to the compositor to choose which display will be used to map
this surface.
If the surface doesn't cover the whole output, the compositor will
position the surface in the center of the output and compensate with