Struct wayland_server::protocol::wl_output::WlOutput

pub struct WlOutput { /* fields omitted */ }

Methods

impl WlOutput

fn geometry(
    &self,
    x: i32,
    y: i32,
    physical_width: i32,
    physical_height: i32,
    subpixel: Subpixel,
    make: String,
    model: String,
    transform: Transform
) -> EventResult<()>

properties of the output

The geometry event describes geometric properties of the output. The event is sent when binding to the output object and whenever any of the properties change.

fn mode(
    &self,
    flags: Mode,
    width: i32,
    height: i32,
    refresh: i32
) -> EventResult<()>

advertise available modes for the output

The mode event describes an available mode for the output.

The event is sent when binding to the output object and there will always be one mode, the current mode. The event is sent again if an output changes mode, for the mode that is now current. In other words, the current mode is always the last mode that was received with the current flag set.

The size of a mode is given in physical hardware units of the output device. This is not necessarily the same as the output size in the global compositor space. For instance, the output may be scaled, as described in wl_output.scale, or transformed, as described in wl_output.transform.

fn done(&self) -> EventResult<()>

sent all information about output

This event is sent after all other properties have been sent after binding to the output object and after any other property changes done after that. This allows changes to the output properties to be seen as atomic, even if they happen via multiple events.

This event is only available since version 2 of the interface

fn scale(&self, factor: i32) -> EventResult<()>

output scaling properties

This event contains scaling geometry information that is not in the geometry event. It may be sent after binding the output object or if the output scale changes later. If it is not sent, the client should assume a scale of 1.

A scale larger than 1 means that the compositor will automatically scale surface buffers by this amount when rendering. This is used for very high resolution displays where applications rendering at the native resolution would be too small to be legible.

It is intended that scaling aware clients track the current output of a surface, and if it is on a scaled output it should use wl_surface.set_buffer_scale with the scale of the output. That way the compositor can avoid scaling the surface, and the client can supply a higher detail image.

This event is only available since version 2 of the interface

Trait Implementations

impl Send for WlOutput

impl Sync for WlOutput

impl Resource for WlOutput

fn ptr(&self) -> *mut wl_resource

Pointer to the underlying wayland proxy object

unsafe fn from_ptr_new(ptr: *mut wl_resource) -> WlOutput

Create an instance from a wayland pointer

unsafe fn from_ptr_initialized(ptr: *mut wl_resource) -> WlOutput

Create an instance from a wayland pointer

fn interface_ptr() -> *const wl_interface

Pointer to the interface representation

fn interface_name() -> &'static str

Internal wayland name of this interface

fn supported_version() -> u32

Max version of this interface supported

fn version(&self) -> i32

Current version of the interface this resource is instantiated with

fn status(&self) -> Liveness

Check if the resource behind this handle is actually still alive

fn equals(&self, other: &WlOutput) -> bool

Check of two handles are actually the same wayland object

fn set_user_data(&self, ptr: *mut ())

Set a pointer associated as user data on this resource

fn get_user_data(&self) -> *mut ()

Get the pointer associated as user data on this resource

unsafe fn clone_unchecked(&self) -> WlOutput

Unsafely clone this resource handle

fn post_error(&self, error_code: u32, msg: String)

Posts a protocol error to this resource

fn clone(&self) -> Option<Self> where
    Self: Sized, 

Clone this resource handle

fn same_client_as<R: Resource>(&self, other: &R) -> bool

Checks wether this resource and the other are from the same client

impl<ID: 'static> Implementable<ID> for WlOutput

type Implementation = Implementation<ID>

The type containing the implementation for the event callbacks

unsafe fn __dispatch_msg(
    &self,
    client: &Client,
    opcode: u32,
    args: *const wl_argument
) -> Result<(), ()>