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