Struct smithay::wayland::output::Output

pub struct Output { /* fields omitted */ }

An output as seen by the clients

This handle is stored in the event loop, and allows you to notify clients about any change in the properties of this output.

Implementations

impl Output

pub fn new<L>(
    display: &mut Display,
    name: String,
    physical: PhysicalProperties,
    logger: L
) -> (Output, Global<WlOutput>) where
    L: Into<Option<Logger>>, 

Create a new output global with given name and physical properties

The global is directly registered into the event loop, and this function returns the state token allowing you to access it, as well as the global handle, in case you wish to remove this global in the future.

pub fn from_resource(output: &WlOutput) -> Option<Output>

Attempt to retrieve a Output from an existing resource

pub fn set_preferred(&self, mode: Mode)

Sets the preferred mode of this output

If the provided mode was not previously known to this output, it is added to its internal list.

pub fn add_mode(&self, mode: Mode)

Adds a mode to the list of known modes to this output

pub fn delete_mode(&self, mode: Mode)

Removes a mode from the list of known modes

It will not de-advertise it from existing clients (the protocol does not allow it), but it won’t be advertised to now clients from now on.

pub fn change_current_state(
    &self,
    new_mode: Option<Mode>,
    new_transform: Option<Transform>,
    new_scale: Option<i32>,
    new_location: Option<Point<i32, Logical>>
)

Change the current state of this output

You can changed the current mode, transform status, location or scale of this output. Providing None to any of these field means that the value does not change.

If the provided mode was not previously known to this output, it is added to its internal list.

By default, transform status is Normal, and scale is 1.

pub fn owns(&self, output: &WlOutput) -> bool

Check is given wl_output instance is managed by this Output.

pub fn with_client_outputs<F>(&self, client: Client, f: F) where
    F: FnMut(&WlOutput), 

This function allows to run a FnMut on every WlOutput matching the same Client as provided

pub fn enter(&self, surface: &WlSurface)

Sends wl_surface.enter for the provided surface with the matching client output

pub fn leave(&self, surface: &WlSurface)

Sends wl_surface.leave for the provided surface with the matching client output

Trait Implementations

impl Debug for Output

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

Formats the value using the given formatter.