wayland-client-0.31.8/.cargo_vcs_info.json0000644000000001540000000000100140400ustar { "git": { "sha1": "48b04f19ecf747104533f536ddf626e561346d19" }, "path_in_vcs": "wayland-client" }wayland-client-0.31.8/CHANGELOG.md000064400000000000000000000062771046102023000144550ustar 00000000000000# CHANGELOG: wayland-client ## Unreleased ## 0.31.7 -- 2024-10-23 - Updated Wayland core protocol to 1.23 ## 0.31.2 -- 2024-01-29 #### Additions - Implement `Eq` for `Connection` #### Bugfixes - Fix a possible deadlock in `EventQueue::blocking_dispatch()` ## 0.31.1 -- 2023-09-19 #### Additions - Implement `AsFd` for `Connection` and `EventQueue` so they can easily be used in a `calloop` source. ## 0.31.0 -- 2023-09-02 #### Breaking changes - Bump bitflags to 2.0 - Updated wayland-backend to 0.3 - Calloop integration is now removed, to avoid tying wayland-client to it you can use the `calloop-wayland-source` crate instead - Use `BorrowedFd<'_>` arguments instead of `RawFd` ## 0.30.2 -- 30/05/2023 - Updated Wayland core protocol to 1.22 ## 0.30.1 -- 04/02/2023 #### Bugfixes - Fix compilation without the `log` feature. ## 0.30.0 -- 27/12/2022 ## 0.30.0-beta.14 #### Additions - Introduce `WaylandSource`, an adapter to insert an `EventQueue` into a calloop `EventLoop`, hidden under the new `calloop` cargo feature ## 0.30.0-beta.11 #### Bugfixes - `Weak::upgrade` now checks if the object has been destroyed ## 0.30.0-beta.10 #### Additions - Support absolute paths in `WAYLAND_DISPLAY` - Introduce `Weak`, a helper type to store proxies without risking reference cycles - Introduce `Proxy::is_alive()` method checking if the protocol object referenced by a proxy is still alive in the protocol state. #### Bugfixes - Fix `EventQueue::blocking_dispatch()` not flushing the connection as it should - Ensure that `XDG_RUNTIME_DIR` is an absolute path before trying to use it ## 0.30.0-beta.9 #### Breaking changes - Requests that create new objects now produce inert proxies when called on objects with invalid IDs instead of failing with `InvalidId`. This matches the behavior of non-object-creating requests (which also ignore the error). - `Connection::blocking_dispatch` has been removed; use `EventQueue::blocking_dispatch`. #### Additions - `QueueFreezeGuard` for avoiding race conditions while constructing objects. ## 0.30.0-beta.8 #### Breaking changes - `Connection::null_id()` has been removed, instead use `ObjectId::null()`. - `EventQueue::sync_roundtrip()` has been renamed to `EventQueue::roundtrip()`. - Module `globals` has been removed as the abstractions it provide are not deemed useful. - The trait `DelegateDispatch` as been removed, its functionnality being fused into a more generic version of the `Dispatch` trait. #### Additions - Introduce the `log` cargo feature to control logging behavior ## 0.30.0-beta.6 - Introduce `EventQueue::poll_dispatch_pending` for running dispatch using an async runtime. ## 0.30.0-beta.1 #### Breaking changes - Large rework of the API as a consequence of the rework of the backend. ## 0.30.0-alpha10 - Introduce conversion methods between `wayland_backend::Handle` and `ConnectionHandle` ## 0.30.0-alpha2 #### Breaking changes - The `DelegateDispatch` mechanism is changed around an explicit trait-base extraction of module state from the main app state. ## 0.30.0-alpha1 Full rework of the crate, which is now organized around a trait-based `Dispatch` metchanism. This can effectively be considered a new crate altogether. wayland-client-0.31.8/Cargo.lock0000644000000244500000000000100120200ustar # This file is automatically @generated by Cargo. # It is not intended for manual editing. version = 3 [[package]] name = "autocfg" version = "1.4.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "ace50bade8e6234aa140d9a2f552bbee1db4d353f69b8217bc503490fc1a9f26" [[package]] name = "bitflags" version = "2.8.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "8f68f53c83ab957f72c32642f3868eec03eb974d1fb82e453128456482613d36" [[package]] name = "cc" version = "1.2.10" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "13208fcbb66eaeffe09b99fffbe1af420f00a7b35aa99ad683dfc1aa76145229" dependencies = [ "shlex", ] [[package]] name = "cfg-if" version = "1.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" [[package]] name = "downcast-rs" version = "1.2.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "75b325c5dbd37f80359721ad39aca5a29fb04c89279657cffdda8736d0c0b9d2" [[package]] name = "errno" version = "0.3.10" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "33d852cb9b869c2a9b3df2f71a3074817f01e1844f839a144f5fcef059a4eb5d" dependencies = [ "libc", "windows-sys", ] [[package]] name = "fastrand" version = "2.3.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "37909eebbb50d72f9059c3b6d82c0463f2ff062c9e95845c43a6c9c0355411be" [[package]] name = "futures-channel" version = "0.3.31" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "2dff15bf788c671c1934e366d07e30c1814a8ef514e1af724a602e8a2fbe1b10" dependencies = [ "futures-core", ] [[package]] name = "futures-core" version = "0.3.31" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "05f29059c0c2090612e8d742178b0580d2dc940c837851ad723096f87af6663e" [[package]] name = "futures-macro" version = "0.3.31" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "162ee34ebcb7c64a8abebc059ce0fee27c2262618d7b60ed8faf72fef13c3650" dependencies = [ "proc-macro2", "quote", "syn", ] [[package]] name = "futures-task" version = "0.3.31" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "f90f7dce0722e95104fcb095585910c0977252f286e354b5e3bd38902cd99988" [[package]] name = "futures-util" version = "0.3.31" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9fa08315bb612088cc391249efdc3bc77536f16c91f6cf495e6fbe85b20a4a81" dependencies = [ "futures-core", "futures-macro", "futures-task", "pin-project-lite", "pin-utils", "slab", ] [[package]] name = "getrandom" version = "0.3.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "43a49c392881ce6d5c3b8cb70f98717b7c07aabbdff06687b9030dbfbe2725f8" dependencies = [ "cfg-if", "libc", "wasi", "windows-targets", ] [[package]] name = "libc" version = "0.2.169" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "b5aba8db14291edd000dfcc4d620c7ebfb122c613afb886ca8803fa4e128a20a" [[package]] name = "linux-raw-sys" version = "0.4.15" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "d26c52dbd32dccf2d10cac7725f8eae5296885fb5703b261f7d0a0739ec807ab" [[package]] name = "log" version = "0.4.25" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "04cbf5b083de1c7e0222a7a51dbfdba1cbe1c6ab0b15e29fff3f6c077fd9cd9f" [[package]] name = "memchr" version = "2.7.4" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "78ca9ab1a0babb1e7d5695e3530886289c18cf2f87ec19a575a0abdce112e3a3" [[package]] name = "once_cell" version = "1.20.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "1261fe7e33c73b354eab43b1273a57c8f967d0391e80353e51f764ac02cf6775" [[package]] name = "pin-project-lite" version = "0.2.16" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "3b3cff922bd51709b605d9ead9aa71031d81447142d828eb4a6eba76fe619f9b" [[package]] name = "pin-utils" version = "0.1.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "8b870d8c151b6f2fb93e84a13146138f05d02ed11c7e7c54f8826aaaf7c9f184" [[package]] name = "pkg-config" version = "0.3.31" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "953ec861398dccce10c670dfeaf3ec4911ca479e9c02154b3a215178c5f566f2" [[package]] name = "proc-macro2" version = "1.0.93" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "60946a68e5f9d28b0dc1c21bb8a97ee7d018a8b322fa57838ba31cc878e22d99" dependencies = [ "unicode-ident", ] [[package]] name = "quick-xml" version = "0.37.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "165859e9e55f79d67b96c5d96f4e88b6f2695a1972849c15a6a3f5c59fc2c003" dependencies = [ "memchr", ] [[package]] name = "quote" version = "1.0.38" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "0e4dccaaaf89514f546c693ddc140f729f958c247918a13380cccc6078391acc" dependencies = [ "proc-macro2", ] [[package]] name = "rustix" version = "0.38.44" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "fdb5bc1ae2baa591800df16c9ca78619bf65c0488b41b96ccec5d11220d8c154" dependencies = [ "bitflags", "errno", "libc", "linux-raw-sys", "windows-sys", ] [[package]] name = "shlex" version = "1.3.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64" [[package]] name = "slab" version = "0.4.9" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "8f92a496fb766b417c996b9c5e57daf2f7ad3b0bebe1ccfca4856390e3d3bb67" dependencies = [ "autocfg", ] [[package]] name = "smallvec" version = "1.13.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "3c5e1a9a646d36c3599cd173a41282daf47c44583ad367b8e6837255952e5c67" [[package]] name = "syn" version = "2.0.96" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "d5d0adab1ae378d7f53bdebc67a39f1f151407ef230f0ce2883572f5d8985c80" dependencies = [ "proc-macro2", "quote", "unicode-ident", ] [[package]] name = "tempfile" version = "3.16.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "38c246215d7d24f48ae091a2902398798e05d978b24315d6efbc00ede9a8bb91" dependencies = [ "cfg-if", "fastrand", "getrandom", "once_cell", "rustix", "windows-sys", ] [[package]] name = "unicode-ident" version = "1.0.16" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "a210d160f08b701c8721ba1c726c11662f877ea6b7094007e1ca9a1041945034" [[package]] name = "wasi" version = "0.13.3+wasi-0.2.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "26816d2e1a4a36a2940b96c5296ce403917633dff8f3440e9b236ed6f6bacad2" dependencies = [ "wit-bindgen-rt", ] [[package]] name = "wayland-backend" version = "0.3.8" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "b7208998eaa3870dad37ec8836979581506e0c5c64c20c9e79e9d2a10d6f47bf" dependencies = [ "cc", "downcast-rs", "rustix", "smallvec", "wayland-sys", ] [[package]] name = "wayland-client" version = "0.31.8" dependencies = [ "bitflags", "futures-channel", "futures-util", "log", "rustix", "tempfile", "wayland-backend", "wayland-scanner", ] [[package]] name = "wayland-scanner" version = "0.31.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "896fdafd5d28145fce7958917d69f2fd44469b1d4e861cb5961bcbeebc6d1484" dependencies = [ "proc-macro2", "quick-xml", "quote", ] [[package]] name = "wayland-sys" version = "0.31.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "dbcebb399c77d5aa9fa5db874806ee7b4eba4e73650948e8f93963f128896615" dependencies = [ "pkg-config", ] [[package]] name = "windows-sys" version = "0.59.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "1e38bc4d79ed67fd075bcc251a1c39b32a1776bbe92e5bef1f0bf1f8c531853b" dependencies = [ "windows-targets", ] [[package]] name = "windows-targets" version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973" dependencies = [ "windows_aarch64_gnullvm", "windows_aarch64_msvc", "windows_i686_gnu", "windows_i686_gnullvm", "windows_i686_msvc", "windows_x86_64_gnu", "windows_x86_64_gnullvm", "windows_x86_64_msvc", ] [[package]] name = "windows_aarch64_gnullvm" version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3" [[package]] name = "windows_aarch64_msvc" version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469" [[package]] name = "windows_i686_gnu" version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b" [[package]] name = "windows_i686_gnullvm" version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66" [[package]] name = "windows_i686_msvc" version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66" [[package]] name = "windows_x86_64_gnu" version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78" [[package]] name = "windows_x86_64_gnullvm" version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d" [[package]] name = "windows_x86_64_msvc" version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec" [[package]] name = "wit-bindgen-rt" version = "0.33.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "3268f3d866458b787f390cf61f4bbb563b922d091359f9608842999eaee3943c" dependencies = [ "bitflags", ] wayland-client-0.31.8/Cargo.toml0000644000000034470000000000100120460ustar # THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies. # # If you are reading this file be aware that the original Cargo.toml # will likely look very different (and much more reasonable). # See Cargo.toml.orig for the original contents. [package] edition = "2021" rust-version = "1.65" name = "wayland-client" version = "0.31.8" authors = ["Elinor Berger "] build = "build.rs" autolib = false autobins = false autoexamples = false autotests = false autobenches = false description = "Bindings to the standard C implementation of the wayland protocol, client side." documentation = "https://docs.rs/wayland-client/" readme = "README.md" keywords = [ "wayland", "client", ] categories = [ "gui", "api-bindings", ] license = "MIT" repository = "https://github.com/smithay/wayland-rs" [package.metadata.docs.rs] all-features = true rustdoc-args = [ "--cfg", "docsrs", ] [lib] name = "wayland_client" path = "src/lib.rs" [[example]] name = "list_globals" path = "examples/list_globals.rs" [[example]] name = "list_globals_no_dispatch" path = "examples/list_globals_no_dispatch.rs" [[example]] name = "simple_window" path = "examples/simple_window.rs" [dependencies.bitflags] version = "2" [dependencies.log] version = "0.4" optional = true [dependencies.rustix] version = "0.38.0" features = ["event"] [dependencies.wayland-backend] version = "0.3.8" [dependencies.wayland-scanner] version = "0.31.6" [dev-dependencies.futures-channel] version = "0.3.16" [dev-dependencies.futures-util] version = "0.3" [dev-dependencies.tempfile] version = "3.2" wayland-client-0.31.8/Cargo.toml.orig000064400000000000000000000017011046102023000155160ustar 00000000000000[package] name = "wayland-client" version = "0.31.8" documentation = "https://docs.rs/wayland-client/" repository = "https://github.com/smithay/wayland-rs" authors = ["Elinor Berger "] license = "MIT" edition = "2021" rust-version = "1.65" categories = ["gui", "api-bindings"] keywords = ["wayland", "client"] description = "Bindings to the standard C implementation of the wayland protocol, client side." readme = "README.md" [dependencies] wayland-backend = { version = "0.3.8", path = "../wayland-backend" } wayland-scanner = { version = "0.31.6", path = "../wayland-scanner" } bitflags = "2" rustix = { version = "0.38.0", features = ["event"] } log = { version = "0.4", optional = true } [dev-dependencies] wayland-protocols = { path = "../wayland-protocols", features = ["client"] } futures-channel = "0.3.16" futures-util = "0.3" tempfile = "3.2" [package.metadata.docs.rs] all-features = true rustdoc-args = ["--cfg", "docsrs"] wayland-client-0.31.8/LICENSE.txt000064400000000000000000000020411046102023000144500ustar 00000000000000Copyright (c) 2015 Elinor Berger Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. wayland-client-0.31.8/README.md000064400000000000000000000023461046102023000141140ustar 00000000000000[![crates.io](https://img.shields.io/crates/v/wayland-client.svg)](https://crates.io/crates/wayland-client) [![docs.rs](https://docs.rs/wayland-client/badge.svg)](https://docs.rs/wayland-client) [![Continuous Integration](https://github.com/Smithay/wayland-rs/workflows/Continuous%20Integration/badge.svg)](https://github.com/Smithay/wayland-rs/actions?query=workflow%3A%22Continuous+Integration%22) [![codecov](https://codecov.io/gh/Smithay/wayland-rs/branch/master/graph/badge.svg)](https://codecov.io/gh/Smithay/wayland-rs) # wayland-client Client side API for the Wayland protocol. This crate provides infrastructure for manipulating Wayland objects, as well as object definitions for the core Wayland protocol. Protocol extensions can be supported as well by combining this crate with `wayland-protocols`, which provides object definitions for a large set of extensions. See the [crate-level documentation](https://docs.rs/wayland-client) for usage explanations. **Note:** This crate is a low-level interface to the Wayland protocol. If you are looking for a more battery-included toolkit for writing a Wayland client app, you may consider [Smithay's Client Toolkit](https://crates.io/crates/smithay-client-toolkit), which is built on top of it.wayland-client-0.31.8/build.rs000064400000000000000000000001031046102023000142670ustar 00000000000000fn main() { println!("cargo:rustc-check-cfg=cfg(coverage)"); } wayland-client-0.31.8/examples/list_globals.rs000064400000000000000000000065141046102023000175000ustar 00000000000000use wayland_client::{protocol::wl_registry, Connection, Dispatch, QueueHandle}; // This struct represents the state of our app. This simple app does not // need any state, by this type still supports the `Dispatch` implementations. struct AppData; // Implement `Dispatch for out state. This provides the logic // to be able to process events for the wl_registry interface. // // The second type parameter is the user-data of our implementation. It is a // mechanism that allows you to associate a value to each particular Wayland // object, and allow different dispatching logic depending on the type of the // associated value. // // In this example, we just use () as we don't have any value to associate. See // the `Dispatch` documentation for more details about this. impl Dispatch for AppData { fn event( _: &mut Self, _: &wl_registry::WlRegistry, event: wl_registry::Event, _: &(), _: &Connection, _: &QueueHandle, ) { // When receiving events from the wl_registry, we are only interested in the // `global` event, which signals a new available global. // When receiving this event, we just print its characteristics in this example. if let wl_registry::Event::Global { name, interface, version } = event { println!("[{}] {} (v{})", name, interface, version); } } } // The main function of our program fn main() { // Create a Wayland connection by connecting to the server through the // environment-provided configuration. let conn = Connection::connect_to_env().unwrap(); // Retrieve the WlDisplay Wayland object from the connection. This object is // the starting point of any Wayland program, from which all other objects will // be created. let display = conn.display(); // Create an event queue for our event processing let mut event_queue = conn.new_event_queue(); // And get its handle to associated new objects to it let qh = event_queue.handle(); // Create a wl_registry object by sending the wl_display.get_registry request // This method takes two arguments: a handle to the queue the newly created // wl_registry will be assigned to, and the user-data that should be associated // with this registry (here it is () as we don't need user-data). let _registry = display.get_registry(&qh, ()); // At this point everything is ready, and we just need to wait to receive the events // from the wl_registry, our callback will print the advertized globals. println!("Advertized globals:"); // To actually receive the events, we invoke the `sync_roundtrip` method. This method // is special and you will generally only invoke it during the setup of your program: // it will block until the server has received and processed all the messages you've // sent up to now. // // In our case, that means it'll block until the server has received our // wl_display.get_registry request, and as a reaction has sent us a batch of // wl_registry.global events. // // `sync_roundtrip` will then empty the internal buffer of the queue it has been invoked // on, and thus invoke our `Dispatch` implementation that prints the list of advertized // globals. event_queue.roundtrip(&mut AppData).unwrap(); } wayland-client-0.31.8/examples/list_globals_no_dispatch.rs000064400000000000000000000046301046102023000220500ustar 00000000000000use std::os::fd::OwnedFd; use std::sync::Arc; use wayland_client::{ backend::{self, Backend}, protocol::{wl_display, wl_registry}, Connection, Proxy, }; // This struct represents the data associated with our registry. struct RegistryData(Arc); // Instead of implementing Dispatch on some global state, we will implement // ObjectData for our registry. This is required to receive events // (specifically, the wl_registry.global events) after our wl_registry.get_registry request. impl backend::ObjectData for RegistryData { fn event( self: Arc, _: &Backend, msg: backend::protocol::Message, ) -> Option> { // Here, we parse the wire message into an event using Proxy::parse_event. let (_registry, event) = wl_registry::WlRegistry::parse_event(&self.0, msg).unwrap(); // Similar to the dispatch example, we only care about the global event and // will print out the received globals. if let wl_registry::Event::Global { name, interface, version } = event { println!("[{}] {} (v{})", name, interface, version); } None } // This method is called whenever the object is destroyed. In the case of our registry, // however, there is no way to destroy it, so we will mark it as unreachable. fn destroyed(&self, _: wayland_backend::client::ObjectId) { unreachable!(); } } fn main() { // Create our connection like the Dispatch example, except we store it in an Arc // to share with our registry object data. let conn = Arc::new(Connection::connect_to_env().unwrap()); let display = conn.display(); let registry_data = Arc::new(RegistryData(conn.clone())); // Send the `wl_display.get_registry` request, which returns a `wl_registry` to us. // Since this request creates a new object, we will use the `Proxy::send_constructor` method // to send it. If it didn't, we would use `Proxy::send_request`. let _registry: wl_registry::WlRegistry = display .send_constructor(wl_display::Request::GetRegistry {}, registry_data.clone()) .unwrap(); println!("Advertised globals:"); // Invoke our roundtrip to receive the events. This essentially is the same as the // `EventQueue::roundtrip` method, except it does not have a state to dispatch methods on. conn.roundtrip().unwrap(); } wayland-client-0.31.8/examples/simple_window.rs000064400000000000000000000161501046102023000176770ustar 00000000000000use std::{fs::File, os::unix::io::AsFd}; use wayland_client::{ delegate_noop, protocol::{ wl_buffer, wl_compositor, wl_keyboard, wl_registry, wl_seat, wl_shm, wl_shm_pool, wl_surface, }, Connection, Dispatch, QueueHandle, WEnum, }; use wayland_protocols::xdg::shell::client::{xdg_surface, xdg_toplevel, xdg_wm_base}; fn main() { let conn = Connection::connect_to_env().unwrap(); let mut event_queue = conn.new_event_queue(); let qhandle = event_queue.handle(); let display = conn.display(); display.get_registry(&qhandle, ()); let mut state = State { running: true, base_surface: None, buffer: None, wm_base: None, xdg_surface: None, configured: false, }; println!("Starting the example window app, press to quit."); while state.running { event_queue.blocking_dispatch(&mut state).unwrap(); } } struct State { running: bool, base_surface: Option, buffer: Option, wm_base: Option, xdg_surface: Option<(xdg_surface::XdgSurface, xdg_toplevel::XdgToplevel)>, configured: bool, } impl Dispatch for State { fn event( state: &mut Self, registry: &wl_registry::WlRegistry, event: wl_registry::Event, _: &(), _: &Connection, qh: &QueueHandle, ) { if let wl_registry::Event::Global { name, interface, .. } = event { match &interface[..] { "wl_compositor" => { let compositor = registry.bind::(name, 1, qh, ()); let surface = compositor.create_surface(qh, ()); state.base_surface = Some(surface); if state.wm_base.is_some() && state.xdg_surface.is_none() { state.init_xdg_surface(qh); } } "wl_shm" => { let shm = registry.bind::(name, 1, qh, ()); let (init_w, init_h) = (320, 240); let mut file = tempfile::tempfile().unwrap(); draw(&mut file, (init_w, init_h)); let pool = shm.create_pool(file.as_fd(), (init_w * init_h * 4) as i32, qh, ()); let buffer = pool.create_buffer( 0, init_w as i32, init_h as i32, (init_w * 4) as i32, wl_shm::Format::Argb8888, qh, (), ); state.buffer = Some(buffer.clone()); if state.configured { let surface = state.base_surface.as_ref().unwrap(); surface.attach(Some(&buffer), 0, 0); surface.commit(); } } "wl_seat" => { registry.bind::(name, 1, qh, ()); } "xdg_wm_base" => { let wm_base = registry.bind::(name, 1, qh, ()); state.wm_base = Some(wm_base); if state.base_surface.is_some() && state.xdg_surface.is_none() { state.init_xdg_surface(qh); } } _ => {} } } } } // Ignore events from these object types in this example. delegate_noop!(State: ignore wl_compositor::WlCompositor); delegate_noop!(State: ignore wl_surface::WlSurface); delegate_noop!(State: ignore wl_shm::WlShm); delegate_noop!(State: ignore wl_shm_pool::WlShmPool); delegate_noop!(State: ignore wl_buffer::WlBuffer); fn draw(tmp: &mut File, (buf_x, buf_y): (u32, u32)) { use std::{cmp::min, io::Write}; let mut buf = std::io::BufWriter::new(tmp); for y in 0..buf_y { for x in 0..buf_x { let a = 0xFF; let r = min(((buf_x - x) * 0xFF) / buf_x, ((buf_y - y) * 0xFF) / buf_y); let g = min((x * 0xFF) / buf_x, ((buf_y - y) * 0xFF) / buf_y); let b = min(((buf_x - x) * 0xFF) / buf_x, (y * 0xFF) / buf_y); buf.write_all(&[b as u8, g as u8, r as u8, a as u8]).unwrap(); } } buf.flush().unwrap(); } impl State { fn init_xdg_surface(&mut self, qh: &QueueHandle) { let wm_base = self.wm_base.as_ref().unwrap(); let base_surface = self.base_surface.as_ref().unwrap(); let xdg_surface = wm_base.get_xdg_surface(base_surface, qh, ()); let toplevel = xdg_surface.get_toplevel(qh, ()); toplevel.set_title("A fantastic window!".into()); base_surface.commit(); self.xdg_surface = Some((xdg_surface, toplevel)); } } impl Dispatch for State { fn event( _: &mut Self, wm_base: &xdg_wm_base::XdgWmBase, event: xdg_wm_base::Event, _: &(), _: &Connection, _: &QueueHandle, ) { if let xdg_wm_base::Event::Ping { serial } = event { wm_base.pong(serial); } } } impl Dispatch for State { fn event( state: &mut Self, xdg_surface: &xdg_surface::XdgSurface, event: xdg_surface::Event, _: &(), _: &Connection, _: &QueueHandle, ) { if let xdg_surface::Event::Configure { serial, .. } = event { xdg_surface.ack_configure(serial); state.configured = true; let surface = state.base_surface.as_ref().unwrap(); if let Some(ref buffer) = state.buffer { surface.attach(Some(buffer), 0, 0); surface.commit(); } } } } impl Dispatch for State { fn event( state: &mut Self, _: &xdg_toplevel::XdgToplevel, event: xdg_toplevel::Event, _: &(), _: &Connection, _: &QueueHandle, ) { if let xdg_toplevel::Event::Close {} = event { state.running = false; } } } impl Dispatch for State { fn event( _: &mut Self, seat: &wl_seat::WlSeat, event: wl_seat::Event, _: &(), _: &Connection, qh: &QueueHandle, ) { if let wl_seat::Event::Capabilities { capabilities: WEnum::Value(capabilities) } = event { if capabilities.contains(wl_seat::Capability::Keyboard) { seat.get_keyboard(qh, ()); } } } } impl Dispatch for State { fn event( state: &mut Self, _: &wl_keyboard::WlKeyboard, event: wl_keyboard::Event, _: &(), _: &Connection, _: &QueueHandle, ) { if let wl_keyboard::Event::Key { key, .. } = event { if key == 1 { // ESC key state.running = false; } } } } wayland-client-0.31.8/src/conn.rs000064400000000000000000000251151046102023000147260ustar 00000000000000use std::{ env, fmt, io::ErrorKind, os::unix::io::{AsFd, AsRawFd, BorrowedFd, FromRawFd, OwnedFd}, os::unix::net::UnixStream, path::PathBuf, sync::{ atomic::{AtomicBool, Ordering}, Arc, }, }; use wayland_backend::{ client::{Backend, InvalidId, ObjectData, ObjectId, ReadEventsGuard, WaylandError}, protocol::{ObjectInfo, ProtocolError}, }; use crate::{protocol::wl_display::WlDisplay, EventQueue, Proxy}; /// The Wayland connection /// /// This is the main type representing your connection to the Wayland server, though most of the interaction /// with the protocol are actually done using other types. The two main uses a simple app has for the /// [`Connection`] are: /// /// - Obtaining the initial [`WlDisplay`] through the [`display()`][Self::display()] method. /// - Creating new [`EventQueue`]s with the [`new_event_queue()`][Self::new_event_queue()] method. /// /// It can be created through the [`connect_to_env()`][Self::connect_to_env()] method to follow the /// configuration from the environment (which is what you'll do most of the time), or using the /// [`from_socket()`][Self::from_socket()] method if you retrieved your connected Wayland socket through /// other means. /// /// In case you need to plug yourself into an external Wayland connection that you don't control, you'll /// likely get access to it as a [`Backend`], in which case you can create a [`Connection`] from it using /// the [`from_backend()`][Self::from_backend()] method. #[derive(Debug, Clone, PartialEq, Eq)] pub struct Connection { pub(crate) backend: Backend, } impl Connection { /// Try to connect to the Wayland server following the environment /// /// This is the standard way to initialize a Wayland connection. pub fn connect_to_env() -> Result { let stream = if let Ok(txt) = env::var("WAYLAND_SOCKET") { // We should connect to the provided WAYLAND_SOCKET let fd = txt.parse::().map_err(|_| ConnectError::InvalidFd)?; let fd = unsafe { OwnedFd::from_raw_fd(fd) }; // remove the variable so any child processes don't see it env::remove_var("WAYLAND_SOCKET"); // set the CLOEXEC flag on this FD let flags = rustix::io::fcntl_getfd(&fd); let result = flags .map(|f| f | rustix::io::FdFlags::CLOEXEC) .and_then(|f| rustix::io::fcntl_setfd(&fd, f)); match result { Ok(_) => { // setting the O_CLOEXEC worked UnixStream::from(fd) } Err(_) => { // something went wrong in F_GETFD or F_SETFD return Err(ConnectError::InvalidFd); } } } else { let socket_name = env::var_os("WAYLAND_DISPLAY") .map(Into::::into) .ok_or(ConnectError::NoCompositor)?; let socket_path = if socket_name.is_absolute() { socket_name } else { let mut socket_path = env::var_os("XDG_RUNTIME_DIR") .map(Into::::into) .ok_or(ConnectError::NoCompositor)?; if !socket_path.is_absolute() { return Err(ConnectError::NoCompositor); } socket_path.push(socket_name); socket_path }; UnixStream::connect(socket_path).map_err(|_| ConnectError::NoCompositor)? }; let backend = Backend::connect(stream).map_err(|_| ConnectError::NoWaylandLib)?; Ok(Self { backend }) } /// Initialize a Wayland connection from an already existing Unix stream pub fn from_socket(stream: UnixStream) -> Result { let backend = Backend::connect(stream).map_err(|_| ConnectError::NoWaylandLib)?; Ok(Self { backend }) } /// Get the `WlDisplay` associated with this connection pub fn display(&self) -> WlDisplay { let display_id = self.backend.display_id(); Proxy::from_id(self, display_id).unwrap() } /// Create a new event queue pub fn new_event_queue(&self) -> EventQueue { EventQueue::new(self.clone()) } /// Wrap an existing [`Backend`] into a [`Connection`] pub fn from_backend(backend: Backend) -> Self { Self { backend } } /// Get the [`Backend`] underlying this [`Connection`] pub fn backend(&self) -> Backend { self.backend.clone() } /// Flush pending outgoing events to the server /// /// This needs to be done regularly to ensure the server receives all your requests, though several /// dispatching methods do it implicitly (this is stated in their documentation when they do). pub fn flush(&self) -> Result<(), WaylandError> { self.backend.flush() } /// Start a synchronized read from the socket /// /// This is needed if you plan to wait on readiness of the Wayland socket using an event loop. See /// [`ReadEventsGuard`] for details. Once the events are received, you'll then need to dispatch them from /// their event queues using [`EventQueue::dispatch_pending()`]. /// /// If you don't need to manage multiple event sources, see /// [`EventQueue::blocking_dispatch()`] for a simpler mechanism. #[must_use] pub fn prepare_read(&self) -> Option { self.backend.prepare_read() } /// Do a roundtrip to the server /// /// This method will block until the Wayland server has processed and answered all your /// preceding requests. This is notably useful during the initial setup of an app, to wait for /// the initial state from the server. /// /// See [`EventQueue::roundtrip()`] for a version that includes the dispatching of the event queue. pub fn roundtrip(&self) -> Result { let done = Arc::new(SyncData::default()); let display = self.display(); self.send_request( &display, crate::protocol::wl_display::Request::Sync {}, Some(done.clone()), ) .map_err(|_| WaylandError::Io(rustix::io::Errno::PIPE.into()))?; let mut dispatched = 0; loop { self.backend.flush()?; if let Some(guard) = self.backend.prepare_read() { dispatched += blocking_read(guard)?; } else { dispatched += self.backend.dispatch_inner_queue()?; } // see if the successful read included our callback if done.done.load(Ordering::Relaxed) { break; } } Ok(dispatched) } /// Retrieve the protocol error that occured on the connection if any /// /// If this method returns [`Some`], it means your Wayland connection is already dead. pub fn protocol_error(&self) -> Option { match self.backend.last_error()? { WaylandError::Protocol(err) => Some(err), WaylandError::Io(_) => None, } } /// Send a request associated with the provided object /// /// This is a low-level interface used by the code generated by `wayland-scanner`, you will likely /// instead use the methods of the types representing each interface, or the [`Proxy::send_request()`] and /// [`Proxy::send_constructor()`]. pub fn send_request( &self, proxy: &I, request: I::Request<'_>, data: Option>, ) -> Result { let (msg, child_spec) = proxy.write_request(self, request)?; let msg = msg.map_fd(|fd| fd.as_raw_fd()); self.backend.send_request(msg, data, child_spec) } /// Get the protocol information related to given object ID pub fn object_info(&self, id: ObjectId) -> Result { self.backend.info(id) } /// Get the object data for a given object ID /// /// This is a low-level interface used by the code generated by `wayland-scanner`, a higher-level /// interface for manipulating the user-data assocated to [`Dispatch`][crate::Dispatch] implementations /// is given as [`Proxy::data()`]. Also see [`Proxy::object_data()`]. pub fn get_object_data(&self, id: ObjectId) -> Result, InvalidId> { self.backend.get_data(id) } } pub(crate) fn blocking_read(guard: ReadEventsGuard) -> Result { let fd = guard.connection_fd(); let mut fds = [rustix::event::PollFd::new( &fd, rustix::event::PollFlags::IN | rustix::event::PollFlags::ERR, )]; loop { match rustix::event::poll(&mut fds, -1) { Ok(_) => break, Err(rustix::io::Errno::INTR) => continue, Err(e) => return Err(WaylandError::Io(e.into())), } } // at this point the fd is ready match guard.read() { Ok(n) => Ok(n), // if we are still "wouldblock", just return 0; the caller will retry. Err(WaylandError::Io(e)) if e.kind() == ErrorKind::WouldBlock => Ok(0), Err(e) => Err(e), } } /// An error when trying to establish a Wayland connection. #[derive(Debug)] pub enum ConnectError { /// The wayland library could not be loaded. NoWaylandLib, /// Could not find wayland compositor NoCompositor, /// `WAYLAND_SOCKET` was set but contained garbage InvalidFd, } impl std::error::Error for ConnectError {} impl fmt::Display for ConnectError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match self { ConnectError::NoWaylandLib => { write!(f, "The wayland library could not be loaded") } ConnectError::NoCompositor => { write!(f, "Could not find wayland compositor") } ConnectError::InvalidFd => { write!(f, "WAYLAND_SOCKET was set but contained garbage") } } } } impl AsFd for Connection { /// Provides fd from [`Backend::poll_fd()`] for polling. fn as_fd(&self) -> BorrowedFd<'_> { self.backend.poll_fd() } } /* wl_callback object data for wl_display.sync */ #[derive(Default)] pub(crate) struct SyncData { pub(crate) done: AtomicBool, } impl ObjectData for SyncData { fn event( self: Arc, _handle: &Backend, _msg: wayland_backend::protocol::Message, ) -> Option> { self.done.store(true, Ordering::Relaxed); None } fn destroyed(&self, _: ObjectId) {} } wayland-client-0.31.8/src/event_queue.rs000064400000000000000000001001221046102023000163060ustar 00000000000000use std::any::Any; use std::collections::VecDeque; use std::convert::Infallible; use std::marker::PhantomData; use std::os::unix::io::{AsFd, BorrowedFd, OwnedFd}; use std::sync::{atomic::Ordering, Arc, Condvar, Mutex}; use std::task; use wayland_backend::{ client::{Backend, ObjectData, ObjectId, ReadEventsGuard, WaylandError}, protocol::{Argument, Message}, }; use crate::{conn::SyncData, Connection, DispatchError, Proxy}; /// A trait for handlers of proxies' events delivered to an [`EventQueue`]. /// /// ## General usage /// /// You need to implement this trait on your `State` for every type of Wayland object that will be processed /// by the [`EventQueue`] working with your `State`. /// /// You can have different implementations of the trait for the same interface but different `UserData` type. /// This way the events for a given object will be processed by the adequate implementation depending on /// which `UserData` was assigned to it at creation. /// /// The way this trait works is that the [`Dispatch::event()`] method will be invoked by the event queue for /// every event received by an object associated to this event queue. Your implementation can then match on /// the associated [`Proxy::Event`] enum and do any processing needed with that event. /// /// In the rare case of an interface with *events* creating new objects (in the core protocol, the only /// instance of this is the `wl_data_device.data_offer` event), you'll need to implement the /// [`Dispatch::event_created_child()`] method. See the [`event_created_child!()`] macro /// for a simple way to do this. /// /// [`event_created_child!()`]: crate::event_created_child!() /// /// ## Modularity /// /// To provide generic handlers for downstream usage, it is possible to make an implementation of the trait /// that is generic over the last type argument, as illustrated below. Users will then be able to /// automatically delegate their implementation to yours using the [`delegate_dispatch!()`] macro. /// /// [`delegate_dispatch!()`]: crate::delegate_dispatch!() /// /// As a result, when your implementation is instantiated, the last type parameter `State` will be the state /// struct of the app using your generic implementation. You can put additional trait constraints on it to /// specify an interface between your module and downstream code, as illustrated in this example: /// /// ``` /// # // Maintainers: If this example changes, please make sure you also carry those changes over to the delegate_dispatch macro. /// use wayland_client::{protocol::wl_registry, Dispatch}; /// /// /// The type we want to delegate to /// struct DelegateToMe; /// /// /// The user data relevant for your implementation. /// /// When providing a delegate implementation, it is recommended to use your own type here, even if it is /// /// just a unit struct: using () would cause a risk of clashing with another such implementation. /// struct MyUserData; /// /// // Now a generic implementation of Dispatch, we are generic over the last type argument instead of using /// // the default State=Self. /// impl Dispatch for DelegateToMe /// where /// // State is the type which has delegated to this type, so it needs to have an impl of Dispatch itself /// State: Dispatch, /// // If your delegate type has some internal state, it'll need to access it, and you can /// // require it by adding custom trait bounds. /// // In this example, we just require an AsMut implementation /// State: AsMut, /// { /// fn event( /// state: &mut State, /// _proxy: &wl_registry::WlRegistry, /// _event: wl_registry::Event, /// _udata: &MyUserData, /// _conn: &wayland_client::Connection, /// _qhandle: &wayland_client::QueueHandle, /// ) { /// // Here the delegate may handle incoming events as it pleases. /// /// // For example, it retrives its state and does some processing with it /// let me: &mut DelegateToMe = state.as_mut(); /// // do something with `me` ... /// # std::mem::drop(me) // use `me` to avoid a warning /// } /// } /// ``` /// /// **Note:** Due to limitations in Rust's trait resolution algorithm, a type providing a generic /// implementation of [`Dispatch`] cannot be used directly as the dispatching state, as rustc /// currently fails to understand that it also provides `Dispatch` (assuming all other /// trait bounds are respected as well). pub trait Dispatch where Self: Sized, I: Proxy, State: Dispatch, { /// Called when an event from the server is processed /// /// This method contains your logic for processing events, which can vary wildly from an object to the /// other. You are given as argument: /// /// - a proxy representing the object that received this event /// - the event itself as the [`Proxy::Event`] enum (which you'll need to match against) /// - a reference to the `UserData` that was associated with that object on creation /// - a reference to the [`Connection`] in case you need to access it /// - a reference to a [`QueueHandle`] associated with the [`EventQueue`] currently processing events, in /// case you need to create new objects that you want associated to the same [`EventQueue`]. fn event( state: &mut State, proxy: &I, event: I::Event, data: &UserData, conn: &Connection, qhandle: &QueueHandle, ); /// Method used to initialize the user-data of objects created by events /// /// If the interface does not have any such event, you can ignore it. If not, the /// [`event_created_child!()`] macro is provided for overriding it. /// /// [`event_created_child!()`]: crate::event_created_child!() #[cfg_attr(coverage, coverage(off))] fn event_created_child(opcode: u16, _qhandle: &QueueHandle) -> Arc { panic!( "Missing event_created_child specialization for event opcode {} of {}", opcode, I::interface().name ); } } /// Macro used to override [`Dispatch::event_created_child()`] /// /// Use this macro inside the [`Dispatch`] implementation to override this method, to implement the /// initialization of the user data for event-created objects. The usage syntax is as follow: /// /// ```ignore /// impl Dispatch for MyState { /// fn event( /// &mut self, /// proxy: &WlFoo, /// event: FooEvent, /// data: &FooUserData, /// connhandle: &mut ConnectionHandle, /// qhandle: &QueueHandle /// ) { /// /* ... */ /// } /// /// event_created_child!(MyState, WlFoo, [ /// // there can be multiple lines if this interface has multiple object-creating event /// EVT_CREATE_BAR => (WlBar, BarUserData::new()), /// // ~~~~~~~~~~~~~~ ~~~~~ ~~~~~~~~~~~~~~~~~~ /// // | | | /// // | | +-- an expression whose evaluation produces the /// // | | user data value /// // | +-- the type of the newly created object /// // +-- the opcode of the event that creates a new object, constants for those are /// // generated alongside the `WlFoo` type in the `wl_foo` module /// ]); /// } /// ``` #[macro_export] macro_rules! event_created_child { // Must match `pat` to allow paths `wl_data_device::EVT_DONE_OPCODE` and expressions `0` to both work. ($(@< $( $lt:tt $( : $clt:tt $(+ $dlt:tt )* )? ),+ >)? $selftype:ty, $iface:ty, [$($opcode:pat => ($child_iface:ty, $child_udata:expr)),* $(,)?]) => { fn event_created_child( opcode: u16, qhandle: &$crate::QueueHandle<$selftype> ) -> std::sync::Arc { match opcode { $( $opcode => { qhandle.make_data::<$child_iface, _>({$child_udata}) }, )* _ => { panic!("Missing event_created_child specialization for event opcode {} of {}", opcode, <$iface as $crate::Proxy>::interface().name); }, } } }; } type QueueCallback = fn( &Connection, Message, &mut State, Arc, &QueueHandle, ) -> Result<(), DispatchError>; struct QueueEvent(QueueCallback, Message, Arc); impl std::fmt::Debug for QueueEvent { #[cfg_attr(coverage, coverage(off))] fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { f.debug_struct("QueueEvent").field("msg", &self.1).finish_non_exhaustive() } } /// An event queue /// /// This is an abstraction for handling event dispatching, that allows you to ensure /// access to some common state `&mut State` to your event handlers. /// /// Event queues are created through [`Connection::new_event_queue()`]. /// /// Upon creation, a wayland object is assigned to an event queue by passing the associated [`QueueHandle`] /// as argument to the method creating it. All events received by that object will be processed by that event /// queue, when [`dispatch_pending()`][Self::dispatch_pending()] or /// [`blocking_dispatch()`][Self::blocking_dispatch()] is invoked. /// /// ## Usage /// /// ### Single queue app /// /// If your app is simple enough that the only source of event to process is the Wayland socket and you only /// need a single event queue, your main loop can be as simple as this: /// /// ```rust,no_run /// use wayland_client::Connection; /// /// let connection = Connection::connect_to_env().unwrap(); /// let mut event_queue = connection.new_event_queue(); /// /// /* /// * Here your initial setup /// */ /// # struct State { /// # exit: bool /// # } /// # let mut state = State { exit: false }; /// /// // And the main loop: /// while !state.exit { /// event_queue.blocking_dispatch(&mut state).unwrap(); /// } /// ``` /// /// The [`blocking_dispatch()`][Self::blocking_dispatch()] call will wait (by putting the thread to sleep) /// until there are some events from the server that can be processed, and all your actual app logic can be /// done in the callbacks of the [`Dispatch`] implementations, and in the main `loop` after the /// [`blocking_dispatch()`][Self::blocking_dispatch()] call. /// /// ### Multi-thread multi-queue app /// /// In a case where you app is multithreaded and you want to process events in multiple thread, a simple /// pattern is to have one [`EventQueue`] per thread processing Wayland events. /// /// With this pattern, each thread can use [`EventQueue::blocking_dispatch()`] /// on its own event loop, and everything will "Just Work". /// /// ### Single-queue guest library /// /// If your code is some library code that will act on a Wayland connection shared by the main program, it is /// likely you should not trigger socket reads yourself and instead let the main app take care of it. In this /// case, to ensure your [`EventQueue`] still makes progress, you should regularly invoke /// [`EventQueue::dispatch_pending()`] which will process the events that were /// enqueued in the inner buffer of your [`EventQueue`] by the main app reading the socket. /// /// ### Integrating the event queue with other sources of events /// /// If your program needs to monitor other sources of events alongside the Wayland socket using a monitoring /// system like `epoll`, you can integrate the Wayland socket into this system. This is done with the help /// of the [`EventQueue::prepare_read()`] method. You event loop will be a bit more /// explicit: /// /// ```rust,no_run /// # use wayland_client::Connection; /// # let connection = Connection::connect_to_env().unwrap(); /// # let mut event_queue = connection.new_event_queue(); /// # let mut state = (); /// /// loop { /// // flush the outgoing buffers to ensure that the server does receive the messages /// // you've sent /// event_queue.flush().unwrap(); /// /// // (this step is only relevant if other threads might be reading the socket as well) /// // make sure you don't have any pending events if the event queue that might have been /// // enqueued by other threads reading the socket /// event_queue.dispatch_pending(&mut state).unwrap(); /// /// // This puts in place some internal synchronization to prepare for the fact that /// // you're going to wait for events on the socket and read them, in case other threads /// // are doing the same thing /// let read_guard = event_queue.prepare_read().unwrap(); /// /// /* /// * At this point you can invoke epoll(..) to wait for readiness on the multiple FD you /// * are working with, and read_guard.connection_fd() will give you the FD to wait on for /// * the Wayland connection /// */ /// # let wayland_socket_ready = true; /// /// if wayland_socket_ready { /// // If epoll notified readiness of the Wayland socket, you can now proceed to the read /// read_guard.read().unwrap(); /// // And now, you must invoke dispatch_pending() to actually process the events /// event_queue.dispatch_pending(&mut state).unwrap(); /// } else { /// // otherwise, some of your other FD are ready, but you didn't receive Wayland events, /// // you can drop the guard to cancel the read preparation /// std::mem::drop(read_guard); /// } /// /// /* /// * There you process all relevant events from your other event sources /// */ /// } /// ``` pub struct EventQueue { handle: QueueHandle, conn: Connection, } #[derive(Debug)] pub(crate) struct EventQueueInner { queue: VecDeque>, freeze_count: usize, waker: Option, } impl EventQueueInner { pub(crate) fn enqueue_event( &mut self, msg: Message, odata: Arc, ) where State: Dispatch + 'static, U: Send + Sync + 'static, I: Proxy + 'static, { let func = queue_callback::; self.queue.push_back(QueueEvent(func, msg, odata)); if self.freeze_count == 0 { if let Some(waker) = self.waker.take() { waker.wake(); } } } } impl std::fmt::Debug for EventQueue { #[cfg_attr(coverage, coverage(off))] fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { f.debug_struct("EventQueue").field("handle", &self.handle).finish_non_exhaustive() } } impl AsFd for EventQueue { /// Provides fd from [`Backend::poll_fd`] for polling. fn as_fd(&self) -> BorrowedFd<'_> { self.conn.as_fd() } } impl EventQueue { pub(crate) fn new(conn: Connection) -> Self { let inner = Arc::new(Mutex::new(EventQueueInner { queue: VecDeque::new(), freeze_count: 0, waker: None, })); Self { handle: QueueHandle { inner }, conn } } /// Get a [`QueueHandle`] for this event queue pub fn handle(&self) -> QueueHandle { self.handle.clone() } /// Dispatch pending events /// /// Events are accumulated in the event queue internal buffer when the Wayland socket is read using /// the read APIs on [`Connection`], or when reading is done from an other thread. /// This method will dispatch all such pending events by sequentially invoking their associated handlers: /// the [`Dispatch`] implementations on the provided `&mut D`. /// /// Note: this may block if another thread has frozen the queue. pub fn dispatch_pending(&mut self, data: &mut State) -> Result { Self::dispatching_impl(&self.conn, &self.handle, data) } /// Block waiting for events and dispatch them /// /// This method is similar to [`dispatch_pending()`][Self::dispatch_pending], but if there are no /// pending events it will also flush the connection and block waiting for the Wayland server to send an /// event. /// /// A simple app event loop can consist of invoking this method in a loop. pub fn blocking_dispatch(&mut self, data: &mut State) -> Result { let dispatched = self.dispatch_pending(data)?; if dispatched > 0 { return Ok(dispatched); } self.conn.flush()?; if let Some(guard) = self.conn.prepare_read() { crate::conn::blocking_read(guard)?; } self.dispatch_pending(data) } /// Synchronous roundtrip /// /// This function will cause a synchronous round trip with the wayland server. This function will block /// until all requests in the queue are sent and processed by the server. /// /// This function may be useful during initial setup of your app. This function may also be useful /// where you need to guarantee all requests prior to calling this function are completed. pub fn roundtrip(&mut self, data: &mut State) -> Result { let done = Arc::new(SyncData::default()); let display = self.conn.display(); self.conn .send_request( &display, crate::protocol::wl_display::Request::Sync {}, Some(done.clone()), ) .map_err(|_| WaylandError::Io(rustix::io::Errno::PIPE.into()))?; let mut dispatched = 0; while !done.done.load(Ordering::Relaxed) { dispatched += self.blocking_dispatch(data)?; } Ok(dispatched) } /// Start a synchronized read from the socket /// /// This is needed if you plan to wait on readiness of the Wayland socket using an event /// loop. See the [`EventQueue`] and [`ReadEventsGuard`] docs for details. Once the events are received, /// you'll then need to dispatch them from the event queue using /// [`EventQueue::dispatch_pending()`]. /// /// If this method returns [`None`], you should invoke ['dispatch_pending()`][Self::dispatch_pending] /// before trying to invoke it again. /// /// If you don't need to manage multiple event sources, see /// [`blocking_dispatch()`][Self::blocking_dispatch()] for a simpler mechanism. /// /// This method is identical to [`Connection::prepare_read()`]. #[must_use] pub fn prepare_read(&self) -> Option { self.conn.prepare_read() } /// Flush pending outgoing events to the server /// /// This needs to be done regularly to ensure the server receives all your requests. /// /// This method is identical to [`Connection::flush()`]. pub fn flush(&self) -> Result<(), WaylandError> { self.conn.flush() } fn dispatching_impl( backend: &Connection, qhandle: &QueueHandle, data: &mut State, ) -> Result { // This call will most of the time do nothing, but ensure that if the Connection is in guest mode // from some external connection, only invoking `EventQueue::dispatch_pending()` will be enough to // process the events assuming the host program already takes care of reading the socket. // // We purposefully ignore the possible error, as that would make us early return in a way that might // lose events, and the potential socket error will be caught in other places anyway. let mut dispatched = backend.backend.dispatch_inner_queue().unwrap_or_default(); while let Some(QueueEvent(cb, msg, odata)) = Self::try_next(&qhandle.inner) { cb(backend, msg, data, odata, qhandle)?; dispatched += 1; } Ok(dispatched) } fn try_next(inner: &Mutex>) -> Option> { let mut lock = inner.lock().unwrap(); if lock.freeze_count != 0 && !lock.queue.is_empty() { let waker = Arc::new(DispatchWaker { cond: Condvar::new() }); while lock.freeze_count != 0 { lock.waker = Some(waker.clone().into()); lock = waker.cond.wait(lock).unwrap(); } } lock.queue.pop_front() } /// Attempt to dispatch events from this queue, registering the current task for wakeup if no /// events are pending. /// /// This method is similar to [`dispatch_pending()`][Self::dispatch_pending]; it will not /// perform reads on the Wayland socket. Reads on the socket by other tasks or threads will /// cause the current task to wake up if events are pending on this queue. /// /// ``` /// use futures_channel::mpsc::Receiver; /// use futures_util::future::{poll_fn,select}; /// use futures_util::stream::StreamExt; /// use wayland_client::EventQueue; /// /// struct Data; /// /// enum AppEvent { /// SomethingHappened(u32), /// } /// /// impl Data { /// fn handle(&mut self, event: AppEvent) { /// // actual event handling goes here /// } /// } /// /// // An async task that is spawned on an executor in order to handle events that need access /// // to a specific data object. /// async fn run(data: &mut Data, mut wl_queue: EventQueue, mut app_queue: Receiver) /// -> Result<(), Box> /// { /// use futures_util::future::Either; /// loop { /// match select( /// poll_fn(|cx| wl_queue.poll_dispatch_pending(cx, data)), /// app_queue.next(), /// ).await { /// Either::Left((res, _)) => match res? {}, /// Either::Right((Some(event), _)) => { /// data.handle(event); /// } /// Either::Right((None, _)) => return Ok(()), /// } /// } /// } /// ``` pub fn poll_dispatch_pending( &mut self, cx: &mut task::Context, data: &mut State, ) -> task::Poll> { loop { if let Err(e) = self.conn.backend.dispatch_inner_queue() { return task::Poll::Ready(Err(e.into())); } let mut lock = self.handle.inner.lock().unwrap(); if lock.freeze_count != 0 { lock.waker = Some(cx.waker().clone()); return task::Poll::Pending; } let QueueEvent(cb, msg, odata) = if let Some(elt) = lock.queue.pop_front() { elt } else { lock.waker = Some(cx.waker().clone()); return task::Poll::Pending; }; drop(lock); cb(&self.conn, msg, data, odata, &self.handle)? } } } struct DispatchWaker { cond: Condvar, } impl task::Wake for DispatchWaker { fn wake(self: Arc) { self.cond.notify_all() } } /// A handle representing an [`EventQueue`], used to assign objects upon creation. pub struct QueueHandle { pub(crate) inner: Arc>>, } /// A handle that temporarily pauses event processing on an [`EventQueue`]. #[derive(Debug)] pub struct QueueFreezeGuard<'a, State> { qh: &'a QueueHandle, } impl std::fmt::Debug for QueueHandle { #[cfg_attr(coverage, coverage(off))] fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { f.debug_struct("QueueHandle").field("inner", &Arc::as_ptr(&self.inner)).finish() } } impl Clone for QueueHandle { fn clone(&self) -> Self { Self { inner: self.inner.clone() } } } impl QueueHandle { /// Create an object data associated with this event queue /// /// This creates an implementation of [`ObjectData`] fitting for direct use with `wayland-backend` APIs /// that forwards all events to the event queue associated with this token, integrating the object into /// the [`Dispatch`]-based logic of `wayland-client`. pub fn make_data( &self, user_data: U, ) -> Arc where State: Dispatch, { Arc::new(QueueProxyData:: { handle: self.clone(), udata: user_data, _phantom: PhantomData, }) } /// Temporarily block processing on this queue. /// /// This will cause the associated queue to block (or return `NotReady` to poll) until all /// [`QueueFreezeGuard`]s associated with the queue are dropped. pub fn freeze(&self) -> QueueFreezeGuard { self.inner.lock().unwrap().freeze_count += 1; QueueFreezeGuard { qh: self } } } impl Drop for QueueFreezeGuard<'_, State> { fn drop(&mut self) { let mut lock = self.qh.inner.lock().unwrap(); lock.freeze_count -= 1; if lock.freeze_count == 0 && !lock.queue.is_empty() { if let Some(waker) = lock.waker.take() { waker.wake(); } } } } fn queue_callback< I: Proxy + 'static, U: Send + Sync + 'static, State: Dispatch + 'static, >( handle: &Connection, msg: Message, data: &mut State, odata: Arc, qhandle: &QueueHandle, ) -> Result<(), DispatchError> { let (proxy, event) = I::parse_event(handle, msg)?; let udata = odata.data_as_any().downcast_ref().expect("Wrong user_data value for object"); >::event(data, &proxy, event, udata, handle, qhandle); Ok(()) } /// The [`ObjectData`] implementation used by Wayland proxies, integrating with [`Dispatch`] pub struct QueueProxyData { handle: QueueHandle, /// The user data associated with this object pub udata: U, _phantom: PhantomData, } impl ObjectData for QueueProxyData where State: Dispatch + 'static, { fn event( self: Arc, _: &Backend, msg: Message, ) -> Option> { let new_data = msg .args .iter() .any(|arg| matches!(arg, Argument::NewId(id) if !id.is_null())) .then(|| State::event_created_child(msg.opcode, &self.handle)); self.handle.inner.lock().unwrap().enqueue_event::(msg, self.clone()); new_data } fn destroyed(&self, _: ObjectId) {} fn data_as_any(&self) -> &dyn Any { &self.udata } } impl std::fmt::Debug for QueueProxyData { #[cfg_attr(coverage, coverage(off))] fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { f.debug_struct("QueueProxyData").field("udata", &self.udata).finish() } } /* * Dispatch delegation helpers */ /// A helper macro which delegates a set of [`Dispatch`] implementations for proxies to some other type which /// provides a generic [`Dispatch`] implementation. /// /// This macro allows more easily delegating smaller parts of the protocol an application may wish to handle /// in a modular fashion. /// /// # Usage /// /// For example, say you want to delegate events for [`WlRegistry`][crate::protocol::wl_registry::WlRegistry] /// to the struct `DelegateToMe` for the [`Dispatch`] documentatione example. /// /// ``` /// use wayland_client::{delegate_dispatch, protocol::wl_registry}; /// # /// # use wayland_client::Dispatch; /// # /// # struct DelegateToMe; /// # struct MyUserData; /// # /// # impl Dispatch for DelegateToMe /// # where /// # State: Dispatch + AsMut, /// # { /// # fn event( /// # _state: &mut State, /// # _proxy: &wl_registry::WlRegistry, /// # _event: wl_registry::Event, /// # _udata: &MyUserData, /// # _conn: &wayland_client::Connection, /// # _qhandle: &wayland_client::QueueHandle, /// # ) { /// # } /// # } /// /// // ExampleApp is the type events will be dispatched to. /// /// /// The application state /// struct ExampleApp { /// /// The delegate for handling wl_registry events. /// delegate: DelegateToMe, /// } /// /// // Use delegate_dispatch to implement Dispatch for ExampleApp /// delegate_dispatch!(ExampleApp: [wl_registry::WlRegistry: MyUserData] => DelegateToMe); /// /// // DelegateToMe requires that ExampleApp implements AsMut, so we provide the /// // trait implementation. /// impl AsMut for ExampleApp { /// fn as_mut(&mut self) -> &mut DelegateToMe { /// &mut self.delegate /// } /// } /// /// // To explain the macro above, you may read it as the following: /// // /// // For ExampleApp, delegate WlRegistry to DelegateToMe. /// /// // Assert ExampleApp can Dispatch events for wl_registry /// fn assert_is_registry_delegate() /// where /// T: Dispatch, /// { /// } /// /// assert_is_registry_delegate::(); /// ``` #[macro_export] macro_rules! delegate_dispatch { ($(@< $( $lt:tt $( : $clt:tt $(+ $dlt:tt )* )? ),+ >)? $dispatch_from:ty : [$interface: ty: $udata: ty] => $dispatch_to: ty) => { impl$(< $( $lt $( : $clt $(+ $dlt )* )? ),+ >)? $crate::Dispatch<$interface, $udata> for $dispatch_from { fn event( state: &mut Self, proxy: &$interface, event: <$interface as $crate::Proxy>::Event, data: &$udata, conn: &$crate::Connection, qhandle: &$crate::QueueHandle, ) { <$dispatch_to as $crate::Dispatch<$interface, $udata, Self>>::event(state, proxy, event, data, conn, qhandle) } fn event_created_child( opcode: u16, qhandle: &$crate::QueueHandle ) -> ::std::sync::Arc { <$dispatch_to as $crate::Dispatch<$interface, $udata, Self>>::event_created_child(opcode, qhandle) } } }; } /// A helper macro which delegates a set of [`Dispatch`] implementations for proxies to a static handler. /// /// # Usage /// /// This macro is useful to implement [`Dispatch`] for interfaces where events are unimportant to /// the current application and can be ignored. /// /// # Example /// /// ``` /// use wayland_client::{delegate_noop, protocol::{wl_data_offer, wl_subcompositor}}; /// /// /// The application state /// struct ExampleApp { /// // ... /// } /// /// // Ignore all events for this interface: /// delegate_noop!(ExampleApp: ignore wl_data_offer::WlDataOffer); /// /// // This interface should not emit events: /// delegate_noop!(ExampleApp: wl_subcompositor::WlSubcompositor); /// ``` /// /// This last example will execute `unreachable!()` if the interface emits any events. #[macro_export] macro_rules! delegate_noop { ($(@< $( $lt:tt $( : $clt:tt $(+ $dlt:tt )* )? ),+ >)? $dispatch_from: ty : $interface: ty) => { impl$(< $( $lt $( : $clt $(+ $dlt )* )? ),+ >)? $crate::Dispatch<$interface, ()> for $dispatch_from { fn event( _: &mut Self, _: &$interface, _: <$interface as $crate::Proxy>::Event, _: &(), _: &$crate::Connection, _: &$crate::QueueHandle, ) { unreachable!(); } } }; ($(@< $( $lt:tt $( : $clt:tt $(+ $dlt:tt )* )? ),+ >)? $dispatch_from: ty : ignore $interface: ty) => { impl$(< $( $lt $( : $clt $(+ $dlt )* )? ),+ >)? $crate::Dispatch<$interface, ()> for $dispatch_from { fn event( _: &mut Self, _: &$interface, _: <$interface as $crate::Proxy>::Event, _: &(), _: &$crate::Connection, _: &$crate::QueueHandle, ) { } } }; } wayland-client-0.31.8/src/globals.rs000064400000000000000000000304761046102023000154220ustar 00000000000000//! Helpers for handling the initialization of an app //! //! At the startup of your Wayland app, the initial step is generally to retrieve the list of globals //! advertized by the compositor from the registry. Using the [`Dispatch`] mechanism for this task can be //! very unpractical, this is why this module provides a special helper for handling the registry. //! //! The entry point of this helper is the [`registry_queue_init`] function. Given a reference to your //! [`Connection`] it will create an [`EventQueue`], retrieve the initial list of globals, and register a //! handler using your provided `Dispatch` implementation for handling dynamic registry events. //! //! ## Example //! //! ```no_run //! use wayland_client::{ //! Connection, Dispatch, QueueHandle, //! globals::{registry_queue_init, Global, GlobalListContents}, //! protocol::{wl_registry, wl_compositor}, //! }; //! # use std::sync::Mutex; //! # struct State; //! //! // You need to provide a Dispatch impl for your app //! impl wayland_client::Dispatch for State { //! fn event( //! state: &mut State, //! proxy: &wl_registry::WlRegistry, //! event: wl_registry::Event, //! // This mutex contains an up-to-date list of the currently known globals //! // including the one that was just added or destroyed //! data: &GlobalListContents, //! conn: &Connection, //! qhandle: &QueueHandle, //! ) { //! /* react to dynamic global events here */ //! } //! } //! //! let conn = Connection::connect_to_env().unwrap(); //! let (globals, queue) = registry_queue_init::(&conn).unwrap(); //! //! # impl wayland_client::Dispatch for State { //! # fn event( //! # state: &mut State, //! # proxy: &wl_compositor::WlCompositor, //! # event: wl_compositor::Event, //! # data: &(), //! # conn: &Connection, //! # qhandle: &QueueHandle, //! # ) {} //! # } //! // now you can bind the globals you need for your app //! let compositor: wl_compositor::WlCompositor = globals.bind(&queue.handle(), 4..=5, ()).unwrap(); //! ``` use std::{ fmt, ops::RangeInclusive, os::unix::io::OwnedFd, sync::{ atomic::{AtomicBool, Ordering}, Arc, Mutex, }, }; use wayland_backend::{ client::{Backend, InvalidId, ObjectData, ObjectId, WaylandError}, protocol::Message, }; use crate::{ protocol::{wl_display, wl_registry}, Connection, Dispatch, EventQueue, Proxy, QueueHandle, }; /// Initialize a new event queue with its associated registry and retrieve the initial list of globals /// /// See [the module level documentation][self] for more. pub fn registry_queue_init( conn: &Connection, ) -> Result<(GlobalList, EventQueue), GlobalError> where State: Dispatch + 'static, { let event_queue = conn.new_event_queue(); let display = conn.display(); let data = Arc::new(RegistryState { globals: GlobalListContents { contents: Default::default() }, handle: event_queue.handle(), initial_roundtrip_done: AtomicBool::new(false), }); let registry = display.send_constructor(wl_display::Request::GetRegistry {}, data.clone())?; // We don't need to dispatch the event queue as for now nothing will be sent to it conn.roundtrip()?; data.initial_roundtrip_done.store(true, Ordering::Relaxed); Ok((GlobalList { registry }, event_queue)) } /// A helper for global initialization. /// /// See [the module level documentation][self] for more. #[derive(Debug)] pub struct GlobalList { registry: wl_registry::WlRegistry, } impl GlobalList { /// Access the contents of the list of globals pub fn contents(&self) -> &GlobalListContents { self.registry.data::().unwrap() } /// Binds a global, returning a new protocol object associated with the global. /// /// The `version` specifies the range of versions that should be bound. This function will guarantee the /// version of the returned protocol object is the lower of the maximum requested version and the advertised /// version. /// /// If the lower bound of the `version` is less than the version advertised by the server, then /// [`BindError::UnsupportedVersion`] is returned. /// /// ## Multi-instance/Device globals. /// /// This function is not intended to be used with globals that have multiple instances such as `wl_output` /// and `wl_seat`. These types of globals need their own initialization mechanism because these /// multi-instance globals may be removed at runtime. To handle then, you should instead rely on the /// `Dispatch` implementation for `WlRegistry` of your `State`. /// /// # Panics /// /// This function will panic if the maximum requested version is greater than the known maximum version of /// the interface. The known maximum version is determined by the code generated using wayland-scanner. pub fn bind( &self, qh: &QueueHandle, version: RangeInclusive, udata: U, ) -> Result where I: Proxy + 'static, State: Dispatch + 'static, U: Send + Sync + 'static, { let version_start = *version.start(); let version_end = *version.end(); let interface = I::interface(); if *version.end() > interface.version { // This is a panic because it's a compile-time programmer error, not a runtime error. panic!("Maximum version ({}) of {} was higher than the proxy's maximum version ({}); outdated wayland XML files?", version.end(), interface.name, interface.version); } let globals = &self.registry.data::().unwrap().contents; let guard = globals.lock().unwrap(); let (name, version) = guard .iter() // Find the with the correct interface .filter_map(|Global { name, interface: interface_name, version }| { // TODO: then_some if interface.name == &interface_name[..] { Some((*name, *version)) } else { None } }) .next() .ok_or(BindError::NotPresent)?; // Test version requirements if version < version_start { return Err(BindError::UnsupportedVersion); } // To get the version to bind, take the lower of the version advertised by the server and the maximum // requested version. let version = version.min(version_end); Ok(self.registry.bind(name, version, qh, udata)) } /// Returns the [`WlRegistry`][wl_registry] protocol object. /// /// This may be used if more direct control when creating globals is needed. pub fn registry(&self) -> &wl_registry::WlRegistry { &self.registry } } /// An error that may occur when initializing the global list. #[derive(Debug)] pub enum GlobalError { /// The backend generated an error Backend(WaylandError), /// An invalid object id was acted upon. InvalidId(InvalidId), } impl std::error::Error for GlobalError { fn source(&self) -> Option<&(dyn std::error::Error + 'static)> { match self { GlobalError::Backend(source) => Some(source), GlobalError::InvalidId(source) => std::error::Error::source(source), } } } impl std::fmt::Display for GlobalError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match self { GlobalError::Backend(source) => { write!(f, "Backend error: {source}") } GlobalError::InvalidId(source) => write!(f, "{source}"), } } } impl From for GlobalError { fn from(source: WaylandError) -> Self { GlobalError::Backend(source) } } impl From for GlobalError { fn from(source: InvalidId) -> Self { GlobalError::InvalidId(source) } } /// An error that occurs when a binding a global fails. #[derive(Debug)] pub enum BindError { /// The requested version of the global is not supported. UnsupportedVersion, /// The requested global was not found in the registry. NotPresent, } impl std::error::Error for BindError {} impl fmt::Display for BindError { fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { match self { BindError::UnsupportedVersion {} => { write!(f, "the requested version of the global is not supported") } BindError::NotPresent {} => { write!(f, "the requested global was not found in the registry") } } } } /// Description of a global. #[derive(Debug, Clone, PartialEq, Eq)] pub struct Global { /// The name of the global. /// /// This is an identifier used by the server to reference some specific global. pub name: u32, /// The interface of the global. /// /// This describes what type of protocol object the global is. pub interface: String, /// The advertised version of the global. /// /// This specifies the maximum version of the global that may be bound. This means any lower version of /// the global may be bound. pub version: u32, } /// A container representing the current contents of the list of globals #[derive(Debug)] pub struct GlobalListContents { contents: Mutex>, } impl GlobalListContents { /// Access the list of globals /// /// Your closure is invoked on the global list, and its return value is forwarded to the return value /// of this function. This allows you to process the list without making a copy. pub fn with_list T>(&self, f: F) -> T { let guard = self.contents.lock().unwrap(); f(&guard) } /// Get a copy of the contents of the list of globals. pub fn clone_list(&self) -> Vec { self.contents.lock().unwrap().clone() } } struct RegistryState { globals: GlobalListContents, handle: QueueHandle, initial_roundtrip_done: AtomicBool, } impl ObjectData for RegistryState where State: Dispatch, { fn event( self: Arc, backend: &Backend, msg: Message, ) -> Option> { let conn = Connection::from_backend(backend.clone()); // The registry messages don't contain any fd, so use some type trickery to // clone the message #[derive(Debug, Clone)] enum Void {} let msg: Message = msg.map_fd(|_| unreachable!()); let to_forward = if self.initial_roundtrip_done.load(Ordering::Relaxed) { Some(msg.clone().map_fd(|v| match v {})) } else { None }; // and restore the type let msg = msg.map_fd(|v| match v {}); // Can't do much if the server sends a malformed message if let Ok((_, event)) = wl_registry::WlRegistry::parse_event(&conn, msg) { match event { wl_registry::Event::Global { name, interface, version } => { let mut guard = self.globals.contents.lock().unwrap(); guard.push(Global { name, interface, version }); } wl_registry::Event::GlobalRemove { name: remove } => { let mut guard = self.globals.contents.lock().unwrap(); guard.retain(|Global { name, .. }| name != &remove); } } }; if let Some(msg) = to_forward { // forward the message to the event queue as normal self.handle .inner .lock() .unwrap() .enqueue_event::(msg, self.clone()) } // We do not create any objects in this event handler. None } fn destroyed(&self, _id: ObjectId) { // A registry cannot be destroyed unless disconnected. } fn data_as_any(&self) -> &dyn std::any::Any { &self.globals } } wayland-client-0.31.8/src/lib.rs000064400000000000000000000420361046102023000145400ustar 00000000000000//! Interface for interacting with the Wayland protocol, client-side. //! //! ## General concepts //! //! This crate is structured around four main objects: the [`Connection`] and [`EventQueue`] structs, //! proxies (objects implementing the [`Proxy`] trait), and the [`Dispatch`] trait. //! //! The [`Connection`] is the heart of this crate. It represents your connection to the Wayland server, and //! you'll generally initialize it using the [`Connection::connect_to_env()`] method, which will //! attempt to open a Wayland connection following the configuration specified by the ! environment. //! //! Once you have a [`Connection`], you can create an [`EventQueue`] from it. This [`EventQueue`] will take //! care of processing events from the Wayland server and delivering them to your processing logic, in the form //! of a state struct with several [`Dispatch`] implementations (see below). //! //! Each of the Wayland objects you can manipulate is represented by a struct implementing the [`Proxy`] //! trait. Those structs are automatically generated from the wayland XML protocol specification. This crate //! provides the types generated from the core protocol in the [`protocol`] module. For other standard //! protocols, see the `wayland-protocols` crate. //! //! ## Event dispatching //! //! The core event dispatching logic provided by this crate is built around the [`EventQueue`] struct. In //! this paradigm, receiving and processing events is a two-step process: //! //! - First, events are read from the Wayland socket. For each event, the backend figures out which [`EventQueue`] //! manages it, and enqueues the event in an internal buffer of that queue. //! - Then, the [`EventQueue`] empties its internal buffer by sequentially invoking the appropriate //! [`Dispatch::event()`] method on the `State` value that was provided to it. //! //! The main goal of this structure is to make your `State` accessible without synchronization to most of //! your event-processing logic, to reduce the plumbing costs. See [`EventQueue`]'s documentation for //! explanations of how to use it to drive your event loop, and when and how to use multiple //! event queues in your app. //! //! ### The [`Dispatch`] trait and dispatch delegation //! //! In this paradigm, your `State` needs to implement `Dispatch` for every Wayland object `O` it needs to //! process events for. This is ensured by the fact that, whenever creating an object using the methods on //! an other object, you need to pass a [`QueueHandle`] from the [`EventQueue`] that will be //! managing the newly created object. //! //! However, implementing all those traits on your own is a lot of (often uninteresting) work. To make this //! easier a composition mechanism is provided using the [`delegate_dispatch!`] macro. This way, another //! library (such as Smithay's Client Toolkit) can provide generic [`Dispatch`] implementations that you //! can reuse in your own app by delegating those objects to that provided implementation. See the //! documentation of those traits and macro for details. //! //! ## Getting started example //! //! As an overview of how this crate is used, here is a commented example of a program that connects to the //! Wayland server and lists the globals this server advertised through the `wl_registry`: //! //! ```rust,no_run //! use wayland_client::{protocol::wl_registry, Connection, Dispatch, QueueHandle}; //! // This struct represents the state of our app. This simple app does not //! // need any state, but this type still supports the `Dispatch` implementations. //! struct AppData; //! //! // Implement `Dispatch for our state. This provides the logic //! // to be able to process events for the wl_registry interface. //! // //! // The second type parameter is the user-data of our implementation. It is a //! // mechanism that allows you to associate a value to each particular Wayland //! // object, and allow different dispatching logic depending on the type of the //! // associated value. //! // //! // In this example, we just use () as we don't have any value to associate. See //! // the `Dispatch` documentation for more details about this. //! impl Dispatch for AppData { //! fn event( //! _state: &mut Self, //! _: &wl_registry::WlRegistry, //! event: wl_registry::Event, //! _: &(), //! _: &Connection, //! _: &QueueHandle, //! ) { //! // When receiving events from the wl_registry, we are only interested in the //! // `global` event, which signals a new available global. //! // When receiving this event, we just print its characteristics in this example. //! if let wl_registry::Event::Global { name, interface, version } = event { //! println!("[{}] {} (v{})", name, interface, version); //! } //! } //! } //! //! // The main function of our program //! fn main() { //! // Create a Wayland connection by connecting to the server through the //! // environment-provided configuration. //! let conn = Connection::connect_to_env().unwrap(); //! //! // Retrieve the WlDisplay Wayland object from the connection. This object is //! // the starting point of any Wayland program, from which all other objects will //! // be created. //! let display = conn.display(); //! //! // Create an event queue for our event processing //! let mut event_queue = conn.new_event_queue(); //! // And get its handle to associate new objects to it //! let qh = event_queue.handle(); //! //! // Create a wl_registry object by sending the wl_display.get_registry request. //! // This method takes two arguments: a handle to the queue that the newly created //! // wl_registry will be assigned to, and the user-data that should be associated //! // with this registry (here it is () as we don't need user-data). //! let _registry = display.get_registry(&qh, ()); //! //! // At this point everything is ready, and we just need to wait to receive the events //! // from the wl_registry. Our callback will print the advertised globals. //! println!("Advertised globals:"); //! //! // To actually receive the events, we invoke the `roundtrip` method. This method //! // is special and you will generally only invoke it during the setup of your program: //! // it will block until the server has received and processed all the messages you've //! // sent up to now. //! // //! // In our case, that means it'll block until the server has received our //! // wl_display.get_registry request, and as a reaction has sent us a batch of //! // wl_registry.global events. //! // //! // `roundtrip` will then empty the internal buffer of the queue it has been invoked //! // on, and thus invoke our `Dispatch` implementation that prints the list of advertised //! // globals. //! event_queue.roundtrip(&mut AppData).unwrap(); //! } //! ``` //! //! ## Advanced use //! //! ### Bypassing [`Dispatch`] //! //! It may be that for some of your objects, handling them via the [`EventQueue`] is impractical. For example, //! if processing the events from those objects doesn't require accessing some global state, and/or you need to //! handle them in a context where cranking an event loop is impractical. //! //! In those contexts, this crate also provides some escape hatches to directly interface with the low-level //! APIs from `wayland-backend`, allowing you to register callbacks for those objects that will be invoked //! whenever they receive an event and *any* event queue from the program is being dispatched. Those //! callbacks are more constrained: they don't get a `&mut State` reference, and must be threadsafe. See //! [`Proxy::send_constructor()`] and [`ObjectData`] for details about how to //! assign such callbacks to objects. //! //! ### Interaction with FFI //! //! It can happen that you'll need to interact with Wayland states accross FFI. A typical example would be if //! you need to use the [`raw-window-handle`](https://docs.rs/raw-window-handle/) crate. //! //! In this case, you'll need to do it in two steps, by explicitly working with `wayland-backend`, adding //! it to your dependencies and enabling its `client_system` feature. //! //! - If you need to send pointers to FFI, you can retrive the `*mut wl_proxy` pointers from the proxies by //! first getting the [`ObjectId`] using the [`Proxy::id()`] method, and then //! using the [`ObjectId::as_ptr()`] method. // - If you need to receive pointers from FFI, you need to first create a // [`Backend`][backend::Backend] from the `*mut wl_display` using // [`Backend::from_external_display()`][backend::Backend::from_foreign_display()], and then // make it into a [`Connection`] using [`Connection::from_backend()`]. Similarly, you can make // [`ObjectId`]s from the `*mut wl_proxy` pointers using [`ObjectId::from_ptr()`], and then make // the proxies using [`Proxy::from_id()`]. #![allow(clippy::needless_doctest_main)] #![warn(missing_docs, missing_debug_implementations)] #![forbid(improper_ctypes, unsafe_op_in_unsafe_fn)] #![cfg_attr(coverage, feature(coverage_attribute))] // Doc feature labels can be tested locally by running RUSTDOCFLAGS="--cfg=docsrs" cargo +nightly doc -p #![cfg_attr(docsrs, feature(doc_auto_cfg))] use std::{ fmt, hash::{Hash, Hasher}, os::unix::io::{BorrowedFd, OwnedFd}, sync::Arc, }; use wayland_backend::{ client::{InvalidId, ObjectData, ObjectId, WaylandError, WeakBackend}, protocol::{Interface, Message}, }; mod conn; mod event_queue; pub mod globals; /// Backend reexports pub mod backend { pub use wayland_backend::client::{ Backend, InvalidId, NoWaylandLib, ObjectData, ObjectId, ReadEventsGuard, WaylandError, WeakBackend, }; pub use wayland_backend::protocol; pub use wayland_backend::smallvec; } pub use wayland_backend::protocol::WEnum; pub use conn::{ConnectError, Connection}; pub use event_queue::{Dispatch, EventQueue, QueueFreezeGuard, QueueHandle, QueueProxyData}; // internal imports for dispatching logging depending on the `log` feature #[cfg(feature = "log")] #[allow(unused_imports)] use log::{debug as log_debug, error as log_error, info as log_info, warn as log_warn}; #[cfg(not(feature = "log"))] #[allow(unused_imports)] use std::{ eprintln as log_error, eprintln as log_warn, eprintln as log_info, eprintln as log_debug, }; /// Generated protocol definitions /// /// This module is automatically generated from the `wayland.xml` protocol specification, /// and contains the interface definitions for the core Wayland protocol. #[allow(missing_docs)] pub mod protocol { use self::__interfaces::*; use crate as wayland_client; pub mod __interfaces { wayland_scanner::generate_interfaces!("wayland.xml"); } wayland_scanner::generate_client_code!("wayland.xml"); } /// Trait representing a Wayland interface pub trait Proxy: Clone + std::fmt::Debug + Sized { /// The event enum for this interface type Event; /// The request enum for this interface type Request<'a>; /// The interface description fn interface() -> &'static Interface; /// The ID of this object fn id(&self) -> ObjectId; /// The version of this object fn version(&self) -> u32; /// Checks if the Wayland object associated with this proxy is still alive fn is_alive(&self) -> bool { if let Some(backend) = self.backend().upgrade() { backend.info(self.id()).is_ok() } else { false } } /// Access the user-data associated with this object fn data(&self) -> Option<&U>; /// Access the raw data associated with this object. /// /// For objects created using the scanner-generated methods, this will be an instance of the /// [`QueueProxyData`] type. fn object_data(&self) -> Option<&Arc>; /// Access the backend associated with this object fn backend(&self) -> &backend::WeakBackend; /// Create an object proxy from its ID /// /// Returns an error this the provided object ID does not correspond to /// the `Self` interface. /// /// **Note:** This method is mostly meant as an implementation detail to be /// used by code generated by wayland-scanner. fn from_id(conn: &Connection, id: ObjectId) -> Result; /// Create an inert object proxy /// /// **Note:** This method is mostly meant as an implementation detail to be /// used by code generated by wayland-scanner. fn inert(backend: backend::WeakBackend) -> Self; /// Send a request for this object. /// /// It is an error to use this function on requests that create objects; use /// [`send_constructor()`][Self::send_constructor()] for such requests. fn send_request(&self, req: Self::Request<'_>) -> Result<(), InvalidId>; /// Send a request for this object that creates another object. /// /// It is an error to use this function on requests that do not create objects; use /// [`send_request()`][Self::send_request()] for such requests. fn send_constructor( &self, req: Self::Request<'_>, data: Arc, ) -> Result; /// Parse a event for this object /// /// **Note:** This method is mostly meant as an implementation detail to be /// used by code generated by wayland-scanner. fn parse_event( conn: &Connection, msg: Message, ) -> Result<(Self, Self::Event), DispatchError>; /// Serialize a request for this object /// /// **Note:** This method is mostly meant as an implementation detail to be /// used by code generated by wayland-scanner. #[allow(clippy::type_complexity)] fn write_request<'a>( &self, conn: &Connection, req: Self::Request<'a>, ) -> Result<(Message>, Option<(&'static Interface, u32)>), InvalidId>; /// Creates a weak handle to this object /// /// This weak handle will not keep the user-data associated with the object alive, /// and can be converted back to a full proxy using [`Weak::upgrade()`]. /// /// This can be of use if you need to store proxies in the used data of other objects and want /// to be sure to avoid reference cycles that would cause memory leaks. fn downgrade(&self) -> Weak { Weak { backend: self.backend().clone(), id: self.id(), _iface: std::marker::PhantomData } } } /// Wayland dispatching error #[derive(Debug)] pub enum DispatchError { /// The received message does not match the specification for the object's interface. BadMessage { /// The id of the target object sender_id: ObjectId, /// The interface of the target object interface: &'static str, /// The opcode number opcode: u16, }, /// The backend generated an error Backend(WaylandError), } impl std::error::Error for DispatchError { fn source(&self) -> Option<&(dyn std::error::Error + 'static)> { match self { DispatchError::BadMessage { .. } => Option::None, DispatchError::Backend(source) => Some(source), } } } impl fmt::Display for DispatchError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match self { DispatchError::BadMessage { sender_id, interface, opcode } => { write!(f, "Bad message for object {interface}@{sender_id} on opcode {opcode}") } DispatchError::Backend(source) => { write!(f, "Backend error: {source}") } } } } impl From for DispatchError { fn from(source: WaylandError) -> Self { DispatchError::Backend(source) } } /// A weak handle to a Wayland object /// /// This handle does not keep the underlying user data alive, and can be converted back to a full proxy /// using [`Weak::upgrade()`]. #[derive(Debug, Clone)] pub struct Weak { backend: WeakBackend, id: ObjectId, _iface: std::marker::PhantomData, } impl Weak { /// Try to upgrade with weak handle back into a full proxy. /// /// This will fail if either: /// - the object represented by this handle has already been destroyed at the protocol level /// - the Wayland connection has already been closed pub fn upgrade(&self) -> Result { let backend = self.backend.upgrade().ok_or(InvalidId)?; // Check if the object has been destroyed backend.info(self.id.clone())?; let conn = Connection::from_backend(backend); I::from_id(&conn, self.id.clone()) } /// The underlying [`ObjectId`] pub fn id(&self) -> ObjectId { self.id.clone() } } impl PartialEq for Weak { fn eq(&self, other: &Self) -> bool { self.id == other.id } } impl Eq for Weak {} impl Hash for Weak { fn hash(&self, state: &mut H) { self.id.hash(state); } } impl PartialEq for Weak { fn eq(&self, other: &I) -> bool { self.id == other.id() } } wayland-client-0.31.8/wayland.xml000064400000000000000000004445451046102023000150310ustar 00000000000000 Copyright © 2008-2011 Kristian Høgsberg Copyright © 2010-2011 Intel Corporation Copyright © 2012-2013 Collabora, Ltd. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. The core global object. This is a special singleton object. It is used for internal Wayland protocol features. The sync request asks the server to emit the 'done' event on the returned wl_callback object. Since requests are handled in-order and events are delivered in-order, this can be used as a barrier to ensure all previous requests and the resulting events have been handled. The object returned by this request will be destroyed by the compositor after the callback is fired and as such the client must not attempt to use it after that point. The callback_data passed in the callback is undefined and should be ignored. This request creates a registry object that allows the client to list and bind the global objects available from the compositor. It should be noted that the server side resources consumed in response to a get_registry request can only be released when the client disconnects, not when the client side proxy is destroyed. Therefore, clients should invoke get_registry as infrequently as possible to avoid wasting memory. The error event is sent out when a fatal (non-recoverable) error has occurred. The object_id argument is the object where the error occurred, most often in response to a request to that object. The code identifies the error and is defined by the object interface. As such, each interface defines its own set of error codes. The message is a brief description of the error, for (debugging) convenience. These errors are global and can be emitted in response to any server request. This event is used internally by the object ID management logic. When a client deletes an object that it had created, the server will send this event to acknowledge that it has seen the delete request. When the client receives this event, it will know that it can safely reuse the object ID. The singleton global registry object. The server has a number of global objects that are available to all clients. These objects typically represent an actual object in the server (for example, an input device) or they are singleton objects that provide extension functionality. When a client creates a registry object, the registry object will emit a global event for each global currently in the registry. Globals come and go as a result of device or monitor hotplugs, reconfiguration or other events, and the registry will send out global and global_remove events to keep the client up to date with the changes. To mark the end of the initial burst of events, the client can use the wl_display.sync request immediately after calling wl_display.get_registry. A client can bind to a global object by using the bind request. This creates a client-side handle that lets the object emit events to the client and lets the client invoke requests on the object. Binds a new, client-created object to the server using the specified name as the identifier. Notify the client of global objects. The event notifies the client that a global object with the given name is now available, and it implements the given version of the given interface. Notify the client of removed global objects. This event notifies the client that the global identified by name is no longer available. If the client bound to the global using the bind request, the client should now destroy that object. The object remains valid and requests to the object will be ignored until the client destroys it, to avoid races between the global going away and a client sending a request to it. Clients can handle the 'done' event to get notified when the related request is done. Note, because wl_callback objects are created from multiple independent factory interfaces, the wl_callback interface is frozen at version 1. Notify the client when the related request is done. A compositor. This object is a singleton global. The compositor is in charge of combining the contents of multiple surfaces into one displayable output. Ask the compositor to create a new surface. Ask the compositor to create a new region. The wl_shm_pool object encapsulates a piece of memory shared between the compositor and client. Through the wl_shm_pool object, the client can allocate shared memory wl_buffer objects. All objects created through the same pool share the same underlying mapped memory. Reusing the mapped memory avoids the setup/teardown overhead and is useful when interactively resizing a surface or for many small buffers. Create a wl_buffer object from the pool. The buffer is created offset bytes into the pool and has width and height as specified. The stride argument specifies the number of bytes from the beginning of one row to the beginning of the next. The format is the pixel format of the buffer and must be one of those advertised through the wl_shm.format event. A buffer will keep a reference to the pool it was created from so it is valid to destroy the pool immediately after creating a buffer from it. Destroy the shared memory pool. The mmapped memory will be released when all buffers that have been created from this pool are gone. This request will cause the server to remap the backing memory for the pool from the file descriptor passed when the pool was created, but using the new size. This request can only be used to make the pool bigger. This request only changes the amount of bytes that are mmapped by the server and does not touch the file corresponding to the file descriptor passed at creation time. It is the client's responsibility to ensure that the file is at least as big as the new pool size. A singleton global object that provides support for shared memory. Clients can create wl_shm_pool objects using the create_pool request. On binding the wl_shm object one or more format events are emitted to inform clients about the valid pixel formats that can be used for buffers. These errors can be emitted in response to wl_shm requests. This describes the memory layout of an individual pixel. All renderers should support argb8888 and xrgb8888 but any other formats are optional and may not be supported by the particular renderer in use. The drm format codes match the macros defined in drm_fourcc.h, except argb8888 and xrgb8888. The formats actually supported by the compositor will be reported by the format event. For all wl_shm formats and unless specified in another protocol extension, pre-multiplied alpha is used for pixel values. Create a new wl_shm_pool object. The pool can be used to create shared memory based buffer objects. The server will mmap size bytes of the passed file descriptor, to use as backing memory for the pool. Informs the client about a valid pixel format that can be used for buffers. Known formats include argb8888 and xrgb8888. Using this request a client can tell the server that it is not going to use the shm object anymore. Objects created via this interface remain unaffected. A buffer provides the content for a wl_surface. Buffers are created through factory interfaces such as wl_shm, wp_linux_buffer_params (from the linux-dmabuf protocol extension) or similar. It has a width and a height and can be attached to a wl_surface, but the mechanism by which a client provides and updates the contents is defined by the buffer factory interface. Color channels are assumed to be electrical rather than optical (in other words, encoded with a transfer function) unless otherwise specified. If the buffer uses a format that has an alpha channel, the alpha channel is assumed to be premultiplied into the electrical color channel values (after transfer function encoding) unless otherwise specified. Note, because wl_buffer objects are created from multiple independent factory interfaces, the wl_buffer interface is frozen at version 1. Destroy a buffer. If and how you need to release the backing storage is defined by the buffer factory interface. For possible side-effects to a surface, see wl_surface.attach. Sent when this wl_buffer is no longer used by the compositor. The client is now free to reuse or destroy this buffer and its backing storage. If a client receives a release event before the frame callback requested in the same wl_surface.commit that attaches this wl_buffer to a surface, then the client is immediately free to reuse the buffer and its backing storage, and does not need a second buffer for the next surface content update. Typically this is possible, when the compositor maintains a copy of the wl_surface contents, e.g. as a GL texture. This is an important optimization for GL(ES) compositors with wl_shm clients. A wl_data_offer represents a piece of data offered for transfer by another client (the source client). It is used by the copy-and-paste and drag-and-drop mechanisms. The offer describes the different mime types that the data can be converted to and provides the mechanism for transferring the data directly from the source client. Indicate that the client can accept the given mime type, or NULL for not accepted. For objects of version 2 or older, this request is used by the client to give feedback whether the client can receive the given mime type, or NULL if none is accepted; the feedback does not determine whether the drag-and-drop operation succeeds or not. For objects of version 3 or newer, this request determines the final result of the drag-and-drop operation. If the end result is that no mime types were accepted, the drag-and-drop operation will be cancelled and the corresponding drag source will receive wl_data_source.cancelled. Clients may still use this event in conjunction with wl_data_source.action for feedback. To transfer the offered data, the client issues this request and indicates the mime type it wants to receive. The transfer happens through the passed file descriptor (typically created with the pipe system call). The source client writes the data in the mime type representation requested and then closes the file descriptor. The receiving client reads from the read end of the pipe until EOF and then closes its end, at which point the transfer is complete. This request may happen multiple times for different mime types, both before and after wl_data_device.drop. Drag-and-drop destination clients may preemptively fetch data or examine it more closely to determine acceptance. Destroy the data offer. Sent immediately after creating the wl_data_offer object. One event per offered mime type. Notifies the compositor that the drag destination successfully finished the drag-and-drop operation. Upon receiving this request, the compositor will emit wl_data_source.dnd_finished on the drag source client. It is a client error to perform other requests than wl_data_offer.destroy after this one. It is also an error to perform this request after a NULL mime type has been set in wl_data_offer.accept or no action was received through wl_data_offer.action. If wl_data_offer.finish request is received for a non drag and drop operation, the invalid_finish protocol error is raised. Sets the actions that the destination side client supports for this operation. This request may trigger the emission of wl_data_source.action and wl_data_offer.action events if the compositor needs to change the selected action. This request can be called multiple times throughout the drag-and-drop operation, typically in response to wl_data_device.enter or wl_data_device.motion events. This request determines the final result of the drag-and-drop operation. If the end result is that no action is accepted, the drag source will receive wl_data_source.cancelled. The dnd_actions argument must contain only values expressed in the wl_data_device_manager.dnd_actions enum, and the preferred_action argument must only contain one of those values set, otherwise it will result in a protocol error. While managing an "ask" action, the destination drag-and-drop client may perform further wl_data_offer.receive requests, and is expected to perform one last wl_data_offer.set_actions request with a preferred action other than "ask" (and optionally wl_data_offer.accept) before requesting wl_data_offer.finish, in order to convey the action selected by the user. If the preferred action is not in the wl_data_offer.source_actions mask, an error will be raised. If the "ask" action is dismissed (e.g. user cancellation), the client is expected to perform wl_data_offer.destroy right away. This request can only be made on drag-and-drop offers, a protocol error will be raised otherwise. This event indicates the actions offered by the data source. It will be sent immediately after creating the wl_data_offer object, or anytime the source side changes its offered actions through wl_data_source.set_actions. This event indicates the action selected by the compositor after matching the source/destination side actions. Only one action (or none) will be offered here. This event can be emitted multiple times during the drag-and-drop operation in response to destination side action changes through wl_data_offer.set_actions. This event will no longer be emitted after wl_data_device.drop happened on the drag-and-drop destination, the client must honor the last action received, or the last preferred one set through wl_data_offer.set_actions when handling an "ask" action. Compositors may also change the selected action on the fly, mainly in response to keyboard modifier changes during the drag-and-drop operation. The most recent action received is always the valid one. Prior to receiving wl_data_device.drop, the chosen action may change (e.g. due to keyboard modifiers being pressed). At the time of receiving wl_data_device.drop the drag-and-drop destination must honor the last action received. Action changes may still happen after wl_data_device.drop, especially on "ask" actions, where the drag-and-drop destination may choose another action afterwards. Action changes happening at this stage are always the result of inter-client negotiation, the compositor shall no longer be able to induce a different action. Upon "ask" actions, it is expected that the drag-and-drop destination may potentially choose a different action and/or mime type, based on wl_data_offer.source_actions and finally chosen by the user (e.g. popping up a menu with the available options). The final wl_data_offer.set_actions and wl_data_offer.accept requests must happen before the call to wl_data_offer.finish. The wl_data_source object is the source side of a wl_data_offer. It is created by the source client in a data transfer and provides a way to describe the offered data and a way to respond to requests to transfer the data. This request adds a mime type to the set of mime types advertised to targets. Can be called several times to offer multiple types. Destroy the data source. Sent when a target accepts pointer_focus or motion events. If a target does not accept any of the offered types, type is NULL. Used for feedback during drag-and-drop. Request for data from the client. Send the data as the specified mime type over the passed file descriptor, then close it. This data source is no longer valid. There are several reasons why this could happen: - The data source has been replaced by another data source. - The drag-and-drop operation was performed, but the drop destination did not accept any of the mime types offered through wl_data_source.target. - The drag-and-drop operation was performed, but the drop destination did not select any of the actions present in the mask offered through wl_data_source.action. - The drag-and-drop operation was performed but didn't happen over a surface. - The compositor cancelled the drag-and-drop operation (e.g. compositor dependent timeouts to avoid stale drag-and-drop transfers). The client should clean up and destroy this data source. For objects of version 2 or older, wl_data_source.cancelled will only be emitted if the data source was replaced by another data source. Sets the actions that the source side client supports for this operation. This request may trigger wl_data_source.action and wl_data_offer.action events if the compositor needs to change the selected action. The dnd_actions argument must contain only values expressed in the wl_data_device_manager.dnd_actions enum, otherwise it will result in a protocol error. This request must be made once only, and can only be made on sources used in drag-and-drop, so it must be performed before wl_data_device.start_drag. Attempting to use the source other than for drag-and-drop will raise a protocol error. The user performed the drop action. This event does not indicate acceptance, wl_data_source.cancelled may still be emitted afterwards if the drop destination does not accept any mime type. However, this event might however not be received if the compositor cancelled the drag-and-drop operation before this event could happen. Note that the data_source may still be used in the future and should not be destroyed here. The drop destination finished interoperating with this data source, so the client is now free to destroy this data source and free all associated data. If the action used to perform the operation was "move", the source can now delete the transferred data. This event indicates the action selected by the compositor after matching the source/destination side actions. Only one action (or none) will be offered here. This event can be emitted multiple times during the drag-and-drop operation, mainly in response to destination side changes through wl_data_offer.set_actions, and as the data device enters/leaves surfaces. It is only possible to receive this event after wl_data_source.dnd_drop_performed if the drag-and-drop operation ended in an "ask" action, in which case the final wl_data_source.action event will happen immediately before wl_data_source.dnd_finished. Compositors may also change the selected action on the fly, mainly in response to keyboard modifier changes during the drag-and-drop operation. The most recent action received is always the valid one. The chosen action may change alongside negotiation (e.g. an "ask" action can turn into a "move" operation), so the effects of the final action must always be applied in wl_data_offer.dnd_finished. Clients can trigger cursor surface changes from this point, so they reflect the current action. There is one wl_data_device per seat which can be obtained from the global wl_data_device_manager singleton. A wl_data_device provides access to inter-client data transfer mechanisms such as copy-and-paste and drag-and-drop. This request asks the compositor to start a drag-and-drop operation on behalf of the client. The source argument is the data source that provides the data for the eventual data transfer. If source is NULL, enter, leave and motion events are sent only to the client that initiated the drag and the client is expected to handle the data passing internally. If source is destroyed, the drag-and-drop session will be cancelled. The origin surface is the surface where the drag originates and the client must have an active implicit grab that matches the serial. The icon surface is an optional (can be NULL) surface that provides an icon to be moved around with the cursor. Initially, the top-left corner of the icon surface is placed at the cursor hotspot, but subsequent wl_surface.offset requests can move the relative position. Attach requests must be confirmed with wl_surface.commit as usual. The icon surface is given the role of a drag-and-drop icon. If the icon surface already has another role, it raises a protocol error. The input region is ignored for wl_surfaces with the role of a drag-and-drop icon. The given source may not be used in any further set_selection or start_drag requests. Attempting to reuse a previously-used source may send a used_source error. This request asks the compositor to set the selection to the data from the source on behalf of the client. To unset the selection, set the source to NULL. The given source may not be used in any further set_selection or start_drag requests. Attempting to reuse a previously-used source may send a used_source error. The data_offer event introduces a new wl_data_offer object, which will subsequently be used in either the data_device.enter event (for drag-and-drop) or the data_device.selection event (for selections). Immediately following the data_device.data_offer event, the new data_offer object will send out data_offer.offer events to describe the mime types it offers. This event is sent when an active drag-and-drop pointer enters a surface owned by the client. The position of the pointer at enter time is provided by the x and y arguments, in surface-local coordinates. This event is sent when the drag-and-drop pointer leaves the surface and the session ends. The client must destroy the wl_data_offer introduced at enter time at this point. This event is sent when the drag-and-drop pointer moves within the currently focused surface. The new position of the pointer is provided by the x and y arguments, in surface-local coordinates. The event is sent when a drag-and-drop operation is ended because the implicit grab is removed. The drag-and-drop destination is expected to honor the last action received through wl_data_offer.action, if the resulting action is "copy" or "move", the destination can still perform wl_data_offer.receive requests, and is expected to end all transfers with a wl_data_offer.finish request. If the resulting action is "ask", the action will not be considered final. The drag-and-drop destination is expected to perform one last wl_data_offer.set_actions request, or wl_data_offer.destroy in order to cancel the operation. The selection event is sent out to notify the client of a new wl_data_offer for the selection for this device. The data_device.data_offer and the data_offer.offer events are sent out immediately before this event to introduce the data offer object. The selection event is sent to a client immediately before receiving keyboard focus and when a new selection is set while the client has keyboard focus. The data_offer is valid until a new data_offer or NULL is received or until the client loses keyboard focus. Switching surface with keyboard focus within the same client doesn't mean a new selection will be sent. The client must destroy the previous selection data_offer, if any, upon receiving this event. This request destroys the data device. The wl_data_device_manager is a singleton global object that provides access to inter-client data transfer mechanisms such as copy-and-paste and drag-and-drop. These mechanisms are tied to a wl_seat and this interface lets a client get a wl_data_device corresponding to a wl_seat. Depending on the version bound, the objects created from the bound wl_data_device_manager object will have different requirements for functioning properly. See wl_data_source.set_actions, wl_data_offer.accept and wl_data_offer.finish for details. Create a new data source. Create a new data device for a given seat. This is a bitmask of the available/preferred actions in a drag-and-drop operation. In the compositor, the selected action is a result of matching the actions offered by the source and destination sides. "action" events with a "none" action will be sent to both source and destination if there is no match. All further checks will effectively happen on (source actions ∩ destination actions). In addition, compositors may also pick different actions in reaction to key modifiers being pressed. One common design that is used in major toolkits (and the behavior recommended for compositors) is: - If no modifiers are pressed, the first match (in bit order) will be used. - Pressing Shift selects "move", if enabled in the mask. - Pressing Control selects "copy", if enabled in the mask. Behavior beyond that is considered implementation-dependent. Compositors may for example bind other modifiers (like Alt/Meta) or drags initiated with other buttons than BTN_LEFT to specific actions (e.g. "ask"). This interface is implemented by servers that provide desktop-style user interfaces. It allows clients to associate a wl_shell_surface with a basic surface. Note! This protocol is deprecated and not intended for production use. For desktop-style user interfaces, use xdg_shell. Compositors and clients should not implement this interface. Create a shell surface for an existing surface. This gives the wl_surface the role of a shell surface. If the wl_surface already has another role, it raises a protocol error. Only one shell surface can be associated with a given surface. An interface that may be implemented by a wl_surface, for implementations that provide a desktop-style user interface. It provides requests to treat surfaces like toplevel, fullscreen or popup windows, move, resize or maximize them, associate metadata like title and class, etc. On the server side the object is automatically destroyed when the related wl_surface is destroyed. On the client side, wl_shell_surface_destroy() must be called before destroying the wl_surface object. A client must respond to a ping event with a pong request or the client may be deemed unresponsive. Start a pointer-driven move of the surface. This request must be used in response to a button press event. The server may ignore move requests depending on the state of the surface (e.g. fullscreen or maximized). These values are used to indicate which edge of a surface is being dragged in a resize operation. The server may use this information to adapt its behavior, e.g. choose an appropriate cursor image. Start a pointer-driven resizing of the surface. This request must be used in response to a button press event. The server may ignore resize requests depending on the state of the surface (e.g. fullscreen or maximized). Map the surface as a toplevel surface. A toplevel surface is not fullscreen, maximized or transient. These flags specify details of the expected behaviour of transient surfaces. Used in the set_transient request. Map the surface relative to an existing surface. The x and y arguments specify the location of the upper left corner of the surface relative to the upper left corner of the parent surface, in surface-local coordinates. The flags argument controls details of the transient behaviour. Hints to indicate to the compositor how to deal with a conflict between the dimensions of the surface and the dimensions of the output. The compositor is free to ignore this parameter. Map the surface as a fullscreen surface. If an output parameter is given then the surface will be made fullscreen on that output. If the client does not specify the output then the compositor will apply its policy - usually choosing the output on which the surface has the biggest surface area. The client may specify a method to resolve a size conflict between the output size and the surface size - this is provided through the method parameter. The framerate parameter is used only when the method is set to "driver", to indicate the preferred framerate. A value of 0 indicates that the client does not care about framerate. The framerate is specified in mHz, that is framerate of 60000 is 60Hz. A method of "scale" or "driver" implies a scaling operation of the surface, either via a direct scaling operation or a change of the output mode. This will override any kind of output scaling, so that mapping a surface with a buffer size equal to the mode can fill the screen independent of buffer_scale. A method of "fill" means we don't scale up the buffer, however any output scale is applied. This means that you may run into an edge case where the application maps a buffer with the same size of the output mode but buffer_scale 1 (thus making a surface larger than the output). In this case it is allowed to downscale the results to fit the screen. The compositor must reply to this request with a configure event with the dimensions for the output on which the surface will be made fullscreen. Map the surface as a popup. A popup surface is a transient surface with an added pointer grab. An existing implicit grab will be changed to owner-events mode, and the popup grab will continue after the implicit grab ends (i.e. releasing the mouse button does not cause the popup to be unmapped). The popup grab continues until the window is destroyed or a mouse button is pressed in any other client's window. A click in any of the client's surfaces is reported as normal, however, clicks in other clients' surfaces will be discarded and trigger the callback. The x and y arguments specify the location of the upper left corner of the surface relative to the upper left corner of the parent surface, in surface-local coordinates. Map the surface as a maximized surface. If an output parameter is given then the surface will be maximized on that output. If the client does not specify the output then the compositor will apply its policy - usually choosing the output on which the surface has the biggest surface area. The compositor will reply with a configure event telling the expected new surface size. The operation is completed on the next buffer attach to this surface. A maximized surface typically fills the entire output it is bound to, except for desktop elements such as panels. This is the main difference between a maximized shell surface and a fullscreen shell surface. The details depend on the compositor implementation. Set a short title for the surface. This string may be used to identify the surface in a task bar, window list, or other user interface elements provided by the compositor. The string must be encoded in UTF-8. Set a class for the surface. The surface class identifies the general class of applications to which the surface belongs. A common convention is to use the file name (or the full path if it is a non-standard location) of the application's .desktop file as the class. Ping a client to check if it is receiving events and sending requests. A client is expected to reply with a pong request. The configure event asks the client to resize its surface. The size is a hint, in the sense that the client is free to ignore it if it doesn't resize, pick a smaller size (to satisfy aspect ratio or resize in steps of NxM pixels). The edges parameter provides a hint about how the surface was resized. The client may use this information to decide how to adjust its content to the new size (e.g. a scrolling area might adjust its content position to leave the viewable content unmoved). The client is free to dismiss all but the last configure event it received. The width and height arguments specify the size of the window in surface-local coordinates. The popup_done event is sent out when a popup grab is broken, that is, when the user clicks a surface that doesn't belong to the client owning the popup surface. A surface is a rectangular area that may be displayed on zero or more outputs, and shown any number of times at the compositor's discretion. They can present wl_buffers, receive user input, and define a local coordinate system. The size of a surface (and relative positions on it) is described in surface-local coordinates, which may differ from the buffer coordinates of the pixel content, in case a buffer_transform or a buffer_scale is used. A surface without a "role" is fairly useless: a compositor does not know where, when or how to present it. The role is the purpose of a wl_surface. Examples of roles are a cursor for a pointer (as set by wl_pointer.set_cursor), a drag icon (wl_data_device.start_drag), a sub-surface (wl_subcompositor.get_subsurface), and a window as defined by a shell protocol (e.g. wl_shell.get_shell_surface). A surface can have only one role at a time. Initially a wl_surface does not have a role. Once a wl_surface is given a role, it is set permanently for the whole lifetime of the wl_surface object. Giving the current role again is allowed, unless explicitly forbidden by the relevant interface specification. Surface roles are given by requests in other interfaces such as wl_pointer.set_cursor. The request should explicitly mention that this request gives a role to a wl_surface. Often, this request also creates a new protocol object that represents the role and adds additional functionality to wl_surface. When a client wants to destroy a wl_surface, they must destroy this role object before the wl_surface, otherwise a defunct_role_object error is sent. Destroying the role object does not remove the role from the wl_surface, but it may stop the wl_surface from "playing the role". For instance, if a wl_subsurface object is destroyed, the wl_surface it was created for will be unmapped and forget its position and z-order. It is allowed to create a wl_subsurface for the same wl_surface again, but it is not allowed to use the wl_surface as a cursor (cursor is a different role than sub-surface, and role switching is not allowed). These errors can be emitted in response to wl_surface requests. Deletes the surface and invalidates its object ID. Set a buffer as the content of this surface. The new size of the surface is calculated based on the buffer size transformed by the inverse buffer_transform and the inverse buffer_scale. This means that at commit time the supplied buffer size must be an integer multiple of the buffer_scale. If that's not the case, an invalid_size error is sent. The x and y arguments specify the location of the new pending buffer's upper left corner, relative to the current buffer's upper left corner, in surface-local coordinates. In other words, the x and y, combined with the new surface size define in which directions the surface's size changes. Setting anything other than 0 as x and y arguments is discouraged, and should instead be replaced with using the separate wl_surface.offset request. When the bound wl_surface version is 5 or higher, passing any non-zero x or y is a protocol violation, and will result in an 'invalid_offset' error being raised. The x and y arguments are ignored and do not change the pending state. To achieve equivalent semantics, use wl_surface.offset. Surface contents are double-buffered state, see wl_surface.commit. The initial surface contents are void; there is no content. wl_surface.attach assigns the given wl_buffer as the pending wl_buffer. wl_surface.commit makes the pending wl_buffer the new surface contents, and the size of the surface becomes the size calculated from the wl_buffer, as described above. After commit, there is no pending buffer until the next attach. Committing a pending wl_buffer allows the compositor to read the pixels in the wl_buffer. The compositor may access the pixels at any time after the wl_surface.commit request. When the compositor will not access the pixels anymore, it will send the wl_buffer.release event. Only after receiving wl_buffer.release, the client may reuse the wl_buffer. A wl_buffer that has been attached and then replaced by another attach instead of committed will not receive a release event, and is not used by the compositor. If a pending wl_buffer has been committed to more than one wl_surface, the delivery of wl_buffer.release events becomes undefined. A well behaved client should not rely on wl_buffer.release events in this case. Alternatively, a client could create multiple wl_buffer objects from the same backing storage or use wp_linux_buffer_release. Destroying the wl_buffer after wl_buffer.release does not change the surface contents. Destroying the wl_buffer before wl_buffer.release is allowed as long as the underlying buffer storage isn't re-used (this can happen e.g. on client process termination). However, if the client destroys the wl_buffer before receiving the wl_buffer.release event and mutates the underlying buffer storage, the surface contents become undefined immediately. If wl_surface.attach is sent with a NULL wl_buffer, the following wl_surface.commit will remove the surface content. If a pending wl_buffer has been destroyed, the result is not specified. Many compositors are known to remove the surface content on the following wl_surface.commit, but this behaviour is not universal. Clients seeking to maximise compatibility should not destroy pending buffers and should ensure that they explicitly remove content from surfaces, even after destroying buffers. This request is used to describe the regions where the pending buffer is different from the current surface contents, and where the surface therefore needs to be repainted. The compositor ignores the parts of the damage that fall outside of the surface. Damage is double-buffered state, see wl_surface.commit. The damage rectangle is specified in surface-local coordinates, where x and y specify the upper left corner of the damage rectangle. The initial value for pending damage is empty: no damage. wl_surface.damage adds pending damage: the new pending damage is the union of old pending damage and the given rectangle. wl_surface.commit assigns pending damage as the current damage, and clears pending damage. The server will clear the current damage as it repaints the surface. Note! New clients should not use this request. Instead damage can be posted with wl_surface.damage_buffer which uses buffer coordinates instead of surface coordinates. Request a notification when it is a good time to start drawing a new frame, by creating a frame callback. This is useful for throttling redrawing operations, and driving animations. When a client is animating on a wl_surface, it can use the 'frame' request to get notified when it is a good time to draw and commit the next frame of animation. If the client commits an update earlier than that, it is likely that some updates will not make it to the display, and the client is wasting resources by drawing too often. The frame request will take effect on the next wl_surface.commit. The notification will only be posted for one frame unless requested again. For a wl_surface, the notifications are posted in the order the frame requests were committed. The server must send the notifications so that a client will not send excessive updates, while still allowing the highest possible update rate for clients that wait for the reply before drawing again. The server should give some time for the client to draw and commit after sending the frame callback events to let it hit the next output refresh. A server should avoid signaling the frame callbacks if the surface is not visible in any way, e.g. the surface is off-screen, or completely obscured by other opaque surfaces. The object returned by this request will be destroyed by the compositor after the callback is fired and as such the client must not attempt to use it after that point. The callback_data passed in the callback is the current time, in milliseconds, with an undefined base. This request sets the region of the surface that contains opaque content. The opaque region is an optimization hint for the compositor that lets it optimize the redrawing of content behind opaque regions. Setting an opaque region is not required for correct behaviour, but marking transparent content as opaque will result in repaint artifacts. The opaque region is specified in surface-local coordinates. The compositor ignores the parts of the opaque region that fall outside of the surface. Opaque region is double-buffered state, see wl_surface.commit. wl_surface.set_opaque_region changes the pending opaque region. wl_surface.commit copies the pending region to the current region. Otherwise, the pending and current regions are never changed. The initial value for an opaque region is empty. Setting the pending opaque region has copy semantics, and the wl_region object can be destroyed immediately. A NULL wl_region causes the pending opaque region to be set to empty. This request sets the region of the surface that can receive pointer and touch events. Input events happening outside of this region will try the next surface in the server surface stack. The compositor ignores the parts of the input region that fall outside of the surface. The input region is specified in surface-local coordinates. Input region is double-buffered state, see wl_surface.commit. wl_surface.set_input_region changes the pending input region. wl_surface.commit copies the pending region to the current region. Otherwise the pending and current regions are never changed, except cursor and icon surfaces are special cases, see wl_pointer.set_cursor and wl_data_device.start_drag. The initial value for an input region is infinite. That means the whole surface will accept input. Setting the pending input region has copy semantics, and the wl_region object can be destroyed immediately. A NULL wl_region causes the input region to be set to infinite. Surface state (input, opaque, and damage regions, attached buffers, etc.) is double-buffered. Protocol requests modify the pending state, as opposed to the active state in use by the compositor. A commit request atomically creates a content update from the pending state, even if the pending state has not been touched. The content update is placed in a queue until it becomes active. After commit, the new pending state is as documented for each related request. When the content update is applied, the wl_buffer is applied before all other state. This means that all coordinates in double-buffered state are relative to the newly attached wl_buffers, except for wl_surface.attach itself. If there is no newly attached wl_buffer, the coordinates are relative to the previous content update. All requests that need a commit to become effective are documented to affect double-buffered state. Other interfaces may add further double-buffered surface state. This is emitted whenever a surface's creation, movement, or resizing results in some part of it being within the scanout region of an output. Note that a surface may be overlapping with zero or more outputs. This is emitted whenever a surface's creation, movement, or resizing results in it no longer having any part of it within the scanout region of an output. Clients should not use the number of outputs the surface is on for frame throttling purposes. The surface might be hidden even if no leave event has been sent, and the compositor might expect new surface content updates even if no enter event has been sent. The frame event should be used instead. This request sets the transformation that the client has already applied to the content of the buffer. The accepted values for the transform parameter are the values for wl_output.transform. The compositor applies the inverse of this transformation whenever it uses the buffer contents. Buffer transform is double-buffered state, see wl_surface.commit. A newly created surface has its buffer transformation set to normal. wl_surface.set_buffer_transform changes the pending buffer transformation. wl_surface.commit copies the pending buffer transformation to the current one. Otherwise, the pending and current values are never changed. The purpose of this request is to allow clients to render content according to the output transform, thus permitting the compositor to use certain optimizations even if the display is rotated. Using hardware overlays and scanning out a client buffer for fullscreen surfaces are examples of such optimizations. Those optimizations are highly dependent on the compositor implementation, so the use of this request should be considered on a case-by-case basis. Note that if the transform value includes 90 or 270 degree rotation, the width of the buffer will become the surface height and the height of the buffer will become the surface width. If transform is not one of the values from the wl_output.transform enum the invalid_transform protocol error is raised. This request sets an optional scaling factor on how the compositor interprets the contents of the buffer attached to the window. Buffer scale is double-buffered state, see wl_surface.commit. A newly created surface has its buffer scale set to 1. wl_surface.set_buffer_scale changes the pending buffer scale. wl_surface.commit copies the pending buffer scale to the current one. Otherwise, the pending and current values are never changed. The purpose of this request is to allow clients to supply higher resolution buffer data for use on high resolution outputs. It is intended that you pick the same buffer scale as the scale of the output that the surface is displayed on. This means the compositor can avoid scaling when rendering the surface on that output. Note that if the scale is larger than 1, then you have to attach a buffer that is larger (by a factor of scale in each dimension) than the desired surface size. If scale is not greater than 0 the invalid_scale protocol error is raised. This request is used to describe the regions where the pending buffer is different from the current surface contents, and where the surface therefore needs to be repainted. The compositor ignores the parts of the damage that fall outside of the surface. Damage is double-buffered state, see wl_surface.commit. The damage rectangle is specified in buffer coordinates, where x and y specify the upper left corner of the damage rectangle. The initial value for pending damage is empty: no damage. wl_surface.damage_buffer adds pending damage: the new pending damage is the union of old pending damage and the given rectangle. wl_surface.commit assigns pending damage as the current damage, and clears pending damage. The server will clear the current damage as it repaints the surface. This request differs from wl_surface.damage in only one way - it takes damage in buffer coordinates instead of surface-local coordinates. While this generally is more intuitive than surface coordinates, it is especially desirable when using wp_viewport or when a drawing library (like EGL) is unaware of buffer scale and buffer transform. Note: Because buffer transformation changes and damage requests may be interleaved in the protocol stream, it is impossible to determine the actual mapping between surface and buffer damage until wl_surface.commit time. Therefore, compositors wishing to take both kinds of damage into account will have to accumulate damage from the two requests separately and only transform from one to the other after receiving the wl_surface.commit. The x and y arguments specify the location of the new pending buffer's upper left corner, relative to the current buffer's upper left corner, in surface-local coordinates. In other words, the x and y, combined with the new surface size define in which directions the surface's size changes. Surface location offset is double-buffered state, see wl_surface.commit. This request is semantically equivalent to and the replaces the x and y arguments in the wl_surface.attach request in wl_surface versions prior to 5. See wl_surface.attach for details. This event indicates the preferred buffer scale for this surface. It is sent whenever the compositor's preference changes. Before receiving this event the preferred buffer scale for this surface is 1. It is intended that scaling aware clients use this event to scale their content and use wl_surface.set_buffer_scale to indicate the scale they have rendered with. This allows clients to supply a higher detail buffer. The compositor shall emit a scale value greater than 0. This event indicates the preferred buffer transform for this surface. It is sent whenever the compositor's preference changes. Before receiving this event the preferred buffer transform for this surface is normal. Applying this transformation to the surface buffer contents and using wl_surface.set_buffer_transform might allow the compositor to use the surface buffer more efficiently. A seat is a group of keyboards, pointer and touch devices. This object is published as a global during start up, or when such a device is hot plugged. A seat typically has a pointer and maintains a keyboard focus and a pointer focus. This is a bitmask of capabilities this seat has; if a member is set, then it is present on the seat. These errors can be emitted in response to wl_seat requests. This is emitted whenever a seat gains or loses the pointer, keyboard or touch capabilities. The argument is a capability enum containing the complete set of capabilities this seat has. When the pointer capability is added, a client may create a wl_pointer object using the wl_seat.get_pointer request. This object will receive pointer events until the capability is removed in the future. When the pointer capability is removed, a client should destroy the wl_pointer objects associated with the seat where the capability was removed, using the wl_pointer.release request. No further pointer events will be received on these objects. In some compositors, if a seat regains the pointer capability and a client has a previously obtained wl_pointer object of version 4 or less, that object may start sending pointer events again. This behavior is considered a misinterpretation of the intended behavior and must not be relied upon by the client. wl_pointer objects of version 5 or later must not send events if created before the most recent event notifying the client of an added pointer capability. The above behavior also applies to wl_keyboard and wl_touch with the keyboard and touch capabilities, respectively. The ID provided will be initialized to the wl_pointer interface for this seat. This request only takes effect if the seat has the pointer capability, or has had the pointer capability in the past. It is a protocol violation to issue this request on a seat that has never had the pointer capability. The missing_capability error will be sent in this case. The ID provided will be initialized to the wl_keyboard interface for this seat. This request only takes effect if the seat has the keyboard capability, or has had the keyboard capability in the past. It is a protocol violation to issue this request on a seat that has never had the keyboard capability. The missing_capability error will be sent in this case. The ID provided will be initialized to the wl_touch interface for this seat. This request only takes effect if the seat has the touch capability, or has had the touch capability in the past. It is a protocol violation to issue this request on a seat that has never had the touch capability. The missing_capability error will be sent in this case. In a multi-seat configuration the seat name can be used by clients to help identify which physical devices the seat represents. The seat name is a UTF-8 string with no convention defined for its contents. Each name is unique among all wl_seat globals. The name is only guaranteed to be unique for the current compositor instance. The same seat names are used for all clients. Thus, the name can be shared across processes to refer to a specific wl_seat global. The name event is sent after binding to the seat global. This event is only sent once per seat object, and the name does not change over the lifetime of the wl_seat global. Compositors may re-use the same seat name if the wl_seat global is destroyed and re-created later. Using this request a client can tell the server that it is not going to use the seat object anymore. The wl_pointer interface represents one or more input devices, such as mice, which control the pointer location and pointer_focus of a seat. The wl_pointer interface generates motion, enter and leave events for the surfaces that the pointer is located over, and button and axis events for button presses, button releases and scrolling. Set the pointer surface, i.e., the surface that contains the pointer image (cursor). This request gives the surface the role of a cursor. If the surface already has another role, it raises a protocol error. The cursor actually changes only if the pointer focus for this device is one of the requesting client's surfaces or the surface parameter is the current pointer surface. If there was a previous surface set with this request it is replaced. If surface is NULL, the pointer image is hidden. The parameters hotspot_x and hotspot_y define the position of the pointer surface relative to the pointer location. Its top-left corner is always at (x, y) - (hotspot_x, hotspot_y), where (x, y) are the coordinates of the pointer location, in surface-local coordinates. On wl_surface.offset requests to the pointer surface, hotspot_x and hotspot_y are decremented by the x and y parameters passed to the request. The offset must be applied by wl_surface.commit as usual. The hotspot can also be updated by passing the currently set pointer surface to this request with new values for hotspot_x and hotspot_y. The input region is ignored for wl_surfaces with the role of a cursor. When the use as a cursor ends, the wl_surface is unmapped. The serial parameter must match the latest wl_pointer.enter serial number sent to the client. Otherwise the request will be ignored. Notification that this seat's pointer is focused on a certain surface. When a seat's focus enters a surface, the pointer image is undefined and a client should respond to this event by setting an appropriate pointer image with the set_cursor request. Notification that this seat's pointer is no longer focused on a certain surface. The leave notification is sent before the enter notification for the new focus. Notification of pointer location change. The arguments surface_x and surface_y are the location relative to the focused surface. Describes the physical state of a button that produced the button event. Mouse button click and release notifications. The location of the click is given by the last motion or enter event. The time argument is a timestamp with millisecond granularity, with an undefined base. The button is a button code as defined in the Linux kernel's linux/input-event-codes.h header file, e.g. BTN_LEFT. Any 16-bit button code value is reserved for future additions to the kernel's event code list. All other button codes above 0xFFFF are currently undefined but may be used in future versions of this protocol. Describes the axis types of scroll events. Scroll and other axis notifications. For scroll events (vertical and horizontal scroll axes), the value parameter is the length of a vector along the specified axis in a coordinate space identical to those of motion events, representing a relative movement along the specified axis. For devices that support movements non-parallel to axes multiple axis events will be emitted. When applicable, for example for touch pads, the server can choose to emit scroll events where the motion vector is equivalent to a motion event vector. When applicable, a client can transform its content relative to the scroll distance. Using this request a client can tell the server that it is not going to use the pointer object anymore. This request destroys the pointer proxy object, so clients must not call wl_pointer_destroy() after using this request. Indicates the end of a set of events that logically belong together. A client is expected to accumulate the data in all events within the frame before proceeding. All wl_pointer events before a wl_pointer.frame event belong logically together. For example, in a diagonal scroll motion the compositor will send an optional wl_pointer.axis_source event, two wl_pointer.axis events (horizontal and vertical) and finally a wl_pointer.frame event. The client may use this information to calculate a diagonal vector for scrolling. When multiple wl_pointer.axis events occur within the same frame, the motion vector is the combined motion of all events. When a wl_pointer.axis and a wl_pointer.axis_stop event occur within the same frame, this indicates that axis movement in one axis has stopped but continues in the other axis. When multiple wl_pointer.axis_stop events occur within the same frame, this indicates that these axes stopped in the same instance. A wl_pointer.frame event is sent for every logical event group, even if the group only contains a single wl_pointer event. Specifically, a client may get a sequence: motion, frame, button, frame, axis, frame, axis_stop, frame. The wl_pointer.enter and wl_pointer.leave events are logical events generated by the compositor and not the hardware. These events are also grouped by a wl_pointer.frame. When a pointer moves from one surface to another, a compositor should group the wl_pointer.leave event within the same wl_pointer.frame. However, a client must not rely on wl_pointer.leave and wl_pointer.enter being in the same wl_pointer.frame. Compositor-specific policies may require the wl_pointer.leave and wl_pointer.enter event being split across multiple wl_pointer.frame groups. Describes the source types for axis events. This indicates to the client how an axis event was physically generated; a client may adjust the user interface accordingly. For example, scroll events from a "finger" source may be in a smooth coordinate space with kinetic scrolling whereas a "wheel" source may be in discrete steps of a number of lines. The "continuous" axis source is a device generating events in a continuous coordinate space, but using something other than a finger. One example for this source is button-based scrolling where the vertical motion of a device is converted to scroll events while a button is held down. The "wheel tilt" axis source indicates that the actual device is a wheel but the scroll event is not caused by a rotation but a (usually sideways) tilt of the wheel. Source information for scroll and other axes. This event does not occur on its own. It is sent before a wl_pointer.frame event and carries the source information for all events within that frame. The source specifies how this event was generated. If the source is wl_pointer.axis_source.finger, a wl_pointer.axis_stop event will be sent when the user lifts the finger off the device. If the source is wl_pointer.axis_source.wheel, wl_pointer.axis_source.wheel_tilt or wl_pointer.axis_source.continuous, a wl_pointer.axis_stop event may or may not be sent. Whether a compositor sends an axis_stop event for these sources is hardware-specific and implementation-dependent; clients must not rely on receiving an axis_stop event for these scroll sources and should treat scroll sequences from these scroll sources as unterminated by default. This event is optional. If the source is unknown for a particular axis event sequence, no event is sent. Only one wl_pointer.axis_source event is permitted per frame. The order of wl_pointer.axis_discrete and wl_pointer.axis_source is not guaranteed. Stop notification for scroll and other axes. For some wl_pointer.axis_source types, a wl_pointer.axis_stop event is sent to notify a client that the axis sequence has terminated. This enables the client to implement kinetic scrolling. See the wl_pointer.axis_source documentation for information on when this event may be generated. Any wl_pointer.axis events with the same axis_source after this event should be considered as the start of a new axis motion. The timestamp is to be interpreted identical to the timestamp in the wl_pointer.axis event. The timestamp value may be the same as a preceding wl_pointer.axis event. Discrete step information for scroll and other axes. This event carries the axis value of the wl_pointer.axis event in discrete steps (e.g. mouse wheel clicks). This event is deprecated with wl_pointer version 8 - this event is not sent to clients supporting version 8 or later. This event does not occur on its own, it is coupled with a wl_pointer.axis event that represents this axis value on a continuous scale. The protocol guarantees that each axis_discrete event is always followed by exactly one axis event with the same axis number within the same wl_pointer.frame. Note that the protocol allows for other events to occur between the axis_discrete and its coupled axis event, including other axis_discrete or axis events. A wl_pointer.frame must not contain more than one axis_discrete event per axis type. This event is optional; continuous scrolling devices like two-finger scrolling on touchpads do not have discrete steps and do not generate this event. The discrete value carries the directional information. e.g. a value of -2 is two steps towards the negative direction of this axis. The axis number is identical to the axis number in the associated axis event. The order of wl_pointer.axis_discrete and wl_pointer.axis_source is not guaranteed. Discrete high-resolution scroll information. This event carries high-resolution wheel scroll information, with each multiple of 120 representing one logical scroll step (a wheel detent). For example, an axis_value120 of 30 is one quarter of a logical scroll step in the positive direction, a value120 of -240 are two logical scroll steps in the negative direction within the same hardware event. Clients that rely on discrete scrolling should accumulate the value120 to multiples of 120 before processing the event. The value120 must not be zero. This event replaces the wl_pointer.axis_discrete event in clients supporting wl_pointer version 8 or later. Where a wl_pointer.axis_source event occurs in the same wl_pointer.frame, the axis source applies to this event. The order of wl_pointer.axis_value120 and wl_pointer.axis_source is not guaranteed. This specifies the direction of the physical motion that caused a wl_pointer.axis event, relative to the wl_pointer.axis direction. Relative directional information of the entity causing the axis motion. For a wl_pointer.axis event, the wl_pointer.axis_relative_direction event specifies the movement direction of the entity causing the wl_pointer.axis event. For example: - if a user's fingers on a touchpad move down and this causes a wl_pointer.axis vertical_scroll down event, the physical direction is 'identical' - if a user's fingers on a touchpad move down and this causes a wl_pointer.axis vertical_scroll up scroll up event ('natural scrolling'), the physical direction is 'inverted'. A client may use this information to adjust scroll motion of components. Specifically, enabling natural scrolling causes the content to change direction compared to traditional scrolling. Some widgets like volume control sliders should usually match the physical direction regardless of whether natural scrolling is active. This event enables clients to match the scroll direction of a widget to the physical direction. This event does not occur on its own, it is coupled with a wl_pointer.axis event that represents this axis value. The protocol guarantees that each axis_relative_direction event is always followed by exactly one axis event with the same axis number within the same wl_pointer.frame. Note that the protocol allows for other events to occur between the axis_relative_direction and its coupled axis event. The axis number is identical to the axis number in the associated axis event. The order of wl_pointer.axis_relative_direction, wl_pointer.axis_discrete and wl_pointer.axis_source is not guaranteed. The wl_keyboard interface represents one or more keyboards associated with a seat. Each wl_keyboard has the following logical state: - an active surface (possibly null), - the keys currently logically down, - the active modifiers, - the active group. By default, the active surface is null, the keys currently logically down are empty, the active modifiers and the active group are 0. This specifies the format of the keymap provided to the client with the wl_keyboard.keymap event. This event provides a file descriptor to the client which can be memory-mapped in read-only mode to provide a keyboard mapping description. From version 7 onwards, the fd must be mapped with MAP_PRIVATE by the recipient, as MAP_SHARED may fail. Notification that this seat's keyboard focus is on a certain surface. The compositor must send the wl_keyboard.modifiers event after this event. In the wl_keyboard logical state, this event sets the active surface to the surface argument and the keys currently logically down to the keys in the keys argument. The compositor must not send this event if the wl_keyboard already had an active surface immediately before this event. Notification that this seat's keyboard focus is no longer on a certain surface. The leave notification is sent before the enter notification for the new focus. In the wl_keyboard logical state, this event resets all values to their defaults. The compositor must not send this event if the active surface of the wl_keyboard was not equal to the surface argument immediately before this event. Describes the physical state of a key that produced the key event. A key was pressed or released. The time argument is a timestamp with millisecond granularity, with an undefined base. The key is a platform-specific key code that can be interpreted by feeding it to the keyboard mapping (see the keymap event). If this event produces a change in modifiers, then the resulting wl_keyboard.modifiers event must be sent after this event. In the wl_keyboard logical state, this event adds the key to the keys currently logically down (if the state argument is pressed) or removes the key from the keys currently logically down (if the state argument is released). The compositor must not send this event if the wl_keyboard did not have an active surface immediately before this event. The compositor must not send this event if state is pressed (resp. released) and the key was already logically down (resp. was not logically down) immediately before this event. Notifies clients that the modifier and/or group state has changed, and it should update its local state. The compositor may send this event without a surface of the client having keyboard focus, for example to tie modifier information to pointer focus instead. If a modifier event with pressed modifiers is sent without a prior enter event, the client can assume the modifier state is valid until it receives the next wl_keyboard.modifiers event. In order to reset the modifier state again, the compositor can send a wl_keyboard.modifiers event with no pressed modifiers. In the wl_keyboard logical state, this event updates the modifiers and group. Informs the client about the keyboard's repeat rate and delay. This event is sent as soon as the wl_keyboard object has been created, and is guaranteed to be received by the client before any key press event. Negative values for either rate or delay are illegal. A rate of zero will disable any repeating (regardless of the value of delay). This event can be sent later on as well with a new value if necessary, so clients should continue listening for the event past the creation of wl_keyboard. The wl_touch interface represents a touchscreen associated with a seat. Touch interactions can consist of one or more contacts. For each contact, a series of events is generated, starting with a down event, followed by zero or more motion events, and ending with an up event. Events relating to the same contact point can be identified by the ID of the sequence. A new touch point has appeared on the surface. This touch point is assigned a unique ID. Future events from this touch point reference this ID. The ID ceases to be valid after a touch up event and may be reused in the future. The touch point has disappeared. No further events will be sent for this touch point and the touch point's ID is released and may be reused in a future touch down event. A touch point has changed coordinates. Indicates the end of a set of events that logically belong together. A client is expected to accumulate the data in all events within the frame before proceeding. A wl_touch.frame terminates at least one event but otherwise no guarantee is provided about the set of events within a frame. A client must assume that any state not updated in a frame is unchanged from the previously known state. Sent if the compositor decides the touch stream is a global gesture. No further events are sent to the clients from that particular gesture. Touch cancellation applies to all touch points currently active on this client's surface. The client is responsible for finalizing the touch points, future touch points on this surface may reuse the touch point ID. No frame event is required after the cancel event. Sent when a touchpoint has changed its shape. This event does not occur on its own. It is sent before a wl_touch.frame event and carries the new shape information for any previously reported, or new touch points of that frame. Other events describing the touch point such as wl_touch.down, wl_touch.motion or wl_touch.orientation may be sent within the same wl_touch.frame. A client should treat these events as a single logical touch point update. The order of wl_touch.shape, wl_touch.orientation and wl_touch.motion is not guaranteed. A wl_touch.down event is guaranteed to occur before the first wl_touch.shape event for this touch ID but both events may occur within the same wl_touch.frame. A touchpoint shape is approximated by an ellipse through the major and minor axis length. The major axis length describes the longer diameter of the ellipse, while the minor axis length describes the shorter diameter. Major and minor are orthogonal and both are specified in surface-local coordinates. The center of the ellipse is always at the touchpoint location as reported by wl_touch.down or wl_touch.move. This event is only sent by the compositor if the touch device supports shape reports. The client has to make reasonable assumptions about the shape if it did not receive this event. Sent when a touchpoint has changed its orientation. This event does not occur on its own. It is sent before a wl_touch.frame event and carries the new shape information for any previously reported, or new touch points of that frame. Other events describing the touch point such as wl_touch.down, wl_touch.motion or wl_touch.shape may be sent within the same wl_touch.frame. A client should treat these events as a single logical touch point update. The order of wl_touch.shape, wl_touch.orientation and wl_touch.motion is not guaranteed. A wl_touch.down event is guaranteed to occur before the first wl_touch.orientation event for this touch ID but both events may occur within the same wl_touch.frame. The orientation describes the clockwise angle of a touchpoint's major axis to the positive surface y-axis and is normalized to the -180 to +180 degree range. The granularity of orientation depends on the touch device, some devices only support binary rotation values between 0 and 90 degrees. This event is only sent by the compositor if the touch device supports orientation reports. An output describes part of the compositor geometry. The compositor works in the 'compositor coordinate system' and an output corresponds to a rectangular area in that space that is actually visible. This typically corresponds to a monitor that displays part of the compositor space. This object is published as global during start up, or when a monitor is hotplugged. This enumeration describes how the physical pixels on an output are laid out. This describes transformations that clients and compositors apply to buffer contents. The flipped values correspond to an initial flip around a vertical axis followed by rotation. The purpose is mainly to allow clients to render accordingly and tell the compositor, so that for fullscreen surfaces, the compositor will still be able to scan out directly from client surfaces. The geometry event describes geometric properties of the output. The event is sent when binding to the output object and whenever any of the properties change. The physical size can be set to zero if it doesn't make sense for this output (e.g. for projectors or virtual outputs). The geometry event will be followed by a done event (starting from version 2). Clients should use wl_surface.preferred_buffer_transform instead of the transform advertised by this event to find the preferred buffer transform to use for a surface. Note: wl_output only advertises partial information about the output position and identification. Some compositors, for instance those not implementing a desktop-style output layout or those exposing virtual outputs, might fake this information. Instead of using x and y, clients should use xdg_output.logical_position. Instead of using make and model, clients should use name and description. These flags describe properties of an output mode. They are used in the flags bitfield of the mode event. The mode event describes an available mode for the output. The event is sent when binding to the output object and there will always be one mode, the current mode. The event is sent again if an output changes mode, for the mode that is now current. In other words, the current mode is always the last mode that was received with the current flag set. Non-current modes are deprecated. A compositor can decide to only advertise the current mode and never send other modes. Clients should not rely on non-current modes. The size of a mode is given in physical hardware units of the output device. This is not necessarily the same as the output size in the global compositor space. For instance, the output may be scaled, as described in wl_output.scale, or transformed, as described in wl_output.transform. Clients willing to retrieve the output size in the global compositor space should use xdg_output.logical_size instead. The vertical refresh rate can be set to zero if it doesn't make sense for this output (e.g. for virtual outputs). The mode event will be followed by a done event (starting from version 2). Clients should not use the refresh rate to schedule frames. Instead, they should use the wl_surface.frame event or the presentation-time protocol. Note: this information is not always meaningful for all outputs. Some compositors, such as those exposing virtual outputs, might fake the refresh rate or the size. This event is sent after all other properties have been sent after binding to the output object and after any other property changes done after that. This allows changes to the output properties to be seen as atomic, even if they happen via multiple events. This event contains scaling geometry information that is not in the geometry event. It may be sent after binding the output object or if the output scale changes later. The compositor will emit a non-zero, positive value for scale. If it is not sent, the client should assume a scale of 1. A scale larger than 1 means that the compositor will automatically scale surface buffers by this amount when rendering. This is used for very high resolution displays where applications rendering at the native resolution would be too small to be legible. Clients should use wl_surface.preferred_buffer_scale instead of this event to find the preferred buffer scale to use for a surface. The scale event will be followed by a done event. Using this request a client can tell the server that it is not going to use the output object anymore. Many compositors will assign user-friendly names to their outputs, show them to the user, allow the user to refer to an output, etc. The client may wish to know this name as well to offer the user similar behaviors. The name is a UTF-8 string with no convention defined for its contents. Each name is unique among all wl_output globals. The name is only guaranteed to be unique for the compositor instance. The same output name is used for all clients for a given wl_output global. Thus, the name can be shared across processes to refer to a specific wl_output global. The name is not guaranteed to be persistent across sessions, thus cannot be used to reliably identify an output in e.g. configuration files. Examples of names include 'HDMI-A-1', 'WL-1', 'X11-1', etc. However, do not assume that the name is a reflection of an underlying DRM connector, X11 connection, etc. The name event is sent after binding the output object. This event is only sent once per output object, and the name does not change over the lifetime of the wl_output global. Compositors may re-use the same output name if the wl_output global is destroyed and re-created later. Compositors should avoid re-using the same name if possible. The name event will be followed by a done event. Many compositors can produce human-readable descriptions of their outputs. The client may wish to know this description as well, e.g. for output selection purposes. The description is a UTF-8 string with no convention defined for its contents. The description is not guaranteed to be unique among all wl_output globals. Examples might include 'Foocorp 11" Display' or 'Virtual X11 output via :1'. The description event is sent after binding the output object and whenever the description changes. The description is optional, and may not be sent at all. The description event will be followed by a done event. A region object describes an area. Region objects are used to describe the opaque and input regions of a surface. Destroy the region. This will invalidate the object ID. Add the specified rectangle to the region. Subtract the specified rectangle from the region. The global interface exposing sub-surface compositing capabilities. A wl_surface, that has sub-surfaces associated, is called the parent surface. Sub-surfaces can be arbitrarily nested and create a tree of sub-surfaces. The root surface in a tree of sub-surfaces is the main surface. The main surface cannot be a sub-surface, because sub-surfaces must always have a parent. A main surface with its sub-surfaces forms a (compound) window. For window management purposes, this set of wl_surface objects is to be considered as a single window, and it should also behave as such. The aim of sub-surfaces is to offload some of the compositing work within a window from clients to the compositor. A prime example is a video player with decorations and video in separate wl_surface objects. This should allow the compositor to pass YUV video buffer processing to dedicated overlay hardware when possible. 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. 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 the bad_surface 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. The parent surface must not be one of the child surface's descendants, and the parent must be different from the child surface, otherwise the bad_parent protocol error is raised. This request modifies the behaviour of wl_surface.commit request on the sub-surface, see the documentation on wl_subsurface interface. An additional interface to a wl_surface object, which has been made a sub-surface. A sub-surface has one parent surface. A sub-surface's size and position are not limited to that of the parent. Particularly, a sub-surface is not automatically clipped to its parent's area. A sub-surface becomes mapped, when a non-NULL wl_buffer is applied and the parent surface is mapped. The order of which one happens first is irrelevant. A sub-surface is hidden if the parent becomes hidden, or if a NULL wl_buffer is applied. These rules apply recursively through the tree of surfaces. The behaviour of a wl_surface.commit request on a sub-surface depends on the sub-surface's mode. The possible modes are synchronized and desynchronized, see methods wl_subsurface.set_sync and wl_subsurface.set_desync. Synchronized mode caches the wl_surface state to be applied when the parent's state gets applied, and desynchronized mode applies the pending wl_surface state directly. A sub-surface is initially in the synchronized mode. Sub-surfaces also have another kind of state, which is managed by wl_subsurface requests, as opposed to wl_surface requests. This state includes the sub-surface position relative to the parent surface (wl_subsurface.set_position), and the stacking order of the parent and its sub-surfaces (wl_subsurface.place_above and .place_below). This state is applied when the parent surface's wl_surface state is applied, regardless of the sub-surface's mode. As the exception, set_sync and set_desync are effective immediately. The main surface can be thought to be always in desynchronized mode, since it does not have a parent in the sub-surfaces sense. Even if a sub-surface is in desynchronized mode, it will behave as in synchronized mode, if its parent surface behaves as in synchronized mode. This rule is applied recursively throughout the tree of surfaces. This means, that one can set a sub-surface into synchronized mode, and then assume that all its child and grand-child sub-surfaces are synchronized, too, without explicitly setting them. Destroying a sub-surface takes effect immediately. If you need to synchronize the removal of a sub-surface to the parent surface update, unmap the sub-surface first by attaching a NULL wl_buffer, update parent, and then destroy the sub-surface. If the parent wl_surface object is destroyed, the sub-surface is unmapped. A sub-surface never has the keyboard focus of any seat. The wl_surface.offset request is ignored: clients must use set_position instead to move the sub-surface. The sub-surface interface is removed from the wl_surface object that was turned into a sub-surface with a wl_subcompositor.get_subsurface request. The wl_surface's association to the parent is deleted. The wl_surface is unmapped immediately. This schedules a sub-surface position change. The sub-surface will be moved so that its origin (top left corner pixel) will be at the location x, y of the parent surface coordinate system. The coordinates are not restricted to the parent surface area. Negative values are allowed. The scheduled coordinates will take effect whenever the state of the parent surface is applied. If more than one set_position request is invoked by the client before the commit of the parent surface, the position of a new request always replaces the scheduled position from any previous request. The initial position is 0, 0. This sub-surface is taken from the stack, and put back just above the reference surface, changing the z-order of the sub-surfaces. The reference surface must be one of the sibling surfaces, or the parent surface. Using any other surface, including this sub-surface, will cause a protocol error. The z-order is double-buffered. Requests are handled in order and applied immediately to a pending state. The final pending state is copied to the active state the next time the state of the parent surface is applied. A new sub-surface is initially added as the top-most in the stack of its siblings and parent. The sub-surface is placed just below the reference surface. See wl_subsurface.place_above. Change the commit behaviour of the sub-surface to synchronized mode, also described as the parent dependent mode. In synchronized mode, wl_surface.commit on a sub-surface will accumulate the committed state in a cache, but the state will not be applied and hence will not change the compositor output. The cached state is applied to the sub-surface immediately after the parent surface's state is applied. This ensures atomic updates of the parent and all its synchronized sub-surfaces. Applying the cached state will invalidate the cache, so further parent surface commits do not (re-)apply old state. See wl_subsurface for the recursive effect of this mode. Change the commit behaviour of the sub-surface to desynchronized mode, also described as independent or freely running mode. In desynchronized mode, wl_surface.commit on a sub-surface will apply the pending state directly, without caching, as happens normally with a wl_surface. Calling wl_surface.commit on the parent surface has no effect on the sub-surface's wl_surface state. This mode allows a sub-surface to be updated on its own. If cached state exists when wl_surface.commit is called in desynchronized mode, the pending state is added to the cached state, and applied as a whole. This invalidates the cache. Note: even if a sub-surface is set to desynchronized, a parent sub-surface may override it to behave as synchronized. For details, see wl_subsurface. If a surface's parent surface behaves as desynchronized, then the cached state is applied on set_desync.