a745eace15
|
||
|---|---|---|
| anvil | ||
| src | ||
| .gitignore | ||
| .rustfmt.toml | ||
| .travis.yml | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| Cargo.toml | ||
| LICENSE.txt | ||
| README.md | ||
| build.rs | ||
| doc_index.html | ||
| matrix_badge.svg | ||
| vagga.yaml | ||
README.md
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 functionnalities that pretty much any compositor will need, in a generic fashion.
Also:
- Documented: Smithay strives to maintain a clear and detailed documentation of its API and its functionnalities. 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
Like others, Smithay as a compositor library has its own sample compositor: anvil.
You can run it with cargo after having cloned this repository:
cargo run -p anvil -- --{backend}
The currently available backends are:
--winit: start anvil as a Winit application. This allows you to run it inside of an other X11 or Wayland session.--tty-udev: start anvil in a tty with udev support. This is the "traditional" launch of a Wayland compositor. Note that this requires you to start anvil as root if your system does not have logind available (consolekit support is planned).--tty-raw: start anvil without udev support, manually binding all ressources. Requires to be run as root. This backend is mostly present as example code for use in very minimalistic systems.