vtimofei
/
smithay
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
405 Commits 1 Branch 0 Tags 3.5 MiB
Rust 100%
Go to file
Victor Berger 454f874284 cargo fmt 2018-09-25 00:32:09 +02:00
anvil cargo fmt 2018-09-25 00:32:09 +02:00
src cargo fmt 2018-09-25 00:32:09 +02:00
.gitignore Fix travis build with updated libinput 2017-12-15 19:22:40 +01:00
.rustfmt.toml Remove unstable rustfmt options 2018-04-17 17:48:20 +02:00
.travis.yml anvil: test on travis 2018-05-07 20:03:14 +02:00
CHANGELOG.md Version 0.1.0 2017-10-01 23:11:01 +02:00
CONTRIBUTING.md Cargo.toml: include repo, update nix/image 2017-10-09 15:17:19 +02:00
Cargo.toml update to wayland-rs 0.21 2018-09-25 00:31:58 +02:00
LICENSE.txt Add MIT license 2017-03-24 10:24:07 +01:00
README.md Add anvil to the readme 2018-05-13 15:01:50 +02:00
build.rs cargo fmt 2018-09-25 00:32:09 +02:00
doc_index.html travis: add a redirect doc homepage 2017-10-01 20:34:24 +02:00
matrix_badge.svg Add a few badges on the README 2017-10-04 11:30:07 +02:00
vagga.yaml fix vagga build 2018-02-20 19:19:22 +01:00

README.md

Smithay

Crates.io docs.rs Build Status Join the chat on matrix at @smithay:matrix.org Join the chat via bridge on gitter at smithay/Lobby

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.