Struct WlSubsurface

pub struct WlSubsurface { /* private fields */ }

Available on crate feature wayland and Linux only.

sub-surface interface to a wl_surface

An additional interface to a wl_surface object, which has been made a sub-surface. A sub-surface has one parent surface. A sub-surface’s size and position are not limited to that of the parent. Particularly, a sub-surface is not automatically clipped to its parent’s area.

A sub-surface becomes mapped, when a non-NULL wl_buffer is applied and the parent surface is mapped. The order of which one happens first is irrelevant. A sub-surface is hidden if the parent becomes hidden, or if a NULL wl_buffer is applied. These rules apply recursively through the tree of surfaces.

A sub-surface can be in one of two modes. The possible modes are synchronized and desynchronized, see methods wl_subsurface.set_sync and wl_subsurface.set_desync.

The main surface can be thought to be always in desynchronized mode, since it does not have a parent in the sub-surfaces sense.

Even if a sub-surface is in desynchronized mode, it will behave as in synchronized mode, if its parent surface behaves as in synchronized mode. This rule is applied recursively throughout the tree of surfaces. This means, that one can set a sub-surface into synchronized mode, and then assume that all its child and grand-child sub-surfaces are synchronized, too, without explicitly setting them.

If a surface behaves as in synchronized mode, it is effectively synchronized, otherwise it is effectively desynchronized.

A sub-surface is initially in the synchronized mode.

The wl_subsurface interface has requests which modify double-buffered state of the parent surface (wl_subsurface.set_position, .place_above and .place_below).

Destroying a sub-surface takes effect immediately. If you need to synchronize the removal of a sub-surface to the parent surface update, unmap the sub-surface first by attaching a NULL wl_buffer, update parent, and then destroy the sub-surface.

If the parent wl_surface object is destroyed, the sub-surface is unmapped.

A sub-surface never has the keyboard focus of any seat.

The wl_surface.offset request is ignored: clients must use set_position instead to move the sub-surface.

This interface has no events.

Implementations

impl WlSubsurface

pub fn destroy(&self)

remove sub-surface interface

The sub-surface interface is removed from the wl_surface object that was turned into a sub-surface with a wl_subcompositor.get_subsurface request. The wl_surface’s association to the parent is deleted. The wl_surface is unmapped immediately.

pub fn set_position(&self, x: i32, y: i32)

reposition the sub-surface

This sets the position of the sub-surface, relative to the parent surface.

The sub-surface will be moved so that its origin (top left corner pixel) will be at the location x, y of the parent surface coordinate system. The coordinates are not restricted to the parent surface area. Negative values are allowed.

The initial position is 0, 0.

Position is double-buffered state on the parent surface, see wl_subsurface and wl_surface.commit for more information.

pub fn place_above(&self, sibling: &WlSurface)

restack the sub-surface

This sub-surface is taken from the stack, and put back just above the reference surface, changing the z-order of the sub-surfaces. The reference surface must be one of the sibling surfaces, or the parent surface. Using any other surface, including this sub-surface, will cause a protocol error.

A new sub-surface is initially added as the top-most in the stack of its siblings and parent.

Z-order is double-buffered state on the parent surface, see wl_subsurface and wl_surface.commit for more information.

pub fn place_below(&self, sibling: &WlSurface)

restack the sub-surface

The sub-surface is placed just below the reference surface.

See wl_subsurface.place_above.

pub fn set_sync(&self)

set sub-surface to synchronized mode

Change the commit behaviour of the sub-surface to synchronized mode.

See wl_subsurface and wl_surface.commit for more information.

pub fn set_desync(&self)

set sub-surface to desynchronized mode

Change the commit behaviour of the sub-surface to desynchronized mode.

See wl_subsurface and wl_surface.commit for more information.

Trait Implementations

impl Borrow<ObjectId> for WlSubsurface

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for WlSubsurface

fn clone(&self) -> WlSubsurface

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WlSubsurface

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

Formats the value using the given formatter.

impl<D> Dispatch<WlSubsurface, SubsurfaceData, D> for SubcompositorState

where D: Dispatch<WlSubsurface, SubsurfaceData>,

fn event( _: &mut D, _: &WlSubsurface, _: <WlSubsurface as Proxy>::Event, _: &SubsurfaceData, _: &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 WlSubsurface

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<WlSubsurface>> for WlSubsurface

fn eq(&self, other: &Weak<WlSubsurface>) -> 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 WlSubsurface

fn eq(&self, other: &WlSubsurface) -> 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 Proxy for WlSubsurface

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: <WlSubsurface as Proxy>::Request<'_>, ) -> Result<(), InvalidId>

Send a request for this object.

fn send_constructor<I>( &self, req: <WlSubsurface 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<WlSubsurface, InvalidId>

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> WlSubsurface

Create an inert object proxy

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

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: <WlSubsurface 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 WlSubsurface