mirror of
https://github.com/Smithay/smithay.git
synced 2024-09-28 03:21:14 +02:00
Mirror of https://github.com/Smithay/smithay.git
3731734d5a
Some checks failed
Continuous Integration / format (push) Has been cancelled
Continuous Integration / clippy-check (push) Has been cancelled
Continuous Integration / smithay-check-features (push) Has been cancelled
Continuous Integration / check-msrv (push) Has been cancelled
Continuous Integration / check-minimal (push) Has been cancelled
Continuous Integration / smithay-tests (push) Has been cancelled
Continuous Integration / smallvil-check (push) Has been cancelled
Continuous Integration / anvil-check-features (push) Has been cancelled
Continuous Integration / WLCS: ${{ matrix.job_name }} (buffer, BadBufferTest*, Bad Buffer Test) (push) Has been cancelled
Continuous Integration / WLCS: ${{ matrix.job_name }} (core, SelfTest*:FrameSubmission*, Core tests) (push) Has been cancelled
Continuous Integration / WLCS: ${{ matrix.job_name }} (output, XdgOutputV1Test*, Output tests) (push) Has been cancelled
Continuous Integration / WLCS: ${{ matrix.job_name }} (pointer-input, */SurfacePointerMotionTest*:RelativePointer*, Pointer input tests) (push) Has been cancelled
Continuous Integration / Documentation on Github Pages (push) Has been cancelled
The actual mmap can change if the shm pool gets resized. In this case we have to re-map our image to prevent accessing a unmapped memory region. |
||
|---|---|---|
| .github/workflows | ||
| anvil | ||
| benches | ||
| examples | ||
| smallvil | ||
| smithay-drm-extras | ||
| src | ||
| wlcs_anvil | ||
| .gitignore | ||
| .rustfmt.toml | ||
| build.rs | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| clippy.toml | ||
| compile_wlcs.sh | ||
| CONTRIBUTING.md | ||
| doc_index.html | ||
| LICENSE.txt | ||
| README.md | ||
| test_gbm_bo_create_with_modifiers2.c | ||
| test_gbm_bo_get_fd_for_plane.c | ||
Smithay
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).
Anvil
Smithay as a compositor library has its own sample compositor: anvil.
To get informations 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
- 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.
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.