Struct smithay_client_toolkit::output::OutputState

pub struct OutputState { /* private fields */ }

A handler for delegating wl_output::WlOutput.

When implementing ProvidesRegistryState, registry_handlers! may be used to delegate all output events to an instance of this type. It will internally store the internal state of all outputs and allow querying them via the OutputState::outputs and OutputState::info methods.

Example

use smithay_client_toolkit::output::{OutputHandler,OutputState};
use smithay_client_toolkit::registry::{ProvidesRegistryState,RegistryHandler};
use smithay_client_toolkit::{registry_handlers,delegate_output, delegate_registry};
use wayland_client::{Connection,QueueHandle,protocol::wl_output};

struct ExampleState {
    // The state is usually kept as an attribute of the application state.
    output_state: OutputState,
}

// When using `OutputState`, an implementation of `OutputHandler` should be supplied:
impl OutputHandler for ExampleState {
     // Custom implementation handling output events here ...
}

// Delegating to the registry is required to use `OutputState`.
delegate_registry!(ExampleState);
delegate_output!(ExampleState);

impl ProvidesRegistryState for ExampleState {
    // ...

    registry_handlers!(OutputState);
}

Implementations

impl OutputState

pub fn new<D: Dispatch<WlOutput, OutputData> + Dispatch<ZxdgOutputV1, OutputData> + Dispatch<ZxdgOutputManagerV1, GlobalData> + 'static>( global_list: &GlobalList, qh: &QueueHandle<D> ) -> OutputState

pub fn outputs(&self) -> impl Iterator<Item = WlOutput>

Returns an iterator over all outputs.

pub fn info(&self, output: &WlOutput) -> Option<OutputInfo>

Returns information about an output.

This may be none if the output has been destroyed or the compositor has not sent information about the output yet.

pub fn add_scale_watcher<F, D>(data: &mut D, f: F) -> ScaleWatcherHandle

where D: OutputHandler + 'static, F: Fn(&mut D, &Connection, &QueueHandle<D>, &WlOutput) + Send + Sync + 'static,

Trait Implementations

impl Debug for OutputState

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

Formats the value using the given formatter.

impl<D> Dispatch<WlOutput, OutputData, D> for OutputState

where D: Dispatch<WlOutput, OutputData> + OutputHandler + 'static,

fn event( state: &mut D, output: &WlOutput, event: Event, data: &OutputData, conn: &Connection, qh: &QueueHandle<D> )

Called when an event from the server is processed

fn event_created_child( opcode: u16, _qhandle: &QueueHandle<State> ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl<D> Dispatch<ZxdgOutputManagerV1, GlobalData, D> for OutputState

where D: Dispatch<ZxdgOutputManagerV1, GlobalData> + OutputHandler,

fn event( _: &mut D, _: &ZxdgOutputManagerV1, _: Event, _: &GlobalData, _: &Connection, _: &QueueHandle<D> )

Called when an event from the server is processed

fn event_created_child( opcode: u16, _qhandle: &QueueHandle<State> ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl<D> Dispatch<ZxdgOutputV1, OutputData, D> for OutputState

where D: Dispatch<ZxdgOutputV1, OutputData> + OutputHandler,

fn event( state: &mut D, output: &ZxdgOutputV1, event: Event, data: &OutputData, conn: &Connection, qh: &QueueHandle<D> )

Called when an event from the server is processed

fn event_created_child( opcode: u16, _qhandle: &QueueHandle<State> ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl<D> RegistryHandler<D> for OutputState

where D: Dispatch<WlOutput, OutputData> + Dispatch<ZxdgOutputV1, OutputData> + Dispatch<ZxdgOutputManagerV1, GlobalData> + OutputHandler + ProvidesRegistryState + 'static,

fn new_global( data: &mut D, _: &Connection, qh: &QueueHandle<D>, name: u32, interface: &str, _version: u32 )

Called when a new global has been advertised by the compositor.

fn remove_global( data: &mut D, conn: &Connection, qh: &QueueHandle<D>, name: u32, interface: &str )

Called when a global has been destroyed by the compositor.