Struct wayland_protocols_wlr::layer_shell::v1::client::zwlr_layer_shell_v1::ZwlrLayerShellV1
source · pub struct ZwlrLayerShellV1 {
id: ObjectId,
version: u32,
data: Option<Arc<dyn ObjectData>>,
backend: WeakBackend,
}
Expand description
create surfaces that are layers of the desktop
Clients can use this interface to assign the surface_layer role to wl_surfaces. Such surfaces are assigned to a “layer” of the output and rendered with a defined z-depth respective to each other. They may also be anchored to the edges and corners of a screen and specify input handling semantics. This interface should be suitable for the implementation of many desktop shell components, and a broad number of other applications that interact with the desktop.
This interface has no events.
Fields§
§id: ObjectId
§version: u32
§data: Option<Arc<dyn ObjectData>>
§backend: WeakBackend
Implementations§
source§impl ZwlrLayerShellV1
impl ZwlrLayerShellV1
sourcepub fn get_layer_surface<U: Send + Sync + 'static, D: Dispatch<ZwlrLayerSurfaceV1, U> + 'static>(
&self,
surface: &WlSurface,
output: Option<&WlOutput>,
layer: Layer,
namespace: String,
qh: &QueueHandle<D>,
udata: U,
) -> ZwlrLayerSurfaceV1
pub fn get_layer_surface<U: Send + Sync + 'static, D: Dispatch<ZwlrLayerSurfaceV1, U> + 'static>( &self, surface: &WlSurface, output: Option<&WlOutput>, layer: Layer, namespace: String, qh: &QueueHandle<D>, udata: U, ) -> ZwlrLayerSurfaceV1
create a layer_surface from a surface
Create a layer surface for an existing surface. This assigns the role of layer_surface, or raises a protocol error if another role is already assigned.
Creating a layer surface from a wl_surface which has a buffer attached or committed is a client error, and any attempts by a client to attach or manipulate a buffer prior to the first layer_surface.configure call must also be treated as errors.
After creating a layer_surface object and setting it up, the client must perform an initial commit without any buffer attached. The compositor will reply with a layer_surface.configure event. The client must acknowledge it and is then allowed to attach a buffer to map the surface.
You may pass NULL for output to allow the compositor to decide which output to use. Generally this will be the one that the user most recently interacted with.
Clients can specify a namespace that defines the purpose of the layer surface.
Trait Implementations§
source§impl Borrow<ObjectId> for ZwlrLayerShellV1
impl Borrow<ObjectId> for ZwlrLayerShellV1
source§impl Clone for ZwlrLayerShellV1
impl Clone for ZwlrLayerShellV1
source§fn clone(&self) -> ZwlrLayerShellV1
fn clone(&self) -> ZwlrLayerShellV1
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ZwlrLayerShellV1
impl Debug for ZwlrLayerShellV1
source§impl Hash for ZwlrLayerShellV1
impl Hash for ZwlrLayerShellV1
source§impl PartialEq<Weak<ZwlrLayerShellV1>> for ZwlrLayerShellV1
impl PartialEq<Weak<ZwlrLayerShellV1>> for ZwlrLayerShellV1
source§impl PartialEq for ZwlrLayerShellV1
impl PartialEq for ZwlrLayerShellV1
source§fn eq(&self, other: &ZwlrLayerShellV1) -> bool
fn eq(&self, other: &ZwlrLayerShellV1) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl Proxy for ZwlrLayerShellV1
impl Proxy for ZwlrLayerShellV1
source§fn data<U: Send + Sync + 'static>(&self) -> Option<&U>
fn data<U: Send + Sync + 'static>(&self) -> Option<&U>
source§fn object_data(&self) -> Option<&Arc<dyn ObjectData>>
fn object_data(&self) -> Option<&Arc<dyn ObjectData>>
source§fn backend(&self) -> &WeakBackend
fn backend(&self) -> &WeakBackend
source§fn send_request(&self, req: Self::Request<'_>) -> Result<(), InvalidId>
fn send_request(&self, req: Self::Request<'_>) -> Result<(), InvalidId>
source§fn send_constructor<I: Proxy>(
&self,
req: Self::Request<'_>,
data: Arc<dyn ObjectData>,
) -> Result<I, InvalidId>
fn send_constructor<I: Proxy>( &self, req: Self::Request<'_>, data: Arc<dyn ObjectData>, ) -> Result<I, InvalidId>
source§fn from_id(conn: &Connection, id: ObjectId) -> Result<Self, InvalidId>
fn from_id(conn: &Connection, id: ObjectId) -> Result<Self, InvalidId>
source§fn inert(backend: WeakBackend) -> Self
fn inert(backend: WeakBackend) -> Self
source§fn parse_event(
conn: &Connection,
msg: Message<ObjectId, OwnedFd>,
) -> Result<(Self, Self::Event), DispatchError>
fn parse_event( conn: &Connection, msg: Message<ObjectId, OwnedFd>, ) -> Result<(Self, Self::Event), DispatchError>
source§fn write_request<'a>(
&self,
conn: &Connection,
msg: Self::Request<'a>,
) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>
fn write_request<'a>( &self, conn: &Connection, msg: Self::Request<'a>, ) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>
impl Eq for ZwlrLayerShellV1
Auto Trait Implementations§
impl Freeze for ZwlrLayerShellV1
impl !RefUnwindSafe for ZwlrLayerShellV1
impl Send for ZwlrLayerShellV1
impl Sync for ZwlrLayerShellV1
impl Unpin for ZwlrLayerShellV1
impl !UnwindSafe for ZwlrLayerShellV1
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.