Go to file
Victor Berger 9f0a1fb244 backend.winit: remove the moved() event
This event poses issues regarding its semantic (what space are the
coordinates in?) and arguably won't be used anyway. So let's remove it
for now, it can still be added afterwards if it appears to be really
needed.
2018-10-15 11:15:10 +02:00
anvil anvil: use smithay's global SerialCounter 2018-10-08 13:55:21 +02:00
src backend.winit: remove the moved() event 2018-10-15 11:15:10 +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 [travis] Only do cargo check for incomplete feature-sets 2018-09-30 21:12:38 +02:00
CHANGELOG.md Fixes in changelog 2018-09-30 23:19:48 +02:00
CONTRIBUTING.md Cargo.toml: include repo, update nix/image 2017-10-09 15:17:19 +02:00
Cargo.toml Upgrade winit backend to 0.17 2018-09-30 19:22:35 +08: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 lib: Use nested imports 2018-10-07 22:39:18 +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 travis: use stable rustfmt and switch to clippy-preview 2018-09-27 12:18:54 +02: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.