Miroirs/smithay
1
0
Fork 0
mirror of https://github.com/Smithay/smithay.git synced 2024-09-28 03:21:14 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
Mirror of https://github.com/Smithay/smithay.git
1915 commits 79 branches 4 tags 172 MiB
Rust 99.9%
Find a file
Victoria Brekenfeld b38ef30246 input: Fix doc tests
2022-08-23 14:35:21 +00:00
.github/workflows CI: Use ubuntu 22.04 jammy 2022-08-09 09:24:30 +00:00
anvil input: Be generic over focus targets 2022-08-23 10:54:23 +00:00
examples input: fix examples, smallvil, wlcs 2022-08-23 12:04:59 +00:00
smallvil input: docs for new associated types 2022-08-23 12:13:33 +00:00
src input: Fix doc tests 2022-08-23 14:35:21 +00:00
wlcs_anvil input: fix examples, smallvil, wlcs 2022-08-23 12:04:59 +00: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
build.rs egl: Add render_node query to EGLDevice 2022-03-14 16:13:22 +01:00
Cargo.toml Merge pull request #443 from rano-oss/wayland/input_method_and_text_input 2022-08-14 15:19:07 -06:00
CHANGELOG.md Rewrite for wayland-rs 0.30 2022-07-31 23:28:55 +08:00
clippy.toml Clippy fixes 2022-08-12 12:11:40 +02:00
compile_wlcs.sh wlcs_anvil: Update for 0.30 2022-06-12 21:00:26 +00:00
CONTRIBUTING.md Update IRC reference 2021-06-08 22:05:40 +02:00
doc_index.html travis: add a redirect doc homepage 2017-10-01 20:34:24 +02:00
LICENSE.txt Update names 2022-06-23 16:46:15 +00:00
README.md Update chat details on Readme 2022-06-16 20:52:42 +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 #smithay on libera.chat

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:

  • --x11: start anvil as an X11 client. This allows you to run the compositor inside an X11 session or any compositor supporting XWayland. Should be preferred over the winit backend where possible.
  • --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.

Contact us

If you have questions or want to discuss the project with us, our main chatroom is on Matrix: #smithay:matrix.org. You can also join it via an IRC bridge, on #smithay on libera.chat.