Struct smithay_client_toolkit::shell::xdg::XdgShellSurface

pub struct XdgShellSurface {
    xdg_surface: XdgSurface,
    surface: Surface,
}

A surface role for functionality common in desktop-like surfaces.

Fields

xdg_surface: XdgSurface

surface: Surface

Implementations

impl XdgShellSurface

pub fn new<U, D>( wm_base: &impl ProvidesBoundGlobal<XdgWmBase, { XdgShell::API_VERSION_MAX }>, qh: &QueueHandle<D>, surface: impl Into<Surface>, udata: U, ) -> Result<XdgShellSurface, GlobalError>

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

Creates an XdgShellSurface.

This function is generally intended to be called in a higher level abstraction, such as XdgShell::create_window.

The created XdgShellSurface will destroy the underlying XdgSurface or WlSurface when dropped. Higher level abstractions are responsible for ensuring the destruction order of protocol objects is correct. Since this function consumes the WlSurface, it may be accessed using XdgShellSurface::wl_surface.

Protocol errors

If the surface already has a role object, the compositor will raise a protocol error.

A surface is considered to have a role object if some other type of surface was created using the surface. For example, creating a window, popup, layer, subsurface or some other type of surface object all assign a role object to a surface.

pub fn xdg_surface(&self) -> &XdgSurface

pub fn wl_surface(&self) -> &WlSurface

Trait Implementations

impl Debug for XdgShellSurface

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

Formats the value using the given formatter.

impl Drop for XdgShellSurface

fn drop(&mut self)

Executes the destructor for this type.

impl WaylandSurface for XdgShellSurface

fn wl_surface(&self) -> &WlSurface

The underlying WlSurface.

fn attach(&self, buffer: Option<&WlBuffer>, x: u32, y: u32)

fn set_opaque_region(&self, region: Option<&WlRegion>)

fn set_input_region(&self, region: Option<&WlRegion>)

fn set_buffer_transform(&self, transform: Transform) -> Result<(), Unsupported>

fn set_buffer_scale(&self, scale: u32) -> Result<(), Unsupported>

fn offset(&self, x: u32, y: u32) -> Result<(), Unsupported>

fn commit(&self)

Commits pending surface state.

impl XdgSurface for XdgShellSurface

fn xdg_surface(&self) -> &XdgSurface

The underlying XdgSurface.

fn set_window_geometry(&self, x: u32, y: u32, width: u32, height: u32)