Chromium surface augmenter

surface-augmenter

surface_augmenter

version 5

Surface composition delegation

The global interface exposing surface delegated composition capabilities is used to instantiate an interface extension for a wl_surface object. This extended interface will then allow delegated compostion of the surface contents, effectively disconnecting the direct relationship between the buffer and the surface content (adding support for solid quads and rounded corner for instance).

surface_augmenter::destroy

Type: destructor

destroy()

Destroy the surface augmenter.

Informs the server that the client will not be using this protocol object anymore. This does not affect any other objects, augmenter objects included.

surface_augmenter::create_solid_color_buffer

create_solid_color_buffer(id: new_id<wl_buffer>, color: array, width: int, height: int)

Argument	Type	Description
id	new_id<wl_buffer>
color	array	quad color represented by a SkColor4f
width	int
height	int

Creates a solid color buffer

Instantiate a buffer of the given size for the purpose of a solid color quad of a given color.

surface_augmenter::get_augmented_surface

get_augmented_surface(id: new_id<augmented_surface>, surface: object<wl_surface>)

Argument	Type	Description
id	new_id<augmented_surface>	the new augmenter interface id
surface	object<wl_surface>	the surface

Extend surface interface for delegation

Instantiate an interface extension for the given wl_surface to extend composition of its content. If the given wl_surface already has a augmentation object associated, the delegate_exists protocol error is raised.

surface_augmenter::get_augmented_subsurface

since 2

get_augmented_subsurface(id: new_id<augmented_sub_surface>, subsurface: object<wl_subsurface>)

Argument	Type	Description
id	new_id<augmented_sub_surface>	the new augmenter interface id
subsurface	object<wl_subsurface>	the subsurface

Extend sub surface interface for delegation

Instantiate an interface extension for the given wl_subsurface to extend composition of its content. If the given wl_subsurface already has a augmentation object associated, the delegate_exists protocol error is raised.

surface_augmenter::error

error { augmented_surface_exists }

Argument	Value	Description
augmented_surface_exists	0	the surface already has a augmenter object associated

augmented_surface

version 3

Delegate composition of a wl_surface

An additional interface to a wl_surface object, which allows the client to specify the delegated composition of the surface contents.

augmented_surface::destroy

Type: destructor

destroy()

Remove delegated composition of the surface

The associated wl_surface's augmenter is removed. The change is applied on the next wl_surface.commit.

augmented_surface::set_rounded_corners

set_rounded_corners(top_left: fixed, top_right: fixed, bottom_right: fixed, bottom_left: fixed)

Argument	Type	Description
top_left	fixed	top left corner
top_right	fixed	top right corner
bottom_right	fixed	bottom right corner
bottom_left	fixed	bottom left corner

Set the surface rounded corners

[Deprecated] Informs the server that it must apply the rounded corners mask filter that shall be applied on next commit. Use set_rounded_corners_bounds instead.

augmented_surface::set_destination_size

since 2

set_destination_size(width: fixed, height: fixed)

Argument	Type	Description
width	fixed	width of the surface
height	fixed	height of the surface

Set the surface destination viewport size, with subpixel accuracy

Sets the surface destination viewport size, with subpixel accuracy. This state is double-buffered, and is applied on the next wl_surface.commit.

augmented_surface::set_rounded_clip_bounds

since 2

set_rounded_clip_bounds(x: int, y: int, width: int, height: int, top_left: fixed, top_right: fixed, bottom_right: fixed, bottom_left: fixed)

Argument	Type	Description
x	int
y	int
width	int
height	int
top_left	fixed	top left corner
top_right	fixed	top right corner
bottom_right	fixed	bottom right corner
bottom_left	fixed	bottom left corner

Set the surface rounded clip bounds

Informs the server that it must apply the rounded clipping mask filter that shall be applied on next commit. The mask can be uniform for several surfaces and applied uniformally so that two or more surfaces visually look as a single surface with rounded corners. Please note this is can only be used on surfaces that are used as overlays, which must not have any subtrees. The rounding will be ignored if the bounds are outside of the surface.

augmented_surface::set_background_color

since 3

set_background_color(color: array)

Argument	Type	Description
color	array	overlay color represented by a SkColor4f

Sets a background color of this surface

Sets a background color of a this surface. This information will be associated with the next buffer commit. Please note this is different from solid color buffers, which creates a new buffer instance, and rather provides additional information how the buffer should be composited. Passing empty array means the background color is reset. The default value is determined by the Wayland compositor then.

augmented_surface::error

error { bad_value, no_surface }

Argument	Value	Description
bad_value	0	negative values in radius or size
no_surface	1	the wl_surface was destroyed

augmented_sub_surface

version 5

Delegate composition of a wl_subsurface

An additional interface to a wl_subsurface object, which allows the client to specify the delegated composition of the surface contents.

augmented_sub_surface::destroy

Type: destructor

destroy()

Remove delegated composition of the surface

The associated wl_surface's augmenter is removed. The change is applied on the next wl_surface.commit.

augmented_sub_surface::set_position

set_position(x: fixed, y: fixed)

Argument	Type	Description
x	fixed	x coordinate in the parent surface
y	fixed	y coordinate in the parent surface

Sets a subsurface position with subpixel accuracy

This schedules a sub-surface position change. The sub-surface will be moved so that its origin (top left corner pixel) will be at the location x, y of the parent surface coordinate system. The coordinates are not restricted to the parent surface area. Negative values are allowed.

The scheduled coordinates will take effect whenever the state of the parent surface is applied. When this happens depends on whether the parent surface is in synchronized mode or not. See wl_subsurface.set_sync and wl_subsurface.set_desync for details.

If more than one set_position request is invoked by the client before the commit of the parent surface, the position of a new request always replaces the scheduled position from any previous request.

The initial position is 0, 0. This state is double-buffered, and is applied on the next wl_surface.commit.

augmented_sub_surface::set_clip_rect

since 4

set_clip_rect(x: fixed, y: fixed, width: fixed, height: fixed)

Argument	Type	Description
x	fixed	x coordinate in the parent surface
y	fixed	y coordinate in the parent surface
width	fixed	width of the clip rect
height	fixed	height of the clip rect

Sets a subsurface clip rect with subpixel accuracy

This schedules a clip rect to be applied when drawing this sub-surface. The clip will be placed with its origin (top left corner pixel) at the location x, y of the parent surface coordinate system. The coordinates are not restricted to the parent surface area. Negative x and y values are allowed.

If all of x, y, width and height are -1.0, the clip rect is unset instead.

Initially, surfaces have no clip set. This state is double-buffered, and is applied on the next wl_surface.commit.

augmented_sub_surface::set_transform

since 5

set_transform(matrix: array)

Argument	Type	Description
matrix	array	size 6 affine matrix, or size 0 for identity matrix

Sets a subsurface transform as an affine matrix

This schedules a transform to be applied when drawing this sub-surface. This transform does not apply to any child surfaces of this sub-surface.

The matrix should be passed as an array of 6 floats in column major order. An empty array can be sent to set the transform to the identity matrix.

The initial transform is identity. This state is double-buffered, and is applied on the next wl_surface.commit.

augmented_sub_surface::error

error { invalid_size }

Argument	Value	Description
invalid_size	0	array sent with invalid dimensions

Compositor Support

No compositor support found

Copyright

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.