Struct wayland_client::wayland::WlDisplay

pub struct WlDisplay {
    // some fields omitted
}

core global object

The core global object. This is a special singleton object. It is used for internal Wayland protocol features.

Methods

impl WlDisplay

fn sync(&self) -> WlCallback

asynchronous roundtrip

The sync request asks the server to emit the 'done' event on the returned wl_callback object. Since requests are handled in-order and events are delivered in-order, this can be used as a barrier to ensure all previous requests and the resulting events have been handled.

The object returned by this request will be destroyed by the compositor after the callback is fired and as such the client must not attempt to use it after that point.

The callback_data passed in the callback is the event serial.

fn get_registry(&self) -> WlRegistry

get global registry object

This request creates a registry object that allows the client to list and bind the global objects available from the compositor.

impl WlDisplay

fn flush(&self) -> Result<i32>

Non-blocking write to the server

Will write as many pending requests as possible to the server socket. Never blocks: if not all requests coul be written, will return an io error WouldBlock.

On success returns the number of written requests.

fn create_event_iterator(&self) -> EventIterator

Create a new EventIterator

No object is by default attached to it.

Trait Implementations

impl Sync for WlDisplay

impl Send for WlDisplay

impl Proxy for WlDisplay

fn ptr(&self) -> *mut wl_proxy

fn interface() -> *mut wl_interface

fn interface_name() -> &'static str

The internal name of this interface, as advertized by the registry if it is a global.

fn version() -> u32

The maximum version of this interface handled by the library.

fn id(&self) -> ProxyId

Get the id of this proxy

fn set_event_iterator(&mut self, evt: &EventIterator)

Set the event iterator associated to this proxy

impl Debug for WlDisplay

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

Formats the value using the given formatter.

impl Drop for WlDisplay

fn drop(&mut self)

A method called when the value goes out of scope.