Struct WlSubsurface 

pub struct WlSubsurface { /* private fields */ }

A wl_subsurface object.

See the documentation of the module for the interface description.

Implementations

impl WlSubsurface

pub fn set_handler(&self, handler: impl WlSubsurfaceHandler)

Sets a new handler.

pub fn set_boxed_handler(&self, handler: Box<dyn WlSubsurfaceHandler>)

Sets a new, already boxed handler.

impl WlSubsurface

pub const MSG__DESTROY__SINCE: u32 = 1

Since when the destroy message is available.

pub const MSG__SET_POSITION__SINCE: u32 = 1

Since when the set_position message is available.

pub const MSG__PLACE_ABOVE__SINCE: u32 = 1

Since when the place_above message is available.

pub const MSG__PLACE_BELOW__SINCE: u32 = 1

Since when the place_below message is available.

pub const MSG__SET_SYNC__SINCE: u32 = 1

Since when the set_sync message is available.

pub const MSG__SET_DESYNC__SINCE: u32 = 1

Since when the set_desync message is available.

pub fn try_send_destroy(&self) -> Result<(), ObjectError>

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 send_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 try_send_set_position(&self, x: i32, y: i32) -> Result<(), ObjectError>

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.

Arguments

• x: x coordinate in the parent surface
• y: y coordinate in the parent surface

pub fn send_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.

Arguments

• x: x coordinate in the parent surface
• y: y coordinate in the parent surface

pub fn try_send_place_above( &self, sibling: &Rc<WlSurface>, ) -> Result<(), ObjectError>

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.

Arguments

• sibling: the reference surface

pub fn send_place_above(&self, sibling: &Rc<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.

Arguments

• sibling: the reference surface

pub fn try_send_place_below( &self, sibling: &Rc<WlSurface>, ) -> Result<(), ObjectError>

restack the sub-surface

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

See wl_subsurface.place_above.

Arguments

• sibling: the reference surface

pub fn send_place_below(&self, sibling: &Rc<WlSurface>)

restack the sub-surface

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

See wl_subsurface.place_above.

Arguments

• sibling: the reference surface

pub fn try_send_set_sync(&self) -> Result<(), ObjectError>

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 send_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 try_send_set_desync(&self) -> Result<(), ObjectError>

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.

pub fn send_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.

impl WlSubsurface

pub const ENM__ERROR_BAD_SURFACE__SINCE: u32 = 1

Since when the error.bad_surface enum variant is available.

Trait Implementations

impl ConcreteObject for WlSubsurface

const XML_VERSION: u32 = 1

The interface version from the XML file that the interface was generated from.

const INTERFACE: ObjectInterface = ObjectInterface::WlSubsurface

The interface of the object.

const INTERFACE_NAME: &str = "wl_subsurface"

The interface of the object as a string.

impl Debug for WlSubsurface

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

Formats the value using the given formatter.

impl Object for WlSubsurface

fn core(&self) -> &ObjectCore

Returns the ObjectCore of this object.

fn unset_handler(&self)

Unsets the handler of this object.

fn get_handler_any_ref( &self, ) -> Result<HandlerRef<'_, dyn Any>, HandlerAccessError>

Returns a shared reference to the handler.

fn get_handler_any_mut( &self, ) -> Result<HandlerMut<'_, dyn Any>, HandlerAccessError>

Returns a mutable reference to the handler.