Struct smithay_client_toolkit::output::OutputInfo

#[non_exhaustive]
pub struct OutputInfo {

    pub id: u32,
    pub model: String,
    pub make: String,
    pub location: (i32, i32),
    pub physical_size: (i32, i32),
    pub subpixel: Subpixel,
    pub transform: Transform,
    pub scale_factor: i32,
    pub modes: Vec<Mode>,
    pub logical_position: Option<(i32, i32)>,
    pub logical_size: Option<(i32, i32)>,
    pub name: Option<String>,
    pub description: Option<String>,
}

Information about an output.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: u32

The id of the output.

This corresponds to the global name of the wl_output.

model: String

The model name of this output as advertised by the server.

make: String

The make name of this output as advertised by the server.

location: (i32, i32)

Location of the top-left corner of this output in compositor space.

Note that the compositor may decide to always report (0,0) if it decides clients are not allowed to know this information.

physical_size: (i32, i32)

Physical dimensions of this output, in millimeters.

This value may be set to (0, 0) if a physical size does not make sense for the output (e.g. projectors and virtual outputs).

subpixel: Subpixel

The subpixel layout for this output.

transform: Transform

The current transformation applied to this output

You can pre-render your buffers taking this information into account and advertising it via wl_buffer.set_transform for better performance.

scale_factor: i32

The scaling factor of this output

Any buffer whose scaling factor does not match the one of the output it is displayed on will be rescaled accordingly.

For example, a buffer of scaling factor 1 will be doubled in size if the output scaling factor is 2.

You can pre-render your buffers taking this information into account and advertising it via wl_surface.set_buffer_scale so you may advertise a higher detail image.

modes: Vec<Mode>

Possible modes for an output.

logical_position: Option<(i32, i32)>

Logical position in global compositor space

logical_size: Option<(i32, i32)>

Logical size in global compositor space

name: Option<String>

The name of the this output as advertised by the surface.

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.

Compositors are not required to provide a name for the output and the value may be None.

The name will be None if the compositor does not support version 4 of the wl-output protocol or version 2 of the zxdg-output-v1 protocol.

description: Option<String>

The description of this output as advertised by the server

The description is a UTF-8 string with no convention defined for its contents. The description is not guaranteed to be unique among all wl_output globals. Examples might include ‘Foocorp 11“ Display’ or ‘Virtual X11 output via :1’.

Compositors are not required to provide a description of the output and the value may be None.

The value will be None if the compositor does not support version 4 of the wl-output protocol, version 2 of the zxdg-output-v1 protocol.

Trait Implementations

impl Clone for OutputInfo

fn clone(&self) -> OutputInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OutputInfo

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

Formats the value using the given formatter.