Struct WpImageDescriptionCreatorIccV1

pub struct WpImageDescriptionCreatorIccV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

holder of image description ICC information

This type of object is used for collecting all the information required to create a wp_image_description_v1 object from an ICC file. A complete set of required parameters consists of these properties:

• ICC file

Each required property must be set exactly once if the client is to create an image description. The set requests verify that a property was not already set. The create request verifies that all required properties are set. There may be several alternative requests for setting each property, and in that case the client must choose one of them.

Once all properties have been set, the create request must be used to create the image description object, destroying the creator in the process.

The link between a pixel value (a device value in ICC) and its respective colorimetry is defined by the details of the particular ICC profile. Those details also determine when colorimetry becomes undefined.

This interface has no events.

Implementations

impl WpImageDescriptionCreatorIccV1

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

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

Create the image description object from ICC data

Create an image description object based on the ICC information previously set on this object. A compositor must parse the ICC data in some undefined but finite amount of time.

The completeness of the parameter set is verified. If the set is not complete, the protocol error incomplete_set is raised. For the definition of a complete set, see the description of this interface.

If the particular combination of the information is not supported by the compositor, the resulting image description object shall immediately deliver the wp_image_description_v1.failed event with the ‘unsupported’ cause. If a valid image description was created from the information, the wp_image_description_v1.ready event will eventually be sent instead.

This request destroys the wp_image_description_creator_icc_v1 object.

The resulting image description object does not allow get_information request.

pub fn set_icc_file( &self, icc_profile: BorrowedFd<'_>, offset: u32, length: u32, )

set the ICC profile file

Sets the ICC profile file to be used as the basis of the image description.

The data shall be found through the given fd at the given offset, having the given length. The fd must be seekable and readable. Violating these requirements raises the bad_fd protocol error.

If reading the data fails due to an error independent of the client, the compositor shall send the wp_image_description_v1.failed event on the created wp_image_description_v1 with the ‘operating_system’ cause.

The maximum size of the ICC profile is 32 MB. If length is greater than that or zero, the protocol error bad_size is raised. If offset + length exceeds the file size, the protocol error out_of_file is raised.

A compositor may read the file at any time starting from this request and only until whichever happens first:

• If create request was issued, the wp_image_description_v1 object delivers either failed or ready event; or
• if create request was not issued, this wp_image_description_creator_icc_v1 object is destroyed.

A compositor shall not modify the contents of the file, and the fd may be sealed for writes and size changes. The client must ensure to its best ability that the data does not change while the compositor is reading it.

The data must represent a valid ICC profile. The ICC profile version must be 2 or 4, it must be a 3 channel profile and the class must be Display or ColorSpace. Violating these requirements will not result in a protocol error, but will eventually send the wp_image_description_v1.failed event on the created wp_image_description_v1 with the ‘unsupported’ cause.

See the International Color Consortium specification ICC.1:2022 for more details about ICC profiles.

If ICC file has already been set on this object, the protocol error already_set is raised.

Trait Implementations

impl Borrow<ObjectId> for WpImageDescriptionCreatorIccV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for WpImageDescriptionCreatorIccV1

fn clone(&self) -> WpImageDescriptionCreatorIccV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WpImageDescriptionCreatorIccV1

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

Formats the value using the given formatter.

impl Hash for WpImageDescriptionCreatorIccV1

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

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

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

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

Send a request for this object.

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

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> WpImageDescriptionCreatorIccV1

Create an inert object proxy

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

Parse a event for this object

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