X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=protocol%2Fagl-shell.xml;h=bf5ab025f8856b18d49a2f258486f364e15fc3f9;hb=77d94d831dfcdb4e173cd5253d94ec724d576e77;hp=1096c6461190a26b0927bdfcc5b4ea0d94e0a0dc;hpb=2d7243208d3e455decd730e7e33ab2452b1a0508;p=src%2Fagl-compositor.git diff --git a/protocol/agl-shell.xml b/protocol/agl-shell.xml index 1096c64..bf5ab02 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,8 +22,29 @@ 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 +60,19 @@ + + + + + + + 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 +104,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. @@ -113,5 +141,64 @@ + + + + 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. + + + + + + + + + + + Informs the client that an application has changed its state to another, + specified by the app_state enum. Client can use this event to track + current application state. For instance to know when the application has + started, or when terminated/stopped. + + + + + + + + A hint for the compositor to use a custom area, rather than + inferring the activation area. If any panels are used + the compositor computes the activation area by subtracting the + panels geometry area. If no panels are used then the entire output + is being used. This request changes that as to hint the compositor + to use the supplied rectangle and ignore any potential panels + that might been set-up previously. + + In order for this request to take effect it will need to happen + before the 'ready' request in order for the compositor to make use of it. + Note that any 'set_panel' request be will not be honored, if this request + has been called. + + The x and y coordinates use the top-left corner as the origin. The + rectangle area shouldn't exceed the output area, while an area smaller + than the output, would basically result in showing up the background + surface. + + + + + + +