X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=protocol%2Fagl-shell.xml;h=8f83d7a833bf7e80c6d3b394690b356fd48619c1;hb=3d0f70b1f75aed78b1a42cdfd610bcf115e58a50;hp=59548e7be6fc20552668e37ee5987673f240da43;hpb=aa4ba5d283d641da25722af7a966c31d61a9686b;p=src%2Fagl-compositor.git diff --git a/protocol/agl-shell.xml b/protocol/agl-shell.xml index 59548e7..8f83d7a 100644 --- a/protocol/agl-shell.xml +++ b/protocol/agl-shell.xml @@ -1,7 +1,7 @@ - Copyright © 2019 Collabora, Ltd. + Copyright © 2019, 2022 Collabora, Ltd. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), @@ -22,14 +22,41 @@ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - - + + + Starting with version 2 of the protocol, the client is required to wait + for the 'bound_ok' or 'bound_fail' events in order to proceed further. + + In case the client gets a 'bound_fail' event then it should consider that + there's another client already bound to the agl_shell protocol. + A client that receives a 'bound_ok' event should consider that there's + no other client already bound to the interface and can proceed further. + + If the client uses an older version of the protocol it will receive + automatically an error and the compositor will terminate the connection, + if there's another client already bound the interface. + + If the client receives the 'bound_fail' event and attempts to use the + interface further it will receive an error and the compositor will + terminate the connection. After the 'bound_fail' event was received the + client should call the destructor, which has been added with version 2 + of the protocol. The client is free to try at a later point in time to + see if it will receive the 'bound_ok' event, but there's no explicit way + of finding out when that event will be delivered. + It is assumed that it can infer that information through other + means/other channels. + + + + + + @@ -39,12 +66,21 @@ + + + + + + + + + Tell the server that this client is ready to be shown. The server will delay presentation during start-up until all shell clients are ready to be shown, and will display a black screen instead. - This gives the client an oppurtunity to set up and configure several + This gives the client an opportunity to set up and configure several surfaces into a coherent interface. The client that binds to this interface must send this request, otherwise @@ -76,7 +112,7 @@ Set the surface to act as a panel of an output. The 'edge' argument says what edge of the output the surface will be anchored to. After this request, the server will send a configure event with the - correponding width/height that the client should use, and 0 for the + corresponding width/height that the client should use, and 0 for the other dimension. E.g. if the edge is 'top', the width will be the output's width, and the height will be 0. @@ -96,5 +132,95 @@ + + + + Ask the compositor to make a toplevel to become the current/focused + window for window management purposes. + + See xdg_toplevel.set_app_id from the xdg-shell protocol for a + description of app_id. + + If multiple toplevels have the same app_id, the result is unspecified. + + XXX: Do we need feedback to say it didn't work? (e.g. client does + not exist) + + + + + + + + Informs the client that it was able to bind the agl_shell + interface succesfully. Clients are required to wait for this + event before continuing further. + + + + + + Informs the client that binding to the agl_shell interface was + unsuccesfull. Clients are required to wait for this event for + continuing further. + + + + + + Request changes the application from the original mode (whatever that + might be) to a split, tiled orientation mode defined in the orientation + enum. Clients need to implement resizing (meaing handle xdg-shell + configure events) for this to work correctly. + + This request only handles a single level of tiling for practical + reasons: to keep implementation simple and straight forward. The + compositor will ignore requests if there are already two windows + present, and will terminate the client's connection with a protocol + violation, if it detects more than one tiling level. + + If there's no app_id with the supplied name it will be added to a + pending list in order to be applied when an application id gets started. + Applications can use this approch if they want to be started in a + tiled orientantion position, before creating the xdg-shell toplevel role. + + A none orientation type would make the window go back to the original + maximized mode. If two windows are side by side, returning one of them + back the original mode would mean the other one will be made hidden + and the one doing the request for the none orientation will become + the currently active window. A further activation, using activate_app + request for the other window would make that one active. + + Closing the window in the tiled orientation state implies that either + the background surface will displayed, or in case there was another + applications being shown at that time, will make that application be + returned to the original, maximized state. + + The tiled orientation could be applied independently of each other, + such that a client can transition from one tiled orientation to + another. Note that any other window already present would literally + take the opposite orientation with the one currently being changed. So + tiled orientation modification automatically implies a tile orientation + for any other application already present/active at that time. + + In case there's already a client active at that time, it will be + attributed automatically the opposite tiled orientation, such that two + concurrent applications can be displayed at the same time. + + The orientation tiles can not be combined, and only state at a time + can be active. Only horizontal and vertical tiling is possible. + + Input focus is being delivered to the last started/activated window, such + that users can cycle between that one or the other, assumes there's + another window in the first place. + + See xdg_toplevel.set_app_id from the xdg-shell protocol for a + description of app_id. + + + + + +