- Rust 98.6%
- Python 1.2%
- GLSL 0.2%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
7878e6ed11
The EI protocol is needed for the xdg-desktop-portal `RemoteDesktop` portal to emulate input devices, as well as by the `InputCapture` portal for Synergy-like uses (input-leap supports Wayland with this portal). This exposes a relatively simple API for a compositor to create EI seats and devices, mirroring the `Seat` API. It also provides an `InputBackend` that converts emulated input to Smithay input events. Receiver contexts for the `InputCapture` portal are also a bit more complicated to implement. Those involve capturing input once the cursor crosses outside the display. That isn't implemented at all here yet. We may want to change things in the future to accommodate receiver contexts, etc. But this API is fairly minimal to use, so future breaking changes shouldn't be too challenging for a compositor to adapt to. |
||
| .github | ||
| anvil | ||
| benches | ||
| examples | ||
| smallvil | ||
| smithay-drm-extras | ||
| src | ||
| test_clients | ||
| wlcs_anvil | ||
| .gitignore | ||
| .rustfmt.toml | ||
| AI.md | ||
| build.rs | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| clippy.toml | ||
| compile_wlcs.sh | ||
| CONTRIBUTING.md | ||
| DCO.md | ||
| doc_index.html | ||
| GETTING_STARTED.md | ||
| LICENSE.txt | ||
| README.md | ||
| test_gbm_bo_create_with_modifiers2.c | ||
| test_gbm_bo_get_fd_for_plane.c | ||
| typos.toml | ||
A smithy for rusty Wayland compositors
Goals
Smithay aims to provide building blocks to create wayland compositors in Rust. While not being a full-blown compositor, it'll provide objects and interfaces implementing common functionalities that pretty much any compositor will need, in a generic fashion.
It supports the core Wayland protocols, the official protocol extensions, and some external extensions, such as those made by and for wlroots and KDE
Also:
- Documented: Smithay strives to maintain a clear and detailed documentation of its API and its functionalities. Compiled documentations are available on docs.rs for released versions, and here for the master branch.
- Safety: Smithay will target to be safe to use, because Rust.
- Modularity: Smithay is not a framework, and will not be constraining. If there is a part you don't want to use, you should not be forced to use it.
- High-level: You should be able to not have to worry about gory low-level stuff (but Smithay won't stop you if you really want to dive into it).
Getting started
If you want to learn how to build a compositor with Smithay, consider this getting started guide.
Anvil
Smithay as a compositor library has its own sample compositor: anvil.
To get information about it and how you can run it visit anvil README
Other compositors that use Smithay
- Cosmic: Next generation Cosmic desktop environment
- Catacomb: A Wayland Mobile Compositor
- emskin: A nested Wayland compositor for embedding any app inside Emacs
- MagmaWM: A versatile and customizable Wayland Compositor
- Niri: A scrollable-tiling Wayland compositor
- Strata: A cutting-edge, robust and sleek Wayland compositor
- Pinnacle: A WIP Wayland compositor, inspired by AwesomeWM
- Sudbury: Compositor designed for ChromeOS
- wprs: Like xpra, but for Wayland, and written in Rust.
- Local Desktop: An Android app for running GUI Linux via PRoot and Wayland.
- Otto: A gesture-driven stacking compositor.
System Dependencies
(This list can depend on features you enable)
libwaylandlibxkbcommonlibudevlibinputlibgbmlibseatxwayland
Contact us
If you have questions or want to discuss the project with us, our main chatroom is on Matrix: #smithay:matrix.org.
Contributing
General notes on contributing to Smithay can be found here.
Please note that to submit code to Smithay, you have to agree to our Developer Certificate of Origin.
If you are used to using generative AI, please ensure you read our Policy before engaging.