Struct WpColorManagerV1

pub struct WpColorManagerV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

color manager singleton

A singleton global interface used for getting color management extensions for wl_surface and wl_output objects, and for creating client defined image description objects. The extension interfaces allow getting the image description of outputs and setting the image description of surfaces.

Compositors should never remove this global.

See also the Event enum for this interface.

Implementations

impl WpColorManagerV1

pub fn destroy(&self)

destroy the color manager

Destroy the wp_color_manager_v1 object. This does not affect any other objects in any way.

pub fn get_output<U, D>( &self, output: &WlOutput, qh: &QueueHandle<D>, udata: U, ) -> WpColorManagementOutputV1

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

create a color management interface for a wl_output

This creates a new wp_color_management_output_v1 object for the given wl_output.

See the wp_color_management_output_v1 interface for more details.

pub fn get_surface<U, D>( &self, surface: &WlSurface, qh: &QueueHandle<D>, udata: U, ) -> WpColorManagementSurfaceV1

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

create a color management interface for a wl_surface

If a wp_color_management_surface_v1 object already exists for the given wl_surface, the protocol error surface_exists is raised.

This creates a new color wp_color_management_surface_v1 object for the given wl_surface.

See the wp_color_management_surface_v1 interface for more details.

pub fn get_surface_feedback<U, D>( &self, surface: &WlSurface, qh: &QueueHandle<D>, udata: U, ) -> WpColorManagementSurfaceFeedbackV1

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

create a color management feedback interface

This creates a new color wp_color_management_surface_feedback_v1 object for the given wl_surface.

See the wp_color_management_surface_feedback_v1 interface for more details.

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

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

make a new ICC-based image description creator object

Makes a new ICC-based image description creator object with all properties initially unset. The client can then use the object’s interface to define all the required properties for an image description and finally create a wp_image_description_v1 object.

This request can be used when the compositor advertises wp_color_manager_v1.feature.icc_v2_v4. Otherwise this request raises the protocol error unsupported_feature.

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

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

make a new parametric image description creator object

Makes a new parametric image description creator object with all properties initially unset. The client can then use the object’s interface to define all the required properties for an image description and finally create a wp_image_description_v1 object.

This request can be used when the compositor advertises wp_color_manager_v1.feature.parametric. Otherwise this request raises the protocol error unsupported_feature.

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

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

create Windows-scRGB image description object

This creates a pre-defined image description for the so-called Windows-scRGB stimulus encoding. This comes from the Windows 10 handling of its own definition of an scRGB color space for an HDR screen driven in BT.2100/PQ signalling mode.

Windows-scRGB uses sRGB (BT.709) color primaries and white point. The transfer characteristic is extended linear.

The nominal color channel value range is extended, meaning it includes negative and greater than 1.0 values. Negative values are used to escape the sRGB color gamut boundaries. To make use of the extended range, the client needs to use a pixel format that can represent those values, e.g. floating-point 16 bits per channel.

Nominal color value R=G=B=0.0 corresponds to BT.2100/PQ system 0 cd/m², and R=G=B=1.0 corresponds to BT.2100/PQ system 80 cd/m². The maximum is R=G=B=125.0 corresponding to 10k cd/m².

Windows-scRGB is displayed by Windows 10 by converting it to BT.2100/PQ, maintaining the CIE 1931 chromaticity and mapping the luminance as above. No adjustment is made to the signal to account for the viewing conditions.

The reference white level of Windows-scRGB is unknown. If a reference white level must be assumed for compositor processing, it should be R=G=B=2.5375 corresponding to 203 cd/m² of Report ITU-R BT.2408-7.

The target color volume of Windows-scRGB is unknown. The color gamut may be anything between sRGB and BT.2100.

Note: EGL_EXT_gl_colorspace_scrgb_linear definition differs from Windows-scRGB by using R=G=B=1.0 as the reference white level, while Windows-scRGB reference white level is unknown or varies. However, it seems probable that Windows implements both EGL_EXT_gl_colorspace_scrgb_linear and Vulkan VK_COLOR_SPACE_EXTENDED_SRGB_LINEAR_EXT as Windows-scRGB.

This request can be used when the compositor advertises wp_color_manager_v1.feature.windows_scrgb. Otherwise this request raises the protocol error unsupported_feature.

The resulting image description object does not allow get_information request. The wp_image_description_v1.ready event shall be sent.

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

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

create an image description from a reference

This request retrieves the image description backing a reference.

The get_information request can be used if and only if the request that creates the reference allows it.

Trait Implementations

impl Borrow<ObjectId> for WpColorManagerV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for WpColorManagerV1

fn clone(&self) -> WpColorManagerV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WpColorManagerV1

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

Formats the value using the given formatter.

impl Hash for WpColorManagerV1

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

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

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

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

Send a request for this object.

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

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> WpColorManagerV1

Create an inert object proxy

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

Parse a event for this object

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