Chromium aura shell

aura-shell

zaura_shell

version 19
Aura_shell

The global interface exposing aura shell capabilities is used to instantiate an interface extension for a wl_surface object. This extended interface will then allow the client to use aura shell specific functionality.

get_aura_surface(id: new_id<zaura_surface>, surface: object<wl_surface>)
Argument
Type
Description
idnew_id<zaura_surface>
the new aura surface interface id
surfaceobject<wl_surface>
the surface
Extend surface interface for aura shell

Instantiate an interface extension for the given wl_surface to provide aura shell functionality. If the given wl_surface is not associated with a shell surface, the shell_surface_missing protocol error is raised.

get_aura_output(id: new_id<zaura_output>, output: object<wl_output>)
Argument
Type
Description
idnew_id<zaura_output>
the new aura output interface id
outputobject<wl_output>
the output
Extend output interface for aura shell

Instantiate an interface extension for the given wl_output to provide aura shell functionality.

layout_mode(layout_mode: uint)
Argument
Type
Description
layout_modeuint
layout_mode enum
Sends the layout_mode

Sends the layout_mode used by the server.

bug_fix(id: uint)
Argument
Type
Description
iduint
ID of a single bug fix
Sends a bug fix ID

Sends a monorail ID of a bug fixed on the exo server that clients can use to gate functionality.

Argument
Value
Description
aura_surface_exists0
the surface already has an aura surface object associated
aura_output_exists1
the output already has an aura output object associated
layout_mode { windowed, tablet } 
Argument
Value
Description
windowed1
multiple windows
tablet2
restricted mode for tablet
The layout mode

Specifies the server's window layout mode.


zaura_surface

version 19
Aura shell interface to a wl_surface

An additional interface to a wl_surface object, which allows the client to access aura shell specific functionality for surface.

set_frame(type: uint)
Argument
Type
Description
typeuint
the new frame type
Request a frame for surface

Suggests a surface should use a specific frame.

set_parent(parent: object<zaura_surface>, x: int, y: int)
Argument
Type
Description
parentobject<zaura_surface>allow null
xint
yint
Set the parent of this surface

Set the "parent" of this surface. "x" and "y" arguments specify the initial position for surface relative to parent.

set_frame_colors(active_color: uint, inactive_color: uint)
Argument
Type
Description
active_coloruint
32 bit ARGB color value, not premultiplied
inactive_coloruint
32 bit ARGB color value, not premultiplied
Set the frame colors of this surface

Set the frame colors.

set_startup_id(startup_id: string)
Argument
Type
Description
startup_idstringallow null
Set the startup ID of this surface

Set the startup ID.

set_application_id(application_id: string)
Argument
Type
Description
application_idstringallow null
Set the application ID of this surface

Set the application ID.

set_client_surface_id(client_surface_id: int)
Argument
Type
Description
client_surface_idint
Set the client surface ID of this surface

Deprecated. Please use set_client_surface_str_id instead. Set the identifier of the surface assigned by the client.

set_occlusion_tracking()
Set tracked occlusion region

Sets occlusion tracking on this surface. The client will be updated with a new occlusion fraction when the amount of occlusion of this surface changes.

unset_occlusion_tracking()
Unset tracked occlusion region

Unsets occlusion tracking for this surface.

activate()
Indicate that this window wants to be the active window

Make this the active window. This usually implies something like restacking this surface to the foreground. The compositor is free to ignore this request if it deems the client to be misbehaving. Typically this request will only be honoured in response to some user driven event, such as executing an application or opening a file in a window that already exists.

draw_attention()
Indicate that this window wants some of the user's attention

Draw attention to this surface in a way that does not change the user's focus. This usually means animating window decorations or taskbar icons. The compositor can still ignore this request if it deems fit, but unlike draw_focus, these requests are expected to come from background tasks, and are more likely to be honoured.

set_fullscreen_mode(mode: uint<zaura_surface.fullscreen_mode>)
Argument
Type
Description
modeuint<zaura_surface.fullscreen_mode>
Sets the behavior of the surface in fullscreen.

Suggests how the windowing system should behave if this surface were to go fullscreen. Does not make the surface fullscreen. Typically the default mode is "immersive".

set_client_surface_str_id(client_surface_id: string)
Argument
Type
Description
client_surface_idstring
Set the client surface ID of this surface

Set the identifier of the surface assigned by the client.

set_server_start_resize()
Request a server-side shadow for surface

Suggests a surface to have client-side decoration, but server-side decides when and where to start the resize. The server may also apply visual effects to indicate that the resize operation is ongoing.

Argument
Type
Description
directionuint<zaura_surface.snap_direction>
Client intents to snap the surface.

Notify (or inform) the server the client's intent to snap the window. To inform it's no longer willing to snap, send 'none'.

set_snap_left()
Snap the surface to the left.

Request that surface is snapped to the left.

set_snap_right()
Snap the surface to the right.

Request that surface is snapped to the right.

unset_snap()
Unset the surface snap.

Request that surface resets snapping.

set_window_session_id(id: int)
Argument
Type
Description
idint
window session id
Set surface window session id

Set window session id to the surface.

set_can_go_back()
Set the minimize-on-back-gesture behavior.

Sets that the surface can go back as per its navigation list. This allows the server to react to by minimizing the window upon a system wide back gesture.

unset_can_go_back()
Unset the minimize-on-back-gesture behavior.

Unsets that the surface can go back as per its navigation list. See above.

occlusion_changed(occlusion_fraction: fixed, occlusion_reason: uint)
Argument
Type
Description
occlusion_fractionfixed
occlusion_reasonuint
Notifies on an occlusion change

Notifies when there is a change in the amount this surface is occluded. The occlusion update is sent as a fixed point number from 0 to 1, representing the proportion of occlusion.

lock_frame_normal()
Notify the client that server intent to lock window in normal or restore state

Notifies the client to lock window in normal or restore state. When window is locked, the window frame should look like it is in restored state, but actually isn't. Locking happends while dragging a maximized window.

unlock_frame_normal()
Notify the client that server intent to unlock window's normal or restore state

Notifies the client to unlock window if it is previously locked. Unlocking happends while dragging a maximized window.

frame_type { none, normal, shadow } 
Argument
Value
Description
none0
no frame
normal1
caption with shadow
shadow2
shadow only
Different frame types

Frame types that can be used to decorate a surface.

occlusion_change_reason { user_action } 
Argument
Value
Description
user_action1
occlusion changed as a result of a user action
Occlusion change reason

Enum describing why an occlusion change happened. An occlusion change as a result of a user action could include things like the user moving a window, changing occlusion, or opening/closing a window, changing the occlusion.

fullscreen_mode { immersive, plain } 
Argument
Value
Description
immersive0
user can access system UIs such as the shelf and window frame by pointing to, or swiping over, the screen edge
plain1
user cannot access system UIs using mouse/touches
Specifies the behavior of the surface in fullscreen.

Possible windowing system behaviors if this surface were to go fullscreen.

snap_direction { none, left, right } 
Argument
Value
Description
none0
left1
right2
Surface snap directions

Surface snap directions.


zaura_output

version 6
Aura shell interface to a wl_output

An additional interface to a wl_output object, which allows the client to access aura shell specific functionality for output.

Argument
Type
Description
flagsuint<zaura_output.scale_property>
bitfield of scale flags
scaleuint<zaura_output.scale_factor>
output scale
Advertise available scales for the output

The scale event describes an available scale for the output. The event is sent when binding to the output object and there will always be one scale, the current scale. The event is sent again if an output changes scale, for the scale that is now current. In other words, the current scale is always the last scale that was received with the current flag set.

Argument
Type
Description
connectionuint<zaura_output.connection_type>
output connection
Advertise connection for the output

The connection event describes how the output is connected. The event is sent when binding to the output object.

device_scale_factor(scale: uint<zaura_output.scale_factor>)
Argument
Type
Description
scaleuint<zaura_output.scale_factor>
output device scale factor
Advertise device scale factor for the output

This event describes the device specific scale factor for the output. The device specific scale factor is not expected the change during the lifetime of the output. And it is not limited to an integer value like the scale factor provided by wl_output interface. The exact contents scale used by the compositor can be determined by combining this device scale factor with the current output scale. The event is sent when binding to the output object.

scale_property { current, preferred } 
Argument
Value
Description
current0x1
indicates this is the current scale
preferred0x2
indicates this is the preferred scale
Scale information

These flags describe properties of an output scale. They are used in the flags bitfield of the scale event.

Argument
Value
Description
0400400
0500500
0550550
0600600
0625625
0650650
0700700
0750750
0800800
0850850
0900900
0950950
10001000
10501050
11001100
11501150
11251125
12001200
12501250
13001300
14001400
14501450
15001500
16001600
17501750
18001800
20002000
22002200
22502250
25002500
27502750
30003000
35003500
40004000
45004500
50005000
connection_type { unknown, internal } 
Argument
Value
Description
unknown0
internal1

Copyright 2017 The Chromium Authors.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.