Enum Request

#[non_exhaustive]
pub enum Request {
    Create {
        image_description: New<WpImageDescriptionV1>,
    },
    SetIccFile {
        icc_profile: OwnedFd,
        offset: u32,
        length: u32,
    },
}

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.

Create

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.

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

Fields

image_description: New<WpImageDescriptionV1>

SetIccFile

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.

Fields

icc_profile: OwnedFd

ICC profile

offset: u32

byte offset in fd to start of ICC data

length: u32

length of ICC data in bytes

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.