Go to file
Christian Meissl 0d88a392fa add an output_map which handles...
the positioning of outputs, tracks
the surfaces on the outputs and
sends enter/leave for the surfaces

Additionally the output_map will
handle re-location of windows if
a output mode is changed, an output is
added or removed.

The shell has been updated to use the
primary output for the initial placement.
The fullscreen/maximize requests will now
handle the shell part correctly. For real
fullscreen output the rendering has to be
changed.

The output name is considered unique
and an output can be retrieved from
the map by location, output or name.
This can be used as the base for HiDPI
handling.
2021-06-30 18:24:51 +02:00
.github/workflows ci: test backend_session_libseat 2021-06-30 13:52:36 +02:00
anvil add an output_map which handles... 2021-06-30 18:24:51 +02:00
examples cargo fmt 2021-06-10 22:01:10 +02:00
src add an output_map which handles... 2021-06-30 18:24:51 +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
CHANGELOG.md version 0.2.0 2019-01-03 10:52:15 +01:00
CONTRIBUTING.md Update IRC reference 2021-06-08 22:05:40 +02:00
Cargo.toml compositor: Introduce transaction state tracking 2021-06-26 21:52:38 +02:00
LICENSE.txt Add MIT license 2017-03-24 10:24:07 +01:00
README.md typo: functionnalities -> functionalities 2020-09-24 13:30:42 +02:00
build.rs add more supported egl platforms 2021-05-15 23:05:26 +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

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 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 (consolekit support is planned). To use logind, you need to activate the associated cargo feature:

    cargo run --features logind -- --tty-udev