Enum wayland_client::protocol::wl_subcompositor::Request

#[non_exhaustive]
pub enum Request {
    Destroy,
    GetSubsurface {
        surface: WlSurface,
        parent: WlSurface,
    },
}

Variants (Non-exhaustive)

[+] This enum is marked as non-exhaustive

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Destroy

[−] Expand description

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.

This is a destructor, once sent this object cannot be used any longer.

GetSubsurface

[−] Expand description

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.

[−] Show fields

Fields of GetSubsurface

surface: WlSurfaceparent: WlSurface

Trait Implementations

impl Debug for Request[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl MessageGroup for Request[+]

[+] Show hidden undocumented items

const MESSAGES: &'static [MessageDesc][−][−]

Wire representation of this MessageGroup

type Map = ProxyMap

The wrapper type for ObjectMap allowing the mapping of Object and NewId arguments to the object map during parsing.

fn is_destructor(&self) -> bool[−]

Whether this message is a destructor

fn opcode(&self) -> u16[−]

The opcode of this message

fn since(&self) -> u32[−]

The minimal object version for which this message exists

fn child<Meta: ObjectMetadata>(
    opcode: u16,
    version: u32,
    meta: &Meta
) -> Option<Object<Meta>>[−]

Retrieve the child Object associated with this message if any

fn from_raw(msg: Message, map: &mut Self::Map) -> Result<Self, ()>[−]

Construct a message from its raw representation

fn into_raw(self, sender_id: u32) -> Message[−]

Turn this message into its raw representation

unsafe fn from_raw_c(
    obj: *mut c_void,
    opcode: u32,
    args: *const wl_argument
) -> Result<Request, ()>[−]

Construct a message of this group from its C representation

fn as_raw_c_in<F, T>(self, f: F) -> T where
    F: FnOnce(u32, &mut [wl_argument]) -> T, [−]

Build a C representation of this message