vtimofei
/
smithay
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
823 Commits 1 Branch 0 Tags 3.5 MiB
Rust 100%
Go to file
Uli Schlachter a6c40a002b Add an X11 EventSource to calloop 
This commit creates an event source for calloop that receives X11 events
from the X11 server.

Signed-off-by: Uli Schlachter <psychon@znc.in>
 		2021-02-19 11:38:17 +01:00
.github/workflows ci: document public dependencies as well 2020-07-16 13:28:07 +02:00
anvil Add an X11 EventSource to calloop 2021-02-19 11:38:17 +01:00
examples Fix most rustc & clippy warnings 2020-09-16 12:56:32 +02:00
src Document shell approach for Xwayland launching 2021-02-14 21:15:49 +01: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 Cargo.toml: include repo, update nix/image 2017-10-09 15:17:19 +02:00
Cargo.toml Dependencies updates 2020-11-02 10:24:55 +01: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 backend.session: use pkg-config to find logind lib 2020-05-23 21:37:22 +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