Struct wayland_client::protocol::wl_subcompositor::WlSubcompositor

pub struct WlSubcompositor { /* private fields */ }

sub-surface compositing

The global interface exposing sub-surface compositing capabilities. A wl_surface, that has sub-surfaces associated, is called the parent surface. Sub-surfaces can be arbitrarily nested and create a tree of sub-surfaces.

The root surface in a tree of sub-surfaces is the main surface. The main surface cannot be a sub-surface, because sub-surfaces must always have a parent.

A main surface with its sub-surfaces forms a (compound) window. For window management purposes, this set of wl_surface objects is to be considered as a single window, and it should also behave as such.

The aim of sub-surfaces is to offload some of the compositing work within a window from clients to the compositor. A prime example is a video player with decorations and video in separate wl_surface objects. This should allow the compositor to pass YUV video buffer processing to dedicated overlay hardware when possible.

This interface has no events.

Implementations

impl WlSubcompositor

pub fn destroy(&self)

unbind from the subcompositor interface

Informs the server that the client will not be using this protocol object anymore. This does not affect any other objects, wl_subsurface objects included.

pub fn get_subsurface<U: Send + Sync + 'static, D: Dispatch<WlSubsurface, U> + 'static>(
    &self,
    surface: &WlSurface,
    parent: &WlSurface,
    qh: &QueueHandle<D>,
    udata: U
) -> Result<WlSubsurface, InvalidId>

give a surface the role sub-surface

Create a sub-surface interface for the given surface, and associate it with the given parent surface. This turns a plain wl_surface into a sub-surface.

The to-be sub-surface must not already have another role, and it must not have an existing wl_subsurface object. Otherwise a protocol error is raised.

Adding sub-surfaces to a parent is a double-buffered operation on the parent (see wl_surface.commit). The effect of adding a sub-surface becomes visible on the next time the state of the parent surface is applied.

This request modifies the behaviour of wl_surface.commit request on the sub-surface, see the documentation on wl_subsurface interface.

Trait Implementations

impl Clone for WlSubcompositor

fn clone(&self) -> WlSubcompositor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WlSubcompositor

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

Formats the value using the given formatter.

impl PartialEq<WlSubcompositor> for WlSubcompositor

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Proxy for WlSubcompositor

type 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

he ID of this object

fn version(&self) -> u32

The version of this object

fn data<U: Send + Sync + 'static>(&self) -> Option<&U>

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: Self::Request) -> Result<(), InvalidId>

Send a request for this object.

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

Send a request for this object that creates another object.

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

Create an object proxy from its ID

fn parse_event(
    conn: &Connection,
    msg: Message<ObjectId>
) -> Result<(Self, Self::Event), DispatchError>

Parse a event for this object

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

Serialize a request for this object

impl Eq for WlSubcompositor