Skip to content

wp_content_type_v1¤

wayland.wp_content_type_v1 ¤

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.

Methods:

type ¤

Possible content types

These values describe the available content types for a surface.

  • none
    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.
  • photo
    Photo content type The content type photo describes content derived from digital still pictures and may be presented with minimal processing.
  • video
    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.
  • game
    Game content type The content type game describes a running game. Its content may be presented with reduced latency.

destroy ¤

destroy() -> None

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 ¤

set_content_type(content_type: type) -> None

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.

Parameters:

  • content_type ¤

    (type) –

    The content type