Chromium overlay prioritizer
overlay_prioritizer
The global interface exposing overlay delegated prioritization hint capabilities is used to instantiate an interface extension for a wl_surface object. This extended interface will then allow delegated overlay prioritization of the surface.
destroy()
Informs the server that the client will not be using this protocol object anymore. This does not affect any other objects, prioritizer objects included.
get_overlay_prioritized_surface(id: new_id<overlay_prioritized_surface>, surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| id | new_id<overlay_prioritized_surface> | the new prioritized interface id |
| surface | object<wl_surface> | the surface |
Instantiate an interface extension for the given wl_surface to add support for overlay prioritization hinting. If the given wl_surface already has a prioritization object associated, the delegate_exists protocol error is raised.
error { overlay_hinted_surface_exists }
Argument | Value | Description |
|---|---|---|
| overlay_hinted_surface_exists | 0 | the surface already has a prioritizer object associated |
overlay_prioritized_surface
An additional interface to a wl_surface object, which allows the client to specify hints for the overlay prioritization of the surface.
destroy()
The associated wl_surface's overlay prioritization is removed. The change is applied on the next wl_surface.commit.
set_overlay_priority(priority: uint)
Argument | Type | Description |
|---|---|---|
| priority | uint |
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 |
overlay_priority { none, regular, preferred_low_latency_canvas, required_hardware_protection }
Argument | Value | Description |
|---|---|---|
| none | 0 | overlay promotion is not necessary for this surface |
| regular | 1 | surface could be considered as a candidate for promotion |
| preferred_low_latency_canvas | 2 | the surface is a low latency canvas that works better if promoted to overlay |
| required_hardware_protection | 3 | the surface contains protected content and requires to be promoted to overlay |
Compositor Support
Copyright
Copyright 2021 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.