Struct smithay_client_toolkit::Environment [−][src]
pub struct Environment { pub manager: GlobalManager, pub compositor: Proxy<WlCompositor>, pub subcompositor: Proxy<WlSubcompositor>, pub shell: Shell, pub shm: Proxy<WlShm>, pub data_device_manager: Proxy<WlDataDeviceManager>, pub outputs: OutputMgr, // some fields omitted }
A convenience for global management
This type provides convenience utilities for writing wayland client apps, by auto-binding a large portion of the global objects you'll likely need to write your app. This is mostly provided as a mean to factor a consequent amount of dumb, redundant code.
Fields
manager: GlobalManager
The underlying GlobalManager wrapping your registry
compositor: Proxy<WlCompositor>
The compositor global, used to create surfaces
subcompositor: Proxy<WlSubcompositor>
The subcompositor global, used to create subsurfaces
shell: Shell
The shell global, used make your surfaces into windows
This tries to bind using the xdg_shell protocol, and fallbacks to wl_shell if it fails
shm: Proxy<WlShm>
The SHM global, to create shared memory buffers
data_device_manager: Proxy<WlDataDeviceManager>
The data device manager, used to handle drag&drop and selection copy/paste
outputs: OutputMgr
A manager for handling the advertized outputs
Methods
impl Environment
[src]
impl Environment
pub fn from_registry(
registry: NewProxy<WlRegistry>,
evq: &mut EventQueue
) -> Result<Environment>
[src]
pub fn from_registry(
registry: NewProxy<WlRegistry>,
evq: &mut EventQueue
) -> Result<Environment>
Create an environment wrapping a new registry
It requires you to provide the EventQueue
as well because
the initialization process does a few roundtrip to the server
to initialize all the globals.
This may panic or fail if you do not provide the EventQueue hosting the registry you provided.
pub fn from_registry_with_cb<Impl>(
registry: NewProxy<WlRegistry>,
evq: &mut EventQueue,
cb: Impl
) -> Result<Environment> where
Impl: Implementation<Proxy<WlRegistry>, GlobalEvent> + Send + 'static,
[src]
pub fn from_registry_with_cb<Impl>(
registry: NewProxy<WlRegistry>,
evq: &mut EventQueue,
cb: Impl
) -> Result<Environment> where
Impl: Implementation<Proxy<WlRegistry>, GlobalEvent> + Send + 'static,
Create an environment wrapping a new registry
Additionnaly to from_registry
, this allows you to provide
a callback to be notified of global events, just like
GlobalManager::new_with_cb
. Note that you will still
receive events even if they are processed by this Environment
.
pub fn shm_formats(&self) -> Vec<Format>
[src]
pub fn shm_formats(&self) -> Vec<Format>
Retrive the accepted SHM formats of the server
Auto Trait Implementations
impl Send for Environment
impl Send for Environment
impl Sync for Environment
impl Sync for Environment