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 Request enum for this interface.

Implementations

impl WpImageDescriptionV1

pub fn failed(&self, cause: Cause, msg: String)

graceful error on creating the image description

If creating a wp_image_description_v1 object fails for a reason that is not defined as a protocol error, this event is sent.

The requests that create image description objects define whether and when this can occur. Only such creation requests can trigger this event. This event cannot be triggered after the image description was successfully formed.

Once this event has been sent, the wp_image_description_v1 object will never become ready and it can only be destroyed.

pub fn ready(&self, identity: u32)

the object is ready to be used (32-bit)

Starting from interface version 2, the ‘ready2’ event is sent instead of this event.

For the definition of this event, see the ‘ready2’ event. The difference to this event is as follows.

The id number is valid only as long as the protocol object is alive. If all protocol objects referring to the same image description record are destroyed, the id number may be recycled for a different image description record.

pub fn ready2(&self, identity_hi: u32, identity_lo: u32)

the object is ready to be used

Once this event has been sent, the wp_image_description_v1 object is deemed “ready”. Ready objects can be used to send requests and can be used through other interfaces.

Every ready wp_image_description_v1 protocol object refers to an underlying image description record in the compositor. Multiple protocol objects may end up referring to the same record. Clients may identify these “copies” by comparing their id numbers: if the numbers from two protocol objects are identical, the protocol objects refer to the same image description record. Two different image description records cannot have the same id number simultaneously. The id number does not change during the lifetime of the image description record.

Image description id number is not a protocol object id. Zero is reserved as an invalid id number. It shall not be possible for a client to refer to an image description by its id number in protocol. The id numbers might not be portable between Wayland connections. A compositor shall not send an invalid id number.

Compositors must not recycle image description id numbers.

This identity allows clients to de-duplicate image description records and avoid get_information request if they already have the image description information.

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

type Request = Request

The request enum for this interface

type Event<'event> = 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: 'static,

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn Any + Sync + Send>>

Access the raw data associated with this object.

fn handle(&self) -> &WeakHandle

Access the backend handle associated with this object

fn from_id( conn: &DisplayHandle, id: ObjectId, ) -> Result<WpImageDescriptionV1, InvalidId>

Create an object resource from its ID

fn send_event( &self, evt: <WpImageDescriptionV1 as Resource>::Event<'_>, ) -> Result<(), InvalidId>

Send an event to this object

fn parse_request( conn: &DisplayHandle, msg: Message<ObjectId, OwnedFd>, ) -> Result<(WpImageDescriptionV1, <WpImageDescriptionV1 as Resource>::Request), DispatchError>

Parse a event for this object

fn write_event<'a>( &self, conn: &DisplayHandle, msg: <WpImageDescriptionV1 as Resource>::Event<'a>, ) -> Result<Message<ObjectId, BorrowedFd<'a>>, InvalidId>

Serialize an event for this object

fn client(&self) -> Option<Client>

The client owning this object

fn is_alive(&self) -> bool

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

fn post_error(&self, code: impl Into<u32>, error: impl Into<String>)

Trigger a protocol error on this object

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

Creates a weak handle to this object

impl Eq for WpImageDescriptionV1