Struct wayland_protocols::xwayland::shell::v1::client::xwayland_surface_v1::XwaylandSurfaceV1

pub struct XwaylandSurfaceV1 { /* private fields */ }

Available on crate features staging and client only.

interface for associating Xwayland windows to wl_surfaces

An Xwayland surface is a surface managed by an Xwayland server. It is used for associating surfaces to Xwayland windows.

The Xwayland server associated with actions in this interface is determined by the Wayland client making the request.

The client must call wl_surface.commit on the corresponding wl_surface for the xwayland_surface_v1 state to take effect.

This interface has no events.

Implementations

impl XwaylandSurfaceV1

pub fn set_serial(&self, serial_lo: u32, serial_hi: u32)

associates a Xwayland window to a wl_surface

Associates an Xwayland window to a wl_surface. The association state is double-buffered and will be applied at the time wl_surface.commit of the corresponding wl_surface is called.

The serial_lo and serial_hi parameters specify a non-zero monotonic serial number which is entirely unique and provided by the Xwayland server equal to the serial value provided by a client message with a message type of the WL_SURFACE_SERIAL atom on the X11 window for this surface to be associated to.

The serial value in the WL_SURFACE_SERIAL client message is specified as having the lo-bits specified in l[0] and the hi-bits specified in l[1].

If the serial value provided by serial_lo and serial_hi is not valid, the invalid_serial protocol error will be raised.

An X11 window may be associated with multiple surfaces throughout its lifespan. (eg. unmapping and remapping a window).

For each wl_surface, this state must not be committed more than once, otherwise the already_associated protocol error will be raised.

pub fn destroy(&self)

destroy the Xwayland surface object

Destroy the xwayland_surface_v1 object.

Any already existing associations are unaffected by this action.

Trait Implementations

impl Borrow<ObjectId> for XwaylandSurfaceV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for XwaylandSurfaceV1

fn clone(&self) -> XwaylandSurfaceV1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for XwaylandSurfaceV1

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

Formats the value using the given formatter.

impl Hash for XwaylandSurfaceV1

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

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

fn eq(&self, other: &Weak<XwaylandSurfaceV1>) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<XwaylandSurfaceV1> for XwaylandSurfaceV1

fn eq(&self, other: &XwaylandSurfaceV1) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Proxy for XwaylandSurfaceV1

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

The 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 inert(backend: WeakBackend) -> Self

Create an inert object proxy

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

Parse a event for this object

fn write_request( &self, conn: &Connection, msg: Self::Request ) -> Result<(Message<ObjectId, RawFd>, 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 XwaylandSurfaceV1