1<?xml version="1.0" encoding="UTF-8"?> 2<protocol name="aura_shell"> 3 <copyright> 4 Copyright 2017 The Chromium Authors. 5 Permission is hereby granted, free of charge, to any person obtaining a 6 copy of this software and associated documentation files (the "Software"), 7 to deal in the Software without restriction, including without limitation 8 the rights to use, copy, modify, merge, publish, distribute, sublicense, 9 and/or sell copies of the Software, and to permit persons to whom the 10 Software is furnished to do so, subject to the following conditions: 11 The above copyright notice and this permission notice (including the next 12 paragraph) shall be included in all copies or substantial portions of the 13 Software. 14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 17 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 19 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 20 DEALINGS IN THE SOFTWARE. 21 </copyright> 22 <interface name="zaura_shell" version="6"> 23 <description summary="aura_shell"> 24 The global interface exposing aura shell capabilities is used to 25 instantiate an interface extension for a wl_surface object. 26 This extended interface will then allow the client to use aura shell 27 specific functionality. 28 </description> 29 <enum name="error"> 30 <entry name="aura_surface_exists" value="0" 31 summary="the surface already has an aura surface object associated"/> 32 <entry name="aura_output_exists" value="1" 33 summary="the output already has an aura output object associated"/> 34 </enum> 35 <request name="get_aura_surface"> 36 <description summary="extend surface interface for aura shell"> 37 Instantiate an interface extension for the given wl_surface to 38 provide aura shell functionality. If the given wl_surface is not 39 associated with a shell surface, the shell_surface_missing protocol 40 error is raised. 41 </description> 42 <arg name="id" type="new_id" interface="zaura_surface" 43 summary="the new aura surface interface id"/> 44 <arg name="surface" type="object" interface="wl_surface" 45 summary="the surface"/> 46 </request> 47 <!-- Version 2 additions --> 48 <request name="get_aura_output" since="2"> 49 <description summary="extend output interface for aura shell"> 50 Instantiate an interface extension for the given wl_output to 51 provide aura shell functionality. 52 </description> 53 <arg name="id" type="new_id" interface="zaura_output" 54 summary="the new aura output interface id"/> 55 <arg name="output" type="object" interface="wl_output" 56 summary="the output"/> 57 </request> 58 </interface> 59 <interface name="zaura_surface" version="5"> 60 <description summary="aura shell interface to a wl_surface"> 61 An additional interface to a wl_surface object, which allows the 62 client to access aura shell specific functionality for surface. 63 </description> 64 <enum name="frame_type"> 65 <description summary="different frame types"> 66 Frame types that can be used to decorate a surface. 67 </description> 68 <entry name="none" value="0" summary="no frame"/> 69 <entry name="normal" value="1" summary="caption with shadow" /> 70 <entry name="shadow" value="2" summary="shadow only"/> 71 </enum> 72 <request name="set_frame"> 73 <description summary="request a frame for surface"> 74 Suggests a surface should use a specific frame. 75 </description> 76 <arg name="type" type="uint" summary="the new frame type"/> 77 </request> 78 <!-- Version 2 additions --> 79 <request name="set_parent" since="2"> 80 <description summary="set the parent of this surface"> 81 Set the "parent" of this surface. "x" and "y" arguments specify the 82 initial position for surface relative to parent. 83 </description> 84 <arg name="parent" type="object" interface="zaura_surface" allow-null="true"/> 85 <arg name="x" type="int"/> 86 <arg name="y" type="int"/> 87 </request> 88 <!-- Version 3 additions --> 89 <request name="set_frame_colors" since="3"> 90 <description summary="set the frame colors of this surface"> 91 Set the frame colors. 92 </description> 93 <arg name="active_color" type="uint" summary="32 bit ARGB color value, not premultiplied"/> 94 <arg name="inactive_color" type="uint" summary="32 bit ARGB color value, not premultiplied"/> 95 </request> 96 <!-- Version 4 additions --> 97 <request name="set_startup_id" since="4"> 98 <description summary="set the startup ID of this surface"> 99 Set the startup ID. 100 </description> 101 <arg name="startup_id" type="string" allow-null="true"/> 102 </request> 103 <!-- Version 5 additions --> 104 <request name="set_application_id" since="5"> 105 <description summary="set the application ID of this surface"> 106 Set the application ID. 107 </description> 108 <arg name="application_id" type="string" allow-null="true"/> 109 </request> 110 </interface> 111 <interface name="zaura_output" version="6"> 112 <description summary="aura shell interface to a wl_output"> 113 An additional interface to a wl_output object, which allows the 114 client to access aura shell specific functionality for output. 115 </description> 116 <!-- Version 2 additions --> 117 <enum name="scale_property" bitfield="true"> 118 <description summary="scale information"> 119 These flags describe properties of an output scale. 120 They are used in the flags bitfield of the scale event. 121 </description> 122 <entry name="current" value="0x1" 123 summary="indicates this is the current scale"/> 124 <entry name="preferred" value="0x2" 125 summary="indicates this is the preferred scale"/> 126 </enum> 127 <enum name="scale_factor"> 128 <entry name="0400" value="400"/> 129 <entry name="0500" value="500"/> 130 <entry name="0550" value="550"/> 131 <entry name="0600" value="600"/> 132 <entry name="0625" value="625"/> 133 <entry name="0650" value="650"/> 134 <entry name="0700" value="700"/> 135 <entry name="0750" value="750"/> 136 <entry name="0800" value="800"/> 137 <entry name="0850" value="850"/> 138 <entry name="0900" value="900"/> 139 <entry name="0950" value="950"/> 140 <entry name="1000" value="1000"/> 141 <entry name="1050" value="1050"/> 142 <entry name="1100" value="1100"/> 143 <entry name="1150" value="1150"/> 144 <entry name="1125" value="1125"/> 145 <entry name="1200" value="1200"/> 146 <entry name="1250" value="1250"/> 147 <entry name="1300" value="1300"/> 148 <entry name="1400" value="1400"/> 149 <entry name="1450" value="1450"/> 150 <entry name="1500" value="1500"/> 151 <entry name="1600" value="1600"/> 152 <entry name="1750" value="1750"/> 153 <entry name="1800" value="1800"/> 154 <entry name="2000" value="2000"/> 155 <entry name="2200" value="2200"/> 156 <entry name="2250" value="2250"/> 157 <entry name="2500" value="2500"/> 158 <entry name="2750" value="2750"/> 159 <entry name="3000" value="3000"/> 160 <entry name="3500" value="3500"/> 161 <entry name="4000" value="4000"/> 162 <entry name="4500" value="4500"/> 163 <entry name="5000" value="5000"/> 164 </enum> 165 <event name="scale" since="2"> 166 <description summary="advertise available scales for the output"> 167 The scale event describes an available scale for the output. 168 The event is sent when binding to the output object and there 169 will always be one scale, the current scale. The event is sent 170 again if an output changes scale, for the scale that is now 171 current. In other words, the current scale is always the last 172 scale that was received with the current flag set. 173 </description> 174 <arg name="flags" type="uint" enum="scale_property" summary="bitfield of scale flags"/> 175 <arg name="scale" type="uint" enum="scale_factor" summary="output scale"/> 176 </event> 177 <!-- Version 5 additions --> 178 <enum name="connection_type"> 179 <entry name="unknown" value="0"/> 180 <entry name="internal" value="1"/> 181 </enum> 182 <event name="connection" since="5"> 183 <description summary="advertise connection for the output"> 184 The connection event describes how the output is connected. 185 The event is sent when binding to the output object. 186 </description> 187 <arg name="connection" type="uint" enum="connection_type" summary="output connection"/> 188 </event> 189 <event name="device_scale_factor" since="5"> 190 <description summary="advertise device scale factor for the output"> 191 This event describes the device specific scale factor for the output. 192 The device specific scale factor is not expected the change during 193 the lifetime of the output. And it is not limited to an integer value 194 like the scale factor provided by wl_output interface. The exact 195 contents scale used by the compositor can be determined by combining 196 this device scale factor with the current output scale. 197 The event is sent when binding to the output object. 198 </description> 199 <arg name="scale" type="uint" enum="scale_factor" summary="output device scale factor"/> 200 </event> 201 </interface> 202</protocol> 203