Struct WlCompositor

pub struct WlCompositor { /* private fields */ }

Available on crate feature wayland and Linux only.

the compositor singleton

A compositor. This object is a singleton global. The compositor is in charge of combining the contents of multiple surfaces into one displayable output.

This interface has no events.

Implementations

impl WlCompositor

pub fn create_surface<U, D>(&self, qh: &QueueHandle<D>, udata: U) -> WlSurface

where U: Send + Sync + 'static, D: Dispatch<WlSurface, U> + 'static,

create new surface

Ask the compositor to create a new surface.

pub fn create_region<U, D>(&self, qh: &QueueHandle<D>, udata: U) -> WlRegion

where U: Send + Sync + 'static, D: Dispatch<WlRegion, U> + 'static,

create new region

Ask the compositor to create a new region.

pub fn release(&self)

destroy wl_compositor

This request destroys the wl_compositor. This has no effect on any other objects.

Trait Implementations

impl Borrow<ObjectId> for WlCompositor

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for WlCompositor

fn clone(&self) -> WlCompositor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WlCompositor

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

Formats the value using the given formatter.

impl<D> Dispatch<WlCompositor, GlobalData, D> for CompositorState

where D: Dispatch<WlCompositor, GlobalData> + CompositorHandler,

fn event( _: &mut D, _: &WlCompositor, _: 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 Hash for WlCompositor

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Weak<WlCompositor>> for WlCompositor

fn eq(&self, other: &Weak<WlCompositor>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for WlCompositor

fn eq(&self, other: &WlCompositor) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ProvidesBoundGlobal<WlCompositor, smithay_client_toolkit::::compositor::{impl#13}::{constant#0}> for CompositorState

fn bound_global(&self) -> Result<WlCompositor, GlobalError>

fn with_min_version(&self, version: u32) -> Result<I, GlobalError>

impl Proxy for WlCompositor

type Request<'request> = Request<'request>

The request enum for this interface

type Event = Event

The event enum for this interface

fn interface() -> &'static Interface

The interface description

fn id(&self) -> ObjectId

The ID of this object

fn version(&self) -> u32

The version of this object

fn data<U>(&self) -> Option<&U>

where U: Send + Sync + 'static,

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn ObjectData>>

Access the raw data associated with this object.

fn backend(&self) -> &WeakBackend

Access the backend associated with this object

fn send_request( &self, req: <WlCompositor as Proxy>::Request<'_>, ) -> Result<(), InvalidId>

Send a request for this object.

fn send_constructor<I>( &self, req: <WlCompositor as Proxy>::Request<'_>, data: Arc<dyn ObjectData>, ) -> Result<I, InvalidId>

where I: Proxy,

Send a request for this object that creates another object.

fn from_id(conn: &Connection, id: ObjectId) -> Result<WlCompositor, InvalidId>

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> WlCompositor

Create an inert object proxy

fn parse_event( conn: &Connection, msg: Message<ObjectId, OwnedFd>, ) -> Result<(WlCompositor, <WlCompositor as Proxy>::Event), DispatchError>

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: <WlCompositor as Proxy>::Request<'a>, ) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>

Serialize a request for this object

fn is_alive(&self) -> bool

Checks if the Wayland object associated with this proxy is still alive

fn downgrade(&self) -> Weak<Self>

Creates a weak handle to this object

impl Eq for WlCompositor