A modular Wayland compositor library
Go to file
John Lindgren 1a731596c5 wlr_scene: clarify wlr_scene_output ownership semantics
wlr_scene_output_layout_add_output() was made public by f5917f0247
("scene_output_layout: make output adding explicit") but the ownership
semantics are not obvious and should be clarified.
2023-09-22 21:18:16 -04:00
.builds backend/drm: use libdisplay-info to parse EDID 2023-02-28 14:44:02 +00:00
backend backend/drm: Compute custom mode correctly 2023-09-07 01:56:32 +00:00
docs backend/drm: add libliftoff interface 2023-02-20 18:38:57 +01:00
examples examples/embedded: new example 2023-08-16 16:39:53 +02:00
include wlr_scene: clarify wlr_scene_output ownership semantics 2023-09-22 21:18:16 -04:00
protocol cursor-shape-v1: new protocol implementation 2023-07-24 01:00:19 +00:00
render render/pass: Remove empty box early return 2023-09-21 02:25:34 -04:00
tinywl tinywl: set minimum wlroots version in Makefile 2023-09-01 00:28:55 +09:00
types screencopy_v1: only bind, not render with, buffer in shm copy path 2023-09-11 20:25:07 -04:00
util Use struct initializers instead of memset() 2023-07-07 17:31:11 +02:00
xcursor xcursor: Resolve warning in xcursor_build_theme_dir 2023-04-25 10:16:59 +00:00
xwayland xwayland: drop wlr_xwayland_surface.events.set_pid 2023-08-03 03:19:35 +00:00
.editorconfig Relax 80 column limit 2022-11-22 18:19:46 +00:00
.gitignore gitignore: remove build dir entries 2022-06-14 10:08:54 +02:00
.gitlab-ci.yml ci: add .gitlab-ci.yml 2021-11-01 16:51:18 +01:00
CONTRIBUTING.md Use struct initializers instead of memset() 2023-07-07 17:31:11 +02:00
LICENSE license: add copyright line for all contributors 2023-07-05 10:27:50 +02:00
README.md backend/drm: use libdisplay-info to parse EDID 2023-02-28 14:44:02 +00:00
meson.build build: drop proto_inc 2023-06-14 16:35:31 +02:00
meson_options.txt backend/session: make optional 2022-11-25 16:15:29 +00:00
wlroots.syms build: simplify version script 2021-06-17 11:03:21 +02:00



Pluggable, composable, unopinionated modules for building a Wayland compositor; or about 60,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. Join our IRC channel: #wlroots on Libera Chat.

A variety of wrapper libraries are available for using it with your favorite programming language.


Install dependencies:

  • meson
  • wayland
  • wayland-protocols
  • EGL and GLESv2 (optional, for the GLES2 renderer)
  • Vulkan loader, headers and glslang (optional, for the Vulkan renderer)
  • libdrm
  • GBM (optional, for the GBM allocator)
  • libinput (optional, for the libinput backend)
  • xkbcommon
  • udev (optional, for the session)
  • pixman
  • libseat (optional, for the session)
  • hwdata (optional, for the DRM backend)
  • libdisplay-info (optional, for the DRM backend)
  • libliftoff (optional, for the DRM backend)

If you choose to enable X11 support:

  • xwayland (build-time only, optional at runtime)
  • libxcb
  • libxcb-render-util
  • libxcb-wm
  • libxcb-errors (optional, for improved error reporting)

Run these commands:

meson setup build/
ninja -C build/

Install like so:

sudo ninja -C build/ install