Smithay project

The rusty smithy for wayland compositors

About


This is the website of the smithay project, home of several wayland-related rust crates.

The project is named after its flagship crate smithay, a library for making wayland compositors in rust, but is also home of wayland-rs, a group of low-level bindings to libwayland, as well as a few other crates, either wayland utilities or needed for smithay, and the Smithay book aiming to be an in-depth explanation of wayland's structure and of how smithay and the wayland-rs crates can be used (it's currently WIP, only containing a good part of the wayland description).

Wayland utilities:

  • smithay-client-toolkit is an utility crate to simplify the writing of wayland clients. In mostly include general functionalities to factor-out the redundants parts of writing a client, allowing to focus on the particularities of each specific app.

Smithay dependencies:

  • input.rs is a binding crate over the libinput library. It is used by smithay to handle raw user input from the kernel (mouse, keyboard and touchscreens).
  • drm-rs is safe interface to the Direct Rendering Manager API, allowing Smithay to gain direct access to the monitors of a computer.
  • gbm.rs is a binding crate over libgbm, the Generic Buffer Manager, which allows easier handling of memory buffers in combination with DRM to ease making smithay more portable.

Smithay's logo was kindly designed by Amalasunthe.