23a8af399d
This is very much incomplete, but it implements the import and export of surfaces. However functions related to setting and imported surface the parent of another surface is not done. importer destructor destroys all imports made from the same client Implement SetParentOf, no undoing yet Add inner import type Destroy child surface relationships when importing A note move init function upwards use 0.29.0 crate Move role string constants into the public Use toplevel_like for surface checks in foreign add methods to get the parent surface Make sure ZXDG roles are public api Consistent ordering of parameters on xdg_foreign impl methods Let's update the changelog Document how to use xdg_foreign wl_shell_surface is likely invalid, so it cannot be imported or exported Changelog suggestions remove redundant inner ref cell Remove all uses of the refcell like behavior Allow compositor to export surfaces on server Appease new clippy lints then Use string references and iterate in reverse to simplify removals heed request for order |
||
---|---|---|
.github/workflows | ||
anvil | ||
examples | ||
src | ||
wlcs_anvil | ||
.gitignore | ||
.rustfmt.toml | ||
CHANGELOG.md | ||
CONTRIBUTING.md | ||
Cargo.toml | ||
LICENSE.txt | ||
README.md | ||
build.rs | ||
doc_index.html | ||
matrix_badge.svg |
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 functionalities 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 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
Like others, Smithay as a compositor library has its own sample compositor: anvil.
You can run it with cargo after having cloned this repository:
cd anvil;
cargo run -- --{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.