protocol/agl-shell.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <protocol name="agl_shell">
   3   <copyright>
   4     Copyright © 2019, 2022 Collabora, Ltd.
   5
   6     Permission is hereby granted, free of charge, to any person obtaining a
   7     copy of this software and associated documentation files (the "Software"),
   8     to deal in the Software without restriction, including without limitation
   9     the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10     and/or sell copies of the Software, and to permit persons to whom the
  11     Software is furnished to do so, subject to the following conditions:
  12
  13     The above copyright notice and this permission notice (including the next
  14     paragraph) shall be included in all copies or substantial portions of the
  15     Software.
  16
  17     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18     IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19     FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20     THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21     LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  22     FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  23     DEALINGS IN THE SOFTWARE.
  24   </copyright>
  25   <interface name="agl_shell" version="2">
  26     <description summary="user interface for Automotive Grade Linux platform">
  27       Starting with version 2 of the protocol, the client is required to wait
  28       for the 'bound_ok' or 'bound_fail' events in order to proceed further.
  29
  30       In case the client gets a 'bound_fail' event then it should consider that
  31       there's another client already bound to the agl_shell protocol.
  32       A client that receives a 'bound_ok' event should consider that there's
  33       no other client already bound to the interface and can proceed further.
  34
  35       If the client uses an older version of the protocol it will receive
  36       automatically an error and the compositor will terminate the connection,
  37       if there's another client already bound the interface.
  38
  39       If the client receives the 'bound_fail' event and attempts to use the
  40       interface further it will receive an error and the compositor will
  41       terminate the connection. After the 'bound_fail' event was received the
  42       client should call the destructor, which has been added with version 2
  43       of the protocol. The client is free to try at a later point in time to
  44       see if it will receive the 'bound_ok' event, but there's no explicit way
  45       of finding out when that event will be delivered.
  46       It is assumed that it can infer that information through other
  47       means/other channels.
  48     </description>
  49
  50     <request name="destroy" type="destructor" since="2">
  51       <description summary="destroys the factory object">
  52       </description>
  53     </request>
  54
  55     <enum name="error">
  56       <entry name="invalid_argument" value="0"/>
  57       <entry name="background_exists" value="1"/>
  58       <entry name="panel_exists" value="2"/>
  59     </enum>
  60
  61     <enum name="edge">
  62       <entry name="top" value="0"/>
  63       <entry name="bottom" value="1"/>
  64       <entry name="left" value="2"/>
  65       <entry name="right" value="3"/>
  66     </enum>
  67
  68     <request name="ready">
  69       <description summary="client is ready to be shown">
  70         Tell the server that this client is ready to be shown. The server
  71         will delay presentation during start-up until all shell clients are
  72         ready to be shown, and will display a black screen instead.
  73         This gives the client an opportunity to set up and configure several
  74         surfaces into a coherent interface.
  75
  76         The client that binds to this interface must send this request, otherwise
  77         they may stall the compositor unnecessarily.
  78
  79         If this request is called after the compositor has already finished
  80         start-up, no operation is performed.
  81       </description>
  82     </request>
  83
  84     <request name="set_background">
  85       <description summary="set surface as output's background">
  86         Set the surface to act as the background of an output. After this
  87         request, the server will immediately send a configure event with
  88         the dimensions the client should use to cover the entire output.
  89
  90         The surface must have a "desktop" surface role, as supported by
  91         libweston-desktop.
  92
  93         Only a single surface may be the background for any output. If a
  94         background surface already exists, a protocol error is raised.
  95       </description>
  96       <arg name="surface" type="object" interface="wl_surface"/>
  97       <arg name="output" type="object" interface="wl_output"/>
  98     </request>
  99
 100     <request name="set_panel">
 101       <description summary="set surface as panel">
 102         Set the surface to act as a panel of an output. The 'edge' argument
 103         says what edge of the output the surface will be anchored to.
 104         After this request, the server will send a configure event with the
 105         corresponding width/height that the client should use, and 0 for the
 106         other dimension. E.g. if the edge is 'top', the width will be the
 107         output's width, and the height will be 0.
 108
 109         The surface must have a "desktop" surface role, as supported by
 110         libweston-desktop.
 111
 112         The compositor will take the panel's window geometry into account when
 113         positioning other windows, so the panels are not covered.
 114
 115         XXX: What happens if e.g. both top and left are used at the same time?
 116         Who gets to have the corner?
 117
 118         Only a single surface may be the panel for an output's edge. If a
 119         surface already exists on an edge, a protocol error is raised.
 120       </description>
 121       <arg name="surface" type="object" interface="wl_surface"/>
 122       <arg name="output" type="object" interface="wl_output"/>
 123       <arg name="edge" type="uint" enum="edge"/>
 124     </request>
 125
 126     <request name="activate_app">
 127       <description summary="make client current window">
 128         Ask the compositor to make a toplevel to become the current/focused
 129         window for window management purposes.
 130
 131         See xdg_toplevel.set_app_id from the xdg-shell protocol for a
 132         description of app_id.
 133
 134         If multiple toplevels have the same app_id, the result is unspecified.
 135
 136         XXX: Do we need feedback to say it didn't work? (e.g. client does
 137         not exist)
 138       </description>
 139       <arg name="app_id" type="string"/>
 140       <arg name="output" type="object" interface="wl_output"/>
 141     </request>
 142
 143     <event name="bound_ok" since="2">
 144      <description summary="event sent if binding was ok">
 145         Informs the client that it was able to bind the agl_shell
 146         interface succesfully. Clients are required to wait for this
 147         event before continuing further.
 148      </description>
 149     </event>
 150
 151     <event name="bound_fail" since="2">
 152       <description summary="event sent if binding was nok">
 153         Informs the client that binding to the agl_shell interface was
 154         unsuccesfull. Clients are required to wait for this event for
 155         continuing further.
 156       </description>
 157     </event>
 158
 159   </interface>
 160 </protocol>