Struct KdeOutputConfigurationV2

pub struct KdeOutputConfigurationV2 { /* private fields */ }

configure single output devices

outputconfiguration is a client-specific resource that can be used to ask the server to apply changes to available output devices.

The client receives a list of output devices from the registry. When it wants to apply new settings, it creates a configuration object from the outputmanagement global, writes changes through this object’s enable, scale, transform and mode calls. It then asks the server to apply these settings in an atomic fashion, for example through Linux’ DRM interface.

The server signals back whether the new settings have applied successfully or failed to apply. outputdevice objects are updated after the changes have been applied to the hardware and before the server side sends the applied event.

See also the Event enum for this interface.

Implementations

impl KdeOutputConfigurationV2

pub fn enable(&self, outputdevice: &KdeOutputDeviceV2, enable: i32)

enable or disable an output

Mark the output as enabled or disabled.

pub fn mode( &self, outputdevice: &KdeOutputDeviceV2, mode: &KdeOutputDeviceModeV2, )

switch output-device to mode

Sets the mode for a given output.

pub fn transform(&self, outputdevice: &KdeOutputDeviceV2, transform: i32)

transform output-device

Sets the transformation for a given output.

pub fn position(&self, outputdevice: &KdeOutputDeviceV2, x: i32, y: i32)

position output in global space

Sets the position for this output device. (x,y) describe the top-left corner of the output in global space, whereby the origin (0,0) of the global space has to be aligned with the top-left corner of the most left and in case this does not define a single one the top output.

There may be no gaps or overlaps between outputs, i.e. the outputs are stacked horizontally, vertically, or both on each other.

pub fn scale(&self, outputdevice: &KdeOutputDeviceV2, scale: f64)

set scaling factor of this output

Sets the scaling factor for this output device.

pub fn apply(&self)

apply configuration changes to all output devices

Asks the server to apply property changes requested through this outputconfiguration object to all outputs on the server side.

The output configuration can be applied only once. The already_applied protocol error will be posted if the apply request is called the second time.

pub fn destroy(&self)

release the outputconfiguration object

pub fn overscan(&self, outputdevice: &KdeOutputDeviceV2, overscan: u32)

set overscan value

Set the overscan value of this output device with a value in percent.

pub fn set_vrr_policy( &self, outputdevice: &KdeOutputDeviceV2, policy: VrrPolicy, )

set the VRR policy

Set what policy the compositor should employ regarding its use of variable refresh rate.

pub fn set_rgb_range( &self, outputdevice: &KdeOutputDeviceV2, rgb_range: RgbRange, )

RGB range

Whether full or limited color range should be used

pub fn set_primary_output(&self, output: &KdeOutputDeviceV2)

Select which primary output to use

pub fn set_priority(&self, outputdevice: &KdeOutputDeviceV2, priority: u32)

Set the order of outputs

The order of outputs can be used to assign desktop environment components to a specific screen, see kde_output_order_v1 for details. The priority is 1-based for outputs that will be enabled after this changeset is applied, all outputs that are disabled need to have the index set to zero.

pub fn set_high_dynamic_range( &self, outputdevice: &KdeOutputDeviceV2, enable_hdr: u32, )

change if HDR should be enabled

Sets whether or not the output should be set to HDR mode.

pub fn set_sdr_brightness( &self, outputdevice: &KdeOutputDeviceV2, sdr_brightness: u32, )

set the brightness for sdr content

Sets the brightness of standard dynamic range content in nits. Only has an effect while the output is in HDR mode. Note that while the value is in nits, that doesn’t necessarily translate to the same brightness on the screen.

pub fn set_wide_color_gamut( &self, outputdevice: &KdeOutputDeviceV2, enable_wcg: u32, )

change if a wide color gamut should be used

Whether or not the output should use a wide color gamut

pub fn set_auto_rotate_policy( &self, outputdevice: &KdeOutputDeviceV2, policy: AutoRotatePolicy, )

change when auto rotate should be used

pub fn set_icc_profile_path( &self, outputdevice: &KdeOutputDeviceV2, profile_path: String, )

change the used icc profile

pub fn set_brightness_overrides( &self, outputdevice: &KdeOutputDeviceV2, max_peak_brightness: i32, max_frame_average_brightness: i32, min_brightness: i32, )

override metadata about the screen’s brightness limits

pub fn set_sdr_gamut_wideness( &self, outputdevice: &KdeOutputDeviceV2, gamut_wideness: u32, )

describes which gamut is assumed for sRGB applications

This can be used to provide the colors users assume sRGB applications should have based on the default experience on many modern sRGB screens.

pub fn set_color_profile_source( &self, outputdevice: &KdeOutputDeviceV2, color_profile_source: ColorProfileSource, )

which source the compositor should use for the color profile on an output

pub fn set_brightness(&self, outputdevice: &KdeOutputDeviceV2, brightness: u32)

brightness multiplier

Set the brightness modifier of the output. It doesn’t specify any absolute values, but is merely a multiplier on top of other brightness values, like sdr_brightness and brightness_metadata. 0 is the minimum brightness (not completely dark) and 10000 is the maximum brightness. This is supported while HDR is active in versions 8 and below, or when the device supports the brightness_control capability in versions 9 and above.

pub fn set_color_power_tradeoff( &self, outputdevice: &KdeOutputDeviceV2, preference: ColorPowerTradeoff, )

set the preferred color/power tradeoff

pub fn set_dimming(&self, outputdevice: &KdeOutputDeviceV2, multiplier: u32)

dimming multiplier

Set the dimming multiplier of the output. This is similar to the brightness setting, except it’s meant to be a temporary setting only, not persistent and may be implemented differently depending on the display. 0 is the minimum dimming factor (not completely dark) and 10000 means the output is not dimmed.

This is supported only when the brightness_control capability is also supported.

Trait Implementations

impl Borrow<ObjectId> for KdeOutputConfigurationV2

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for KdeOutputConfigurationV2

fn clone(&self) -> KdeOutputConfigurationV2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KdeOutputConfigurationV2

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

Formats the value using the given formatter.

impl Hash for KdeOutputConfigurationV2

fn hash<H: Hasher>(&self, state: &mut H)

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

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

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

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: Send + Sync + 'static>(&self) -> Option<&U>

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

Send a request for this object.

fn send_constructor<I: Proxy>( &self, req: Self::Request<'_>, data: Arc<dyn ObjectData>, ) -> Result<I, InvalidId>

Send a request for this object that creates another object.

fn from_id(conn: &Connection, id: ObjectId) -> Result<Self, InvalidId>

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> Self

Create an inert object proxy

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

Parse a event for this object

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