A private fork of wlroots
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Isaac Freund 85e299e6c5
Document the events of wlr_layer_surface
5 years ago
.builds build: Add 'auto' to logind-provider combo option 5 years ago
backend logind: Close fd before releasing device 5 years ago
contrib build: replace version with soversion 5 years ago
docs backend/drm: add env variable to disable modifiers 5 years ago
examples Prevent memory leak in copypaste of the screencopy example 5 years ago
include Document the events of wlr_layer_surface 5 years ago
protocol keyboard-shortcuts-inhibit: Implement the protocol 5 years ago
render render: only expose linux-dmabuf if EGL extension is supported 5 years ago
tinywl tinywl: remove redundant create output global call 5 years ago
types seat: add check for NULL keyboard 5 years ago
util util/log: improve time prefix 5 years ago
xcursor xcursor: also look for cursor themes under ${datadir}/icons by default 5 years ago
xwayland xwayland: remove underscore prefix from atom names 5 years ago
.editorconfig Set .editorconfig ident_size 6 years ago
.gitignore Remove rootston 5 years ago
CONTRIBUTING.md Simplify globals implementation by removing destructors 5 years ago
LICENSE Update LICENSE year (MIT license) 7 years ago
README.md Update READMEs per tinywl merge 6 years ago
meson.build meson.build: update wayland requirement to 1.18 5 years ago
meson_options.txt build: Add 'auto' to logind-provider combo option 5 years ago
wlroots.syms util: add wlr_output_destroy_safe 5 years ago

README.md

wlroots

Pluggable, composable, unopinionated modules for building a Wayland compositor; or about 50,000 lines of code you were going to write anyway.

  • wlroots provides backends that abstract the underlying display and input hardware, including KMS/DRM, libinput, Wayland, X11, and headless backends, plus any custom backends you choose to write, which can all be created or destroyed at runtime and used in concert with each other.
  • wlroots provides unopinionated, mostly standalone implementations of many Wayland interfaces, both from wayland.xml and various protocol extensions. We also promote the standardization of portable extensions across many compositors.
  • wlroots provides several powerful, standalone, and optional tools that implement components common to many compositors, such as the arrangement of outputs in physical space.
  • wlroots provides an Xwayland abstraction that allows you to have excellent Xwayland support without worrying about writing your own X11 window manager on top of writing your compositor.
  • wlroots provides a renderer abstraction that simple compositors can use to avoid writing GL code directly, but which steps out of the way when your needs demand custom rendering code.

wlroots implements a huge variety of Wayland compositor features and implements them right, so you can focus on the features that make your compositor unique. By using wlroots, you get high performance, excellent hardware compatibility, broad support for many wayland interfaces, and comfortable development tools - or any subset of these features you like, because all of them work independently of one another and freely compose with anything you want to implement yourself.

Check out our wiki to get started with wlroots.

wlroots is developed under the direction of the sway project. A variety of wrapper libraries are available for using it with your favorite programming language.

Building

Install dependencies:

  • meson
  • wayland
  • wayland-protocols
  • EGL
  • GLESv2
  • libdrm
  • GBM
  • libinput
  • xkbcommon
  • udev
  • pixman
  • systemd (optional, for logind support)
  • elogind (optional, for logind support on systems without systemd)
  • libcap (optional, for capability support)

If you choose to enable X11 support:

  • xcb
  • xcb-composite
  • xcb-xfixes
  • xcb-xinput
  • xcb-image
  • xcb-render
  • x11-xcb
  • xcb-errors (optional, for improved error reporting)
  • x11-icccm (optional, for improved Xwayland introspection)

Run these commands:

meson build
ninja -C build

Install like so:

sudo ninja -C build install

Contributing

See CONTRIBUTING.md.