Enum Request

#[non_exhaustive]
pub enum Request {
    Destroy,
    SetAlphaMode {
        alpha_mode: WEnum<AlphaMode>,
    },
    SetCoefficientsAndRange {
        coefficients: WEnum<Coefficients>,
        range: WEnum<Range>,
    },
    SetChromaLocation {
        chroma_location: WEnum<ChromaLocation>,
    },
}

Available on crate feature wayland and Linux only.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Destroy

destroy the color representation

Destroy the wp_color_representation_surface_v1 object.

Destroying this object unsets all the color representation metadata from the surface. See the wp_color_representation_surface_v1 interface description for how a compositor handles a surface without color representation metadata. Unsetting is double-buffered state, see wl_surface.commit.

This is a destructor, once received this object cannot be used any longer.

SetAlphaMode

set the surface alpha mode

If this protocol object is inert, the protocol error inert is raised.

Assuming an alpha channel exists, it is always linear. The alpha mode determines whether and how the color channels include pre-multiplied alpha. Using straight alpha might have performance benefits.

Only alpha modes advertised by the compositor are allowed to be used as argument for this request. The “alpha_mode” protocol error is raised otherwise.

Alpha mode is double buffered, see wl_surface.commit.

Fields

alpha_mode: WEnum<AlphaMode>

alpha mode

SetCoefficientsAndRange

set the matrix coefficients and range

If this protocol object is inert, the protocol error inert is raised.

Set the matrix coefficients and video range which defines the formula and the related constants used to derive red, green and blue signals. Usually coefficients correspond to MatrixCoefficients code points in H.273.

Only combinations advertised by the compositor are allowed to be used as argument for this request. The “coefficients” protocol error is raised otherwise.

A call to wl_surface.commit verifies that the pixel format and the coefficients-range combination in the committed surface contents are compatible, if contents exist. The “pixel_format” protocol error is raised otherwise.

A pixel format is compatible with the coefficients-range combination if the related equations and conventions as defined in H.273 can produce the color channels (RGB or YCbCr) of the pixel format.

For the definition of the supported combination, see the wp_color_representation_surface_v1::coefficients and wp_color_representation_surface_v1::range enums.

The coefficients-range combination is double-buffered, see wl_surface.commit.

Fields

coefficients: WEnum<Coefficients>

matrix coefficients

range: WEnum<Range>

range

SetChromaLocation

set the chroma location

If this protocol object is inert, the protocol error inert is raised.

Set the chroma location type which defines the position of downsampled chroma samples, corresponding to Chroma420SampleLocType code points in H.273.

An invalid chroma location enum value raises the “chroma_location” protocol error.

A call to wl_surface.commit verifies that the pixel format and chroma location type in the committed surface contents are compatible, if contents exist. The “pixel_format” protocol error is raised otherwise.

For the definition of the supported chroma location types, see the wp_color_representation_surface_v1::chroma_location enum.

The chroma location type is double-buffered, see wl_surface.commit.

Fields

chroma_location: WEnum<ChromaLocation>

chroma sample location

Implementations

impl Request

pub fn opcode(&self) -> u16

Get the opcode number of this message

Trait Implementations

impl Debug for Request

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.