8 releases (4 breaking)

0.5.0 Dec 13, 2023
0.4.0 Dec 9, 2023
0.3.1 Nov 25, 2023
0.3.0 Aug 29, 2023
0.1.1 Jul 24, 2023

#324 in Graphics APIs

MIT license

285KB
2.5K SLoC

wayrs

A simple Rust implementation of Wayland client library.

Design decisions

  • Single event queue
  • No interior mutability
  • No libwayland compatibility
  • Support blocking, non-blocking and async IO

Project structure

The project is split into multiple crates:

  • wayrs-client: The main crate which implements Wayland wire protocol. Provides Connection type which represents open Wayland socket.
  • wayrs-scanner: Provides generate! macro that generates glue code from .xml files. Generated code for the core protocol is already included in wayrs-client. Reexported as wayrs_client::scanner.
  • wayrs-protocols: A collection of Wayland protocols to use with wayrs-client.
  • wayrs-utils: A collection of utils and abstractions for wayrs-client. Includes a shared memory allocator and more.
  • wayrs-egl: Brings OpenGL(-ES) to wayrs. Based on EGL_KHR_platform_gbm.

Projects using wayrs

The following projects use wayrs and may serve as additional usage examples:

  • i3bar-river: Port of i3bar for river.
  • i3status-rs: Feature-rich and resource-friendly replacement for i3status.
  • river-kbd-layout-watcher: Prints current keyboard layout whenever it changes.
  • wayidle: Waits until the compositor reports being N seconds idle.
  • wl-gammarelay-rs: Provides DBus interface to control display temperature and brightness without flickering.
  • wlr-which-key: Keymap manager for wlroots-based compositors.

MSRV

1.67

Dependencies

~1.5–2.1MB
~40K SLoC