Struct wayland_protocols::wlr::unstable::output_management::v1::server::zwlr_output_head_v1::ZwlrOutputHeadV1

pub struct ZwlrOutputHeadV1(_);

Implementations

impl ZwlrOutputHeadV1

pub fn name(&self, name: String)

head name

This event describes the head name.

The naming convention is compositor defined, but limited to alphanumeric characters and dashes (-). Each name is unique among all wlr_output_head objects, but if a wlr_output_head object is destroyed the same name may be reused later. The names will also remain consistent across sessions with the same hardware and software configuration.

Examples of names include 'HDMI-A-1', 'WL-1', 'X11-1', etc. However, do not assume that the name is a reflection of an underlying DRM connector, X11 connection, etc.

If the compositor implements the xdg-output protocol and this head is enabled, the xdg_output.name event must report the same name.

The name event is sent after a wlr_output_head object is created. This event is only sent once per object, and the name does not change over the lifetime of the wlr_output_head object.

pub fn description(&self, description: String)

head description

This event describes a human-readable description of the head.

The description is a UTF-8 string with no convention defined for its contents. Examples might include 'Foocorp 11" Display' or 'Virtual X11 output via :1'. However, do not assume that the name is a reflection of the make, model, serial of the underlying DRM connector or the display name of the underlying X11 connection, etc.

If the compositor implements xdg-output and this head is enabled, the xdg_output.description must report the same description.

The description event is sent after a wlr_output_head object is created. This event is only sent once per object, and the description does not change over the lifetime of the wlr_output_head object.

pub fn physical_size(&self, width: i32, height: i32)

head physical size

This event describes the physical size of the head. This event is only sent if the head has a physical size (e.g. is not a projector or a virtual device).

pub fn mode(&self, mode: &ZwlrOutputModeV1)

introduce a mode

This event introduces a mode for this head. It is sent once per supported mode.

pub fn enabled(&self, enabled: i32)

head is enabled or disabled

This event describes whether the head is enabled. A disabled head is not mapped to a region of the global compositor space.

When a head is disabled, some properties (current_mode, position, transform and scale) are irrelevant.

pub fn current_mode(&self, mode: &ZwlrOutputModeV1)

current mode

This event describes the mode currently in use for this head. It is only sent if the output is enabled.

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

current position

This events describes the position of the head in the global compositor space. It is only sent if the output is enabled.

pub fn transform(&self, transform: Transform)

current transformation

This event describes the transformation currently applied to the head. It is only sent if the output is enabled.

pub fn scale(&self, scale: f64)

current scale

This events describes the scale of the head in the global compositor space. It is only sent if the output is enabled.

pub fn finished(&self)

the head has been destroyed

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.

pub fn make(&self, make: String)

head manufacturer

This event describes the manufacturer of the head.

This must report the same make as the wl_output interface does in its geometry event.

Together with the model and serial_number events the purpose is to allow clients to recognize heads from previous sessions and for example load head-specific configurations back.

It is not guaranteed this event will be ever sent. A reason for that can be that the compositor does not have information about the make of the head or the definition of a make is not sensible in the current setup, for example in a virtual session. Clients can still try to identify the head by available information from other events but should be aware that there is an increased risk of false positives.

It is not recommended to display the make string in UI to users. For that the string provided by the description event should be preferred.

Only available since version 2 of the interface.

pub fn model(&self, model: String)

head model

This event describes the model of the head.

This must report the same model as the wl_output interface does in its geometry event.

Together with the make and serial_number events the purpose is to allow clients to recognize heads from previous sessions and for example load head-specific configurations back.

It is not guaranteed this event will be ever sent. A reason for that can be that the compositor does not have information about the model of the head or the definition of a model is not sensible in the current setup, for example in a virtual session. Clients can still try to identify the head by available information from other events but should be aware that there is an increased risk of false positives.

It is not recommended to display the model string in UI to users. For that the string provided by the description event should be preferred.

Only available since version 2 of the interface.

pub fn serial_number(&self, serial_number: String)

head serial number

This event describes the serial number of the head.

Together with the make and model events the purpose is to allow clients to recognize heads from previous sessions and for example load head- specific configurations back.

It is not guaranteed this event will be ever sent. A reason for that can be that the compositor does not have information about the serial number of the head or the definition of a serial number is not sensible in the current setup. Clients can still try to identify the head by available information from other events but should be aware that there is an increased risk of false positives.

It is not recommended to display the serial_number string in UI to users. For that the string provided by the description event should be preferred.

Only available since version 2 of the interface.

Trait Implementations

impl AsRef<Resource<ZwlrOutputHeadV1>> for ZwlrOutputHeadV1

fn as_ref(&self) -> &Resource<Self>

Performs the conversion.

impl Clone for ZwlrOutputHeadV1

fn clone(&self) -> ZwlrOutputHeadV1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ZwlrOutputHeadV1

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

Formats the value using the given formatter.

impl Eq for ZwlrOutputHeadV1

impl From<Resource<ZwlrOutputHeadV1>> for ZwlrOutputHeadV1

fn from(value: Resource<Self>) -> Self

Performs the conversion.

impl From<ZwlrOutputHeadV1> for Resource<ZwlrOutputHeadV1>

fn from(value: ZwlrOutputHeadV1) -> Self

Performs the conversion.

impl Interface for ZwlrOutputHeadV1

type Request = Request

Set of requests associated to this interface

type Event = Event

Set of events associated to this interface

const NAME: &'static str

Name of this interface

const VERSION: u32

Maximum supported version of this interface

fn c_interface() -> *const wl_interface

Pointer to the C representation of this interface

impl PartialEq<ZwlrOutputHeadV1> for ZwlrOutputHeadV1

fn eq(&self, other: &ZwlrOutputHeadV1) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ZwlrOutputHeadV1) -> bool

This method tests for !=.

impl StructuralEq for ZwlrOutputHeadV1

impl StructuralPartialEq for ZwlrOutputHeadV1