Struct WpImageDescriptionCreatorParamsV1

pub struct WpImageDescriptionCreatorParamsV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

holder of image description parameters

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

• transfer characteristic function (tf)
• chromaticities of primaries and white point (primary color volume)

The following properties are optional and have a well-defined default if not explicitly set:

• primary color volume luminance range
• reference white luminance level
• mastering display primaries and white point (target color volume)
• mastering luminance range

The following properties are optional and will be ignored if not explicitly set:

• maximum content light level
• maximum frame-average light level

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.

A viewer, who is viewing the display defined by the resulting image description (the viewing environment included), is assumed to be fully adapted to the primary color volume’s white point.

Any of the following conditions will cause the colorimetry of a pixel to become undefined:

• Values outside of the defined range of the transfer characteristic.
• Tristimulus that exceeds the target color volume.
• If extended_target_volume is not supported: tristimulus that exceeds the primary color volume.

The closest correspondence to an image description created through this interface is the Display class of profiles in ICC.

See also the Request enum for this interface.

Trait Implementations

impl Borrow<ObjectId> for WpImageDescriptionCreatorParamsV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for WpImageDescriptionCreatorParamsV1

fn clone(&self) -> WpImageDescriptionCreatorParamsV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WpImageDescriptionCreatorParamsV1

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

Formats the value using the given formatter.

impl Hash for WpImageDescriptionCreatorParamsV1

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

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

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

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<WpImageDescriptionCreatorParamsV1, InvalidId>

Create an object resource from its ID

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

Send an event to this object

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

Parse a event for this object

fn write_event<'a>( &self, conn: &DisplayHandle, msg: <WpImageDescriptionCreatorParamsV1 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 WpImageDescriptionCreatorParamsV1