Struct KdeExternalBrightnessDeviceV1

pub struct KdeExternalBrightnessDeviceV1 { /* private fields */ }

brightness control device

After creating this object, the client should issue all relevant setup requests (set_internal, set_edid, set_max_brightness, optionally set_observed_brightness) and finish the sequence with commit. Afterwards, for each change in values, the client must call commit again.

See also the Event enum for this interface.

Implementations

impl KdeExternalBrightnessDeviceV1

pub fn destroy(&self)

destroy the object and unregister the brightness control device

pub fn set_internal(&self, internal: u32)

sets whether or not the brightness device belongs to an internal display

pub fn set_edid(&self, string: String)

set the EDID data for identification of the display

pub fn set_max_brightness(&self, value: u32)

notifies the compositor of the maximum brightness that can be set on this device

pub fn commit(&self)

notifies the compositor that all relevant identifiers and values have been sent

pub fn set_observed_brightness(&self, value: u32)

notifies the compositor of the brightness that was read from this device

The client can set this to notify the compositor of the device’s initial brightness. It can also set this again after the initial commit to notify the compositor that the brightness level has changed due to external factors. The compositor is free to use or ignore this value as it sees fit.

Trait Implementations

impl Borrow<ObjectId> for KdeExternalBrightnessDeviceV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for KdeExternalBrightnessDeviceV1

fn clone(&self) -> KdeExternalBrightnessDeviceV1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KdeExternalBrightnessDeviceV1

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

Formats the value using the given formatter.

impl Hash for KdeExternalBrightnessDeviceV1

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

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

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

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 KdeExternalBrightnessDeviceV1