Content type hint

Surface content type manager

This interface allows a client to describe the kind of content a surface will display, to allow the compositor to optimize its behavior for it.

Warning! The protocol described in this file is currently in the testing phase. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes can only be done by creating a new major version of the extension.

destroy()
Destroy the content type manager object

Destroy the content type manager. This doesn't destroy objects created with the manager.

get_surface_content_type(id: new_id<wp_content_type_v1>, surface: object<wl_surface>)
Argument
Type
Description
idnew_id<wp_content_type_v1>
surfaceobject<wl_surface>
Create a new toplevel decoration object

Create a new content type object associated with the given surface.

Creating a wp_content_type_v1 from a wl_surface which already has one attached is a client error: already_constructed.

Argument
Value
Description
already_constructed0
wl_surface already has a content type object

Content type object for a surface

The content type object allows the compositor to optimize for the kind of content shown on the surface. A compositor may for example use it to set relevant drm properties like "content type".

The client may request to switch to another content type at any time. When the associated surface gets destroyed, this object becomes inert and the client should destroy it.

destroy()
Destroy the content type object

Switch back to not specifying the content type of this surface. This is equivalent to setting the content type to none, including double buffering semantics. See set_content_type for details.

set_content_type(content_type: uint<wp_content_type_v1.type>)
Argument
Type
Description
content_typeuint<wp_content_type_v1.type>
the content type
Specify the content type

Set the surface content type. This informs the compositor that the client believes it is displaying buffers matching this content type.

This is purely a hint for the compositor, which can be used to adjust its behavior or hardware settings to fit the presented content best.

The content type is double-buffered state, see wl_surface.commit for details.

type { none, photo, video, game } 
Argument
Value
Description
none0
No content type applies

The content type none means that either the application has no data about the content type, or that the content doesn't fit into one of the other categories.

photo1
Photo content type

The content type photo describes content derived from digital still pictures and may be presented with minimal processing.

video2
Video content type

The content type video describes a video or animation and may be presented with more accurate timing to avoid stutter. Where scaling is needed, scaling methods more appropriate for video may be used.

game3
Game content type

The content type game describes a running game. Its content may be presented with reduced latency.

Possible content types

These values describe the available content types for a surface.


Compositor Support

No compositor support found

Copyright © 2021 Emmanuel Gil Peyrot Copyright © 2022 Xaver Hugl

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.