Struct WpColorManagementSurfaceV1

pub struct WpColorManagementSurfaceV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

color management extension to a surface

A wp_color_management_surface_v1 allows the client to set the color space and HDR properties of a surface.

If the wl_surface associated with the wp_color_management_surface_v1 is destroyed, the wp_color_management_surface_v1 object becomes inert.

This interface has no events.

Implementations

impl WpColorManagementSurfaceV1

pub fn destroy(&self)

destroy the color management interface for a surface

Destroy the wp_color_management_surface_v1 object and do the same as unset_image_description.

pub fn set_image_description( &self, image_description: &WpImageDescriptionV1, render_intent: RenderIntent, )

set the surface image description

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

Set the image description of the underlying surface. The image description and rendering intent are double-buffered state, see wl_surface.commit.

It is the client’s responsibility to understand the image description it sets on a surface, and to provide content that matches that image description. Compositors might convert images to match their own or any other image descriptions.

Image descriptions which are not ready (see wp_image_description_v1) are forbidden in this request, and in such case the protocol error image_description is raised.

All image descriptions which are ready (see wp_image_description_v1) are allowed and must always be accepted by the compositor.

When an image description is set on a surface, it establishes an explicit link between surface pixel values and surface colorimetry. This link may be undefined for some pixel values, see the image description creator interfaces for the conditions. Non-finite floating-point values (NaN, Inf) always have an undefined colorimetry.

A rendering intent provides the client’s preference on how surface colorimetry should be mapped to each output. The render_intent value must be one advertised by the compositor with wp_color_manager_v1.render_intent event, otherwise the protocol error render_intent is raised.

By default, a surface does not have an associated image description nor a rendering intent. The handling of color on such surfaces is compositor implementation defined. Compositors should handle such surfaces as sRGB, but may handle them differently if they have specific requirements.

Setting the image description has copy semantics; after this request, the image description can be immediately destroyed without affecting the pending state of the surface.

pub fn unset_image_description(&self)

remove the surface image description

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

This request removes any image description from the surface. See set_image_description for how a compositor handles a surface without an image description. This is double-buffered state, see wl_surface.commit.

Trait Implementations

impl Borrow<ObjectId> for WpColorManagementSurfaceV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for WpColorManagementSurfaceV1

fn clone(&self) -> WpColorManagementSurfaceV1

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WpColorManagementSurfaceV1

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

Formats the value using the given formatter.

impl Hash for WpColorManagementSurfaceV1

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Weak<WpColorManagementSurfaceV1>> for WpColorManagementSurfaceV1

fn eq(&self, other: &Weak<WpColorManagementSurfaceV1>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for WpColorManagementSurfaceV1

fn eq(&self, other: &WpColorManagementSurfaceV1) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Proxy for WpColorManagementSurfaceV1

type Request<'request> = Request<'request>

The request enum for this interface

type Event = Event

The event enum for this interface

fn interface() -> &'static Interface

The interface description

fn id(&self) -> ObjectId

The ID of this object

fn version(&self) -> u32

The version of this object

fn data<U>(&self) -> Option<&U>

where U: Send + Sync + 'static,

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn ObjectData>>

Access the raw data associated with this object.

fn backend(&self) -> &WeakBackend

Access the backend associated with this object

fn send_request( &self, req: <WpColorManagementSurfaceV1 as Proxy>::Request<'_>, ) -> Result<(), InvalidId>

Send a request for this object.

fn send_constructor<I>( &self, req: <WpColorManagementSurfaceV1 as Proxy>::Request<'_>, data: Arc<dyn ObjectData>, ) -> Result<I, InvalidId>

where I: Proxy,

Send a request for this object that creates another object.

fn from_id( conn: &Connection, id: ObjectId, ) -> Result<WpColorManagementSurfaceV1, InvalidId>

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> WpColorManagementSurfaceV1

Create an inert object proxy

fn parse_event( conn: &Connection, msg: Message<ObjectId, OwnedFd>, ) -> Result<(WpColorManagementSurfaceV1, <WpColorManagementSurfaceV1 as Proxy>::Event), DispatchError>

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: <WpColorManagementSurfaceV1 as Proxy>::Request<'a>, ) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>

Serialize a request for this object

fn is_alive(&self) -> bool

Checks if the Wayland object associated with this proxy is still alive

fn downgrade(&self) -> Weak<Self>

Creates a weak handle to this object

impl Eq for WpColorManagementSurfaceV1