Chromium aura shell

aura-shell

zaura_shell

version 53
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.

surface_submission_in_pixel_coordinates()
Surfaces will be submitted in pixel coordinates

[Deprecated] Informs the server that when submitting surfaces, this client will not use wl_surface_set_buffer_scale to report the scales, nor will it apply scale via vp_viewporter. Instead the server should apply an appropriate scale transform to have the submitted buffers composited correctly.

get_aura_toplevel_for_xdg_toplevel(id: new_id<zaura_toplevel>, toplevel: object<xdg_toplevel>)
Argument
Type
Description
idnew_id<zaura_toplevel>
the new aura toplevel interface id
toplevelobject<xdg_toplevel>
Get aura toplevel

Retrieve the aura toplevel interface for a given xdg toplevel interface

get_aura_popup_for_xdg_popup(id: new_id<zaura_popup>, popup: object<xdg_popup>)
Argument
Type
Description
idnew_id<zaura_popup>
the aura popup interface id
popupobject<xdg_popup>
Get aura popup

Retrieve the aura popup interface for the given xdg popup interface

release
Type: destructorsince 38
release()
Release zaura_shell object

Using this request a client can tell the server that it is not going to use the zaura_shell object anymore. This does not affect any other objects.

This is named "release" because "destroy" is a special named function used for freeing wl_proxy objects. Naming it "destroy" will cause marshalling errors when running on lower versioned hosts. All "release" requests here should be renamed to "destroy" if we move to aura-shell v2.

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.

desks_changed(desk_names: array)
Argument
Type
Description
desk_namesarray
an array of existing desks' names
Sends names of desks

Notifies when there is a change in global desks state. This is emitted on desk name changes, desk addition/removal or desks are reordered. "desk_names" argument contains the set of null terminated strings as names of desks.

desk_activation_changed(active_desk_index: int)
Argument
Type
Description
active_desk_indexint
index of the active desk
Sends the index of the active desk

Notifies when there is a change of the active desk.

activated(gained_active: object<wl_surface>, lost_active: object<wl_surface>)
Argument
Type
Description
gained_activeobject<wl_surface>allow null
lost_activeobject<wl_surface>allow null
Activated surface changed

Notifies client that the activated surface changed.

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 51
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

[Deprecated] Suggests a surface should use a specific frame. Deprecated since M105. See the set_decoration method on zaura_toplevel and zaura_popup.

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

[Deprecated] 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.

[Deprecated] Use the set_fullscreen_mode in the toplevel interface. 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.

[Deprecated] Use intent_to_snap on zaura_toplevel. 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.

[Deprecated] Use set_snap_primary on zaura_toplevel. Request that surface is snapped to the left.

set_snap_right()
Snap the surface to the right.

[Deprecated] Use set_snap_secondary on zaura_toplevel. Request that surface is snapped to the right.

unset_snap()
Unset the surface snap.

[Deprecated] Use unset_snap on zaura_toplevel. 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.

set_pip()
Set pip for the surface.

Requests that the surface is set to Picture-in-Picture (PIP).

unset_pip()
Unset pip for the surface.

Requests that the surface is unset from Picture-in-Picture (PIP).

set_aspect_ratio(width: int, height: int)
Argument
Type
Description
widthint
heightint
Set aspect ratio for the surface.

Sets the aspect ratio of the surface.

move_to_desk(index: int)
Argument
Type
Description
indexint
Move to desk

If |index| equals -1, requests that the server toggles whether client is visible on all workspaces. If |index| is not -1, requests that the server moves the client to the desk at |index|.

set_initial_workspace(initial_workspace: string)
Argument
Type
Description
initial_workspacestring
intial workspace for restoring or '-1' for visible on all workspaces
Initial workspace for restore

If |initial_workspace| equals '-1', a window is restored and visible on all workspaces, Otherwise, set the initial workspace to restore the window to the corresponding workspace. This is not double buffered and must be set before attaching a buffer.

set_pin(trusted: int)
Argument
Type
Description
trustedint
0 for non trusted
Pin a window (trusted or not)

Requests that a window is pinned which means that the system does not allow the user to leave the window until an exit criteria is met.

This is a request to get the window pinned so that the user cannot get to any other window / application. There are two modes: A. trusted is 0 - which is slightly less restrictive and allows the user to get out of the window by a predefined way of authentication. B. trusted is not 0 in which case a trusted application was locking down the system and needs to unlock. This is used for e.g. School tests.

unset_pin()
Unpin a window

Requests that the user can leave a previously pinned window.

This is a request to unpin a previously pinned window. It does not matter if the window was locked with the trusted state or not.

release
Type: destructorsince 38
release()
Destroy zaura_surface

Destroy the zaura_surface object. A client should destroy this object when the role is unmapped from a wl_surface.

See zaura_shell.release for destructor naming.

show_tooltip(text: string, x: int, y: int, tooltip_trigger: uint, show_delay: uint, hide_delay: uint)
Argument
Type
Description
textstring
xint
yint
tooltip_triggeruint
tooltip_trigger enum
show_delayuint
delay to show tooltip in millisecond
hide_delayuint
delay to hide tooltip in millisecond
Show tooltip window

Show tooltip on server side. `x` and `y` specifies the location of tooltip in surface local coordinates. `hide_delay` and `show_delay` specify the time to wait until showing/hiding tooltip. The unit is millisecond.

hide_tooltip()
Hide tooltip window

Hide tooltip created by the same client on server side. This may be called even when there is no tooltip window to hide.

set_accessibility_id(id: int)
Argument
Type
Description
idint
Accessibility ID. Negative number removes existing accessibility ID from the surface.
Set accessibility ID to the surface

Set accessibility window ID to the surface. A negative number removes the existing accessibility ID from the surface.

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.

occlusion_state_changed(mode: uint<zaura_surface.occlusion_state>)
Argument
Type
Description
modeuint<zaura_surface.occlusion_state>
Notify the client that the occlusion state changed

Notifies the client that the occlusion state of a window has changed. Clients will only receive these messages if they previously request occlusion tracking via set_occlusion_tracking for a particular surface.

desk_changed(state: int)
Argument
Type
Description
stateint
index of desk or -1 for a window assigned to all desks
Window desk state changed

Notifies when there is a change in the desk state of a window. This is emitted when a window is moved to another desk or when its assigned-to-all-desks state changes.

start_throttle()
Start throttling on the surface

Informs the client to start throttling on the surface.

end_throttle()
End throttling on the surface

Informs the client to end throttling on the surface.

tooltip_shown(text: string, x: int, y: int, width: int, height: int)
Argument
Type
Description
textstring
xint
yint
widthint
heightint
Tooltip is shown by server side

Informs the client that the tooltip is shown with states. `x` and `y` specifies the location of tooltip in surface local coordinates.

tooltip_hidden()
Tooltip is hidden by server side

Informs the client that the tooltip is hidden.

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.

[Deprecated] 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.

occlusion_state { unknown, visible, occluded, hidden } 
Argument
Value
Description
unknown0
The surface's occlusion state isn't tracked
visible1
The surface is visible
occluded2
The surface is occluded
hidden3
The surface is not visible
Surface occlusion state

Describes the occlusion state of a surface.

tooltip_trigger { cursor, keyboard } 
Argument
Value
Description
cursor0
triggered by cursor
keyboard1
triggered by keyboard
Type of tooltip trigger

Describes what triggered tooltip


zaura_output

version 45
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.

release
Type: destructorsince 38
release()
Destroy zaura_output

Destroy this zaura_shell object.

Destroying a bound zaura_shell object while there are zaura_surfaces still alive created by this zaura_shell object instance is illegal and will result in a protocol error.

See zaura_shell.release for destructor naming.

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.

insets(top: int, left: int, bottom: int, right: int)
Argument
Type
Description
topint
leftint
bottomint
rightint
Advertise the work area insets for the output

This event describes the insets for the output in logical screen coordinates, from which the work area can be calculated.

This event is sent before wl_output.done, after which the client would apply the change.

logical_transform(transform: int<wl_output.transform>)
Argument
Type
Description
transformint<wl_output.transform>
Advertise the output's logical transform

This event describes the logical transform for the output. Whereas wl_output.geometry's transform corresponds to the display's panel rotation, the logical transform corresponds to the display's logical rotation.

This event is sent before wl_output.done, after which the client would apply the change.

display_id(display_id_hi: uint, display_id_lo: uint)
Argument
Type
Description
display_id_hiuint
display_id_louint
Advertise the output's display id

This event describes the 64bit display id assigned to each display by ChromeOS. The value is opaque and should not be interpreted.

activated()
Target display for new windows

Notifies that this output is now active output. It is typically used as a target when a new window is created without specific bounds.

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

zaura_toplevel

version 53
Aura shell interface to the toplevel shell

An interface to the toplevel shell, which allows the client to access shell specific functionality.

Set orientation lock for a remote surface

Request a specific orientation behavior when this surface is in fullscreen.

surface_submission_in_pixel_coordinates()
Surface will be submitted in pixel coordinates

Informs the server that when submitting this surface, this client will not use wl_surface_set_buffer_scale to report the scales, nor will it apply scale via vp_viewporter. Instead the server should apply an appropriate scale transform for the submitted buffers to be composited correctly.

set_supports_screen_coordinates()
Enables screen coordinates in window bounds

Requesting this will enable screen coordinates in surfaces associated with aura_toplevel including sub surfaces and popup windows who added this toplevel as a parent. This should be set before first commit.

set_window_bounds(x: int, y: int, width: int, height: int, output: object<wl_output>)
Argument
Type
Description
xint
yint
widthint
heightint
outputobject<wl_output>allow null
the output
Set window size and position

Request a new location and bounds of the surface in DP screen coordinates. The size will be applied to visible bounds used in set_geometry. The output is a hint for the compositor to determine which output the window should move to. If the output is null, the compositor should make decision solely by the given bounds. These parameters are just a request and the compositor may ignore, adjust the size and position based on the rule imposed by the window manager, or may preserve it for future operations. For example, the compositor will not allow a position outside of the output, or the compositor may just store it if the toplevel surface is in maximiezd state, and may use it upon unmaximized.

set_restore_info(restore_session_id: int, restore_window_id: int)
Argument
Type
Description
restore_session_idint
unique browser session id
restore_window_idint
restore browser window id
Set session id and restore id

Request session id and restore id of a newly created browser window. Set the information used by compositor to restore the toplevel surface state, such as window position, window state, upon creation. This is not double buffered and must be set before sending first commit.

set_system_modal()
Make window a system modal

Requests that the toplevel surface should become a system modal. The compositor will prevent other windows from receiving events. If there are multiple system modal surfaces, the compositor will decide which one to receive events.

unset_system_modal()
Unset window system modal state

Requests that the system modal state of the toplevel surface will be unset. The compositor will then allow other windows to recieve events.

set_restore_info_with_window_id_source(restore_session_id: int, restore_window_id_source: string)
Argument
Type
Description
restore_session_idint
unique browser session id
restore_window_id_sourcestring
restore window id source
Set session id and restore window id source

Request session id and restore id of the window. Set the information used by compositor to restore the toplevel surface state, such as window position, window state, upon creation. This is not double buffered and must be set before sending first commit. This is different from set_restore_info, used for clients that create multiple windows associated with restore_id_source.

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

Clients are allowed to request a particular decoration for a zaura_toplevel. The server is not required to honor this request. See decoration_type for available options. Available since M105.

release
Type: destructorsince 38
release()
Destroy zaura_toplevel

Destroy this zaura_toplevel object. A client should call destroy when the role is unmapped from a wl_surface.

See zaura_shell.release for destructor naming.

set_float()
Float the surface on top

This is a request to place the surface above others.

unset_float()
Unset the surface float

Request that the surface resets floating.

set_z_order(z_order: uint)
Argument
Type
Description
z_orderuint
z order value for the window
Set z order for window

Sets the z order for a toplevel surface. See z_order_level for available options.

set_origin(x: int, y: int, output: object<wl_output>)
Argument
Type
Description
xint
yint
outputobject<wl_output>allow null
output to contain the surface
Set window position in DPs

Request a new location for the surface in device-independent pixels (DPs), relative to the top-left corner of the given output.

A null output means whichever output currently contains the surface.

These parameters are just a request and the compositor may ignore them, adjust them due to rules imposed by the window manager, or preserve them for future operations. For example, the compositor will not allow a position outside of the output; or the compositor may just store it if the toplevel surface is in maximized state, and may use it upon unmaximize.

activate()
Activates the window

Activates this window. This is equivalent to bringing the window to the foreground. The compositor is free to ignore this request if it deems the client to be misbehaving.

deactivate()
Deactivates the window

Deactivates this window. This is equivalent to requesting that the window not be the foreground window. The exact behavior is compositor-defined. The compositor is free to ignore this request if it deems the client to be misbehaving.

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

Suggests how the windowing manager should behave if this surface were to go fullscreen. Does not make the surface fullscreen.

set_scale_factor(scale_factor_as_uint: uint)
Argument
Type
Description
scale_factor_as_uintuint
Allows the client to set the scale factor for the future buffer commits.

The client has a 32-bit float scale factor that is associated with each zaura toplevel. This scale factor must be propagated exactly to exo. To do so we reinterpret_cast into a 32-bit uint and later cast back into a float. This is because wayland does not support native transport of floats. As different CPU architectures may use different endian representations for IEEE 754 floats, this protocol implicitly assumes that the caller and receiver are the same machine. To avoid redundant messages, this request needs to only be called once when the zaura toplevel scale factor changes. This is double buffered state and will be applied in the next commit.

set_snap_primary(snap_ratio_as_uint: uint)
Argument
Type
Description
snap_ratio_as_uintuint
Snap the surface to the primary snap position.

Request that surface is snapped to the left or top if primary layout, right or bottom otherwise.

set_snap_secondary(snap_ratio_as_uint: uint)
Argument
Type
Description
snap_ratio_as_uintuint
Snap the surface to the secondary snap position.

Request that surface is snapped to the right or bottom if primary layout, left or top otherwise.

Argument
Type
Description
directionuint<zaura_toplevel.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'.

unset_snap()
Unset the window snap.

Request that window unsets snapping.

set_persistable(persistable: uint<zaura_toplevel.persistable>)
Argument
Type
Description
persistableuint<zaura_toplevel.persistable>
is the argument persistable
Describes if the window is persistable

Request the persistable status of a window. Sets the persistable status of the window in its window properties. Should be called before first commit.

set_shape(region: object<wl_region>)
Argument
Type
Description
regionobject<wl_region>allow null
Set the shape of the surface in DP

Sets the shape of the toplevel window in DP. Passing NULL will reset the shape of the window.

This should be used only in support of the existing (deprecated) Chrome Apps SetShape API and not for any other purpose.

configure(x: int, y: int, width: int, height: int, states: array)
Argument
Type
Description
xint
yint
widthint
heightint
statesarray
Suggest a surface change

A configuration change that also includes the window origin in screen coordinates.

origin_change(x: int, y: int)
Argument
Type
Description
xint
yint
Window origin change

A notification sent when the window origin has changed. Unlike a configure, this does not imply the client needs to resize. The values are in screen coordinates.

configure_raster_scale(scale: uint)
Argument
Type
Description
scaleuint
Raster scale, in float format
Set the raster scale during a configure

Sets the raster scale of this window. This should be called during a configure event sequence. To do so we reinterpret_cast into a 32-bit uint and later cast back into a float. This is because wayland does not support native transport of floats. As different CPU architectures may use different endian representations for IEEE 754 floats, this protocol implicitly assumes that the caller and receiver are the same machine.

Argument
Value
Description
none1
no orientation lock
portrait2
primary or secondary portrait
landscape3
primary or secondary landscape
current4
keep current orientation
portrait_primary5
primary portrait
landscape_primary6
primary landscape
portrait_secondary7
secondary portrait
landscape_secondary8
secondary landscape
Orientation lock request

Defines orientation request when a surface is in fullscreen.

Argument
Value
Description
immersivesince 36100
Immersive mode with hidden title bar and shelf

User can access system UIs such as the shelf and window frame by pointing to, or swiping over, the screen edge.

minimizedsince 36101
Surface is minimized

The window has been minimized.

snapped_primarysince 38102
Window is snapped in primary position

The window is snapped to the left if the display is in landscape mode and at the top in portrait mode.

snapped_secondarysince 38103
Window is snapped in secondary position

The window is snapped to the right if the display is in landscape mode and at the bottom in portrait mode.

floatedsince 38104
Window is floated on top

The window is floated on top of other windows. One floated window is allowed per desk. Floating a window when there is already a floated window on the same desk will unfloat the floated window.

Supplemental aura states to xdg states

The states that are contained here are supplemental to the states defined in the XDG shell and specific aura windows.

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

Decoration types are used to modify the surface (e.g. drop shadow).

Argument
Value
Description
normal0
the default level for windows
floating_window1
a floating window z-ordered above other normal windows
floating_ui_element2
used to show non-window style UIs that are shown above floating windows
security_surface3
cannot be interfered with or covered up
Z order levels for windows

Different z order levels that are used to set the z order for a toplevel surface.

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

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

snap_direction { none, primary, secondary } 
Argument
Value
Description
none0
unsnap the window
primary1
snap the window to the left or top in primary layout, right or bottom in secondary layout
secondary2
snap the window to the right or bottom in primary layout, top or left in secondary layout
Window snap directions

Window snap directions.

persistable { not_persistable, persistable } 
Argument
Value
Description
not_persistable0
the value is not persistable
persistable1
the value is persistable
Describes whether or not the value is persistable

Binary enum maps to boolean, describes whether or not a value is persistable.


zaura_popup

version 46
Aura shell interface to the popup shell

An interface to the popup shell, which allows the client to access shell specific functionality.

surface_submission_in_pixel_coordinates()
Surface will be submitted in pixel coordinates

Informs the server that when submitting this surface, this client will not use wl_surface_set_buffer_scale to report the scales, nor will it apply scale via vp_viewporter. Instead the server should apply an appropriate scale transform for the submitted buffers to be composited correctly.

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

Clients are allowed to request a particular decoration for a zaura_toplevel. The server is not required to honor this request. See decoration_type for available options. Available since M105.

set_menu()
Set popup type to menu

Set popup type to menu

release
Type: destructorsince 38
release()
Destroy zaura_popup

This request destroys the zaura_popup. A client should call destroy when the role is unmapped from a wl_surface.

See zaura_shell.release for destructor naming.

set_scale_factor(scale_factor_as_uint: uint)
Argument
Type
Description
scale_factor_as_uintuint
Allows the client to set the scale factor for the future buffer commits.

The client has a 32-bit float scale factor that is associated with each zaura popup. This scale factor must be propagated exactly to exo. To do so we reinterpret_cast into a 32-bit uint and later cast back into a float. This is because wayland does not support native transport of floats. As different CPU architectures may use different endian representations for IEEE 754 floats, this protocol implicitly assumes that the caller and receiver are the same machine. To avoid redundant messages, this request needs to only be called once when the zaura popup's scale factor changes.

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

Decoration types are used to modify the surface (e.g. drop shadow).


Aura shell interface to the output manager

A global responsible for ensuring clients have a complete view of a given output's state immediately following the bind of wl_output, and subsequently as needed.

Clients can expect that all the manager's events for a given wl_output arrive before the associated wl_output.done event. Clients must bind to the manager global before any output globals.

done(output: object<wl_output>)
Argument
Type
Description
outputobject<wl_output>
Sent all information about output

This event is sent after all relevant properties of a zaura_output_manager for a given wl_output have been sent.

display_id(output: object<wl_output>, display_id_hi: uint, display_id_lo: uint)
Argument
Type
Description
outputobject<wl_output>
display_id_hiuint
display_id_louint
Advertise the output's display id

This event describes the 64bit display id assigned to each display by ChromeOS. The value is opaque and should not be interpreted.

The event is sent when binding to the output object and subsequently as output state changes.

logical_position(output: object<wl_output>, x: int, y: int)
Argument
Type
Description
outputobject<wl_output>
xint
x position within the global compositor space
yint
y position within the global compositor space
Position of the output within the global compositor space

The position event describes the location of the wl_output within the global compositor space.

The event is sent when binding to the output object and subsequently as output state changes.

logical_size(output: object<wl_output>, width: int, height: int)
Argument
Type
Description
outputobject<wl_output>
widthint
width in global compositor space
heightint
height in global compositor space
Size of the output in the global compositor space

The logical_size event describes the logical size of the output in the global compositor space.

The event is sent when binding to the output object and subsequently as output state changes.

physical_size(output: object<wl_output>, width: int, height: int)
Argument
Type
Description
outputobject<wl_output>
widthint
width in global compositor space
heightint
height in global compositor space
Size of the output in pixels

The physical resolution of the display in pixels. The value should not include any overscan insets or display rotation, except for any panel orientation adjustment.

The event is sent when binding to the output object and subsequently as output state changes.

insets(output: object<wl_output>, top: int, left: int, bottom: int, right: int)
Argument
Type
Description
outputobject<wl_output>
topint
leftint
bottomint
rightint
Advertise the work area insets for the output

This event describes the insets for the output in logical screen coordinates, from which the work area can be calculated.

The event is sent when binding to the output object and subsequently as output state changes.

device_scale_factor(output: object<wl_output>, device_scale_factor: uint)
Argument
Type
Description
outputobject<wl_output>
device_scale_factoruint
display scale factor, in float format
Advertise device scale factor for the output

The scale factor of the output device. We reinterpret_cast the float scale factor into a 32-bit uint and later cast back into a float. This is because wayland does not support native transport of floats. As different CPU architectures may use different endian representations for IEEE 754 floats, this protocol implicitly assumes that the caller and receiver are the same machine.

The event is sent when binding to the output object and subsequently as output state changes.

logical_transform(output: object<wl_output>, transform: int<wl_output.transform>)
Argument
Type
Description
outputobject<wl_output>
transformint<wl_output.transform>
transform that maps framebuffer to output
Logical transform of the output

This event describes the logical transform for the output. Whereas panel transform corresponds to the display's panel rotation, the logical transform corresponds to the display's logical rotation.

The event is sent when binding to the output object and subsequently as output state changes.

panel_transform(output: object<wl_output>, transform: int<wl_output.transform>)
Argument
Type
Description
outputobject<wl_output>
transformint<wl_output.transform>
transform that maps framebuffer to output
Panel transform of the output

This event describes the panel transform for the output, which is the associated display's panel rotation.

The event is sent when binding to the output object and subsequently as output state changes.

name(output: object<wl_output>, name: string)
Argument
Type
Description
outputobject<wl_output>
namestring
output name
Human-readable name of this output

The name is a UTF-8 string with no convention defined for its contents.

The event is sent when binding to the output object and subsequently as output state changes.

description(output: object<wl_output>, description: string)
Argument
Type
Description
outputobject<wl_output>
descriptionstring
output description
Human-readable description of this output

The description is a UTF-8 string with no convention defined for its contents.

The event is sent when binding to the output object and subsequently as output state changes.

activated(output: object<wl_output>)
Argument
Type
Description
outputobject<wl_output>
Target display for new windows

Notifies that this output is now active output. It is typically used as a target when a new window is created without specific bounds.

overscan_insets(output: object<wl_output>, top: int, left: int, bottom: int, right: int)
Argument
Type
Description
outputobject<wl_output>
topint
leftint
bottomint
rightint
Advertise the overscan insets for the output

This event describes the overscan insets for the output in physical pixels.

The event is sent when binding to the output object and subsequently as output state changes.


Compositor Support

No compositor support found

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.