Struct ZwlrOutputManagerV1

pub struct ZwlrOutputManagerV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

output device configuration manager

This interface is a manager that allows reading and writing the current output device configuration.

Output devices that display pixels (e.g. a physical monitor or a virtual output in a window) are represented as heads. Heads cannot be created nor destroyed by the client, but they can be enabled or disabled and their properties can be changed. Each head may have one or more available modes.

Whenever a head appears (e.g. a monitor is plugged in), it will be advertised via the head event. Immediately after the output manager is bound, all current heads are advertised.

Whenever a head’s properties change, the relevant wlr_output_head events will be sent. Not all head properties will be sent: only properties that have changed need to.

Whenever a head disappears (e.g. a monitor is unplugged), a wlr_output_head.finished event will be sent.

After one or more heads appear, change or disappear, the done event will be sent. It carries a serial which can be used in a create_configuration request to update heads properties.

The information obtained from this protocol should only be used for output configuration purposes. This protocol is not designed to be a generic output property advertisement protocol for regular clients. Instead, protocols such as xdg-output should be used.

See also the Request enum for this interface.

Implementations

impl ZwlrOutputManagerV1

pub fn head(&self, head: &ZwlrOutputHeadV1)

introduce a new head

This event introduces a new head. This happens whenever a new head appears (e.g. a monitor is plugged in) or after the output manager is bound.

pub fn done(&self, serial: u32)

sent all information about current configuration

This event is sent after all information has been sent after binding to the output manager object and after any subsequent changes. This applies to child head and mode objects as well. In other words, this event is sent whenever a head or mode is created or destroyed and whenever one of their properties has been changed. Not all state is re-sent each time the current configuration changes: only the actual changes are sent.

This allows changes to the output configuration to be seen as atomic, even if they happen via multiple events.

A serial is sent to be used in a future create_configuration request.

pub fn finished(&self)

the compositor has finished with the manager

This event indicates that the compositor is done sending manager events. The compositor will destroy the object immediately after sending this event, so it will become invalid and the client should release any resources associated with it.

Trait Implementations

impl Borrow<ObjectId> for ZwlrOutputManagerV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ZwlrOutputManagerV1

fn clone(&self) -> ZwlrOutputManagerV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZwlrOutputManagerV1

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

Formats the value using the given formatter.

impl Hash for ZwlrOutputManagerV1

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

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

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

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

Create an object resource from its ID

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

Send an event to this object

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

Parse a event for this object

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