Struct WpImageDescriptionV1

pub struct WpImageDescriptionV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

Colorimetric image description

An image description carries information about the pixel color encoding and its intended display and viewing environment. The image description is attached to a wl_surface via wp_color_management_surface_v1.set_image_description. A compositor can use this information to decode pixel values into colorimetrically meaningful quantities, which allows the compositor to transform the surface contents to become suitable for various displays and viewing environments.

Note, that the wp_image_description_v1 object is not ready to be used immediately after creation. The object eventually delivers either the ‘ready’ or the ‘failed’ event, specified in all requests creating it. The object is deemed “ready” after receiving the ‘ready’ event.

An object which is not ready is illegal to use, it can only be destroyed. Any other request in this interface shall result in the ‘not_ready’ protocol error. Attempts to use an object which is not ready through other interfaces shall raise protocol errors defined there.

Once created and regardless of how it was created, a wp_image_description_v1 object always refers to one fixed image description. It cannot change after creation.

See also the Event enum for this interface.

Implementations

impl WpImageDescriptionV1

pub fn destroy(&self)

destroy the image description

Destroy this object. It is safe to destroy an object which is not ready.

Destroying a wp_image_description_v1 object has no side-effects, not even if a wp_color_management_surface_v1.set_image_description has not yet been followed by a wl_surface.commit.

pub fn get_information<U, D>( &self, qh: &QueueHandle<D>, udata: U, ) -> WpImageDescriptionInfoV1

where U: Send + Sync + 'static, D: Dispatch<WpImageDescriptionInfoV1, U> + 'static,

get information about the image description

Creates a wp_image_description_info_v1 object which delivers the information that makes up the image description.

Not all image description protocol objects allow get_information request. Whether it is allowed or not is defined by the request that created the object. If get_information is not allowed, the protocol error no_information is raised.

Trait Implementations

impl Borrow<ObjectId> for WpImageDescriptionV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for WpImageDescriptionV1

fn clone(&self) -> WpImageDescriptionV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WpImageDescriptionV1

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

Formats the value using the given formatter.

impl Hash for WpImageDescriptionV1

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<WpImageDescriptionV1>> for WpImageDescriptionV1

fn eq(&self, other: &Weak<WpImageDescriptionV1>) -> 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 WpImageDescriptionV1

fn eq(&self, other: &WpImageDescriptionV1) -> 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 WpImageDescriptionV1

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: <WpImageDescriptionV1 as Proxy>::Request<'_>, ) -> Result<(), InvalidId>

Send a request for this object.

fn send_constructor<I>( &self, req: <WpImageDescriptionV1 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<WpImageDescriptionV1, InvalidId>

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> WpImageDescriptionV1

Create an inert object proxy

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

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: <WpImageDescriptionV1 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 WpImageDescriptionV1