Go to file
Simon Ser 7ad3f4ad2d ci: drop stale dependencies
ffmpeg, epoll-shim, libpng were dependencies for client examples.
These have been split into a separate repository so we no longer
need to install them.
2023-12-10 14:29:23 +01:00
.builds ci: drop stale dependencies 2023-12-10 14:29:23 +01:00
.gitlab/issue_templates Add GitLab issue template 2023-10-08 11:29:13 +00:00
backend backend/x11: Use wlr_texture_read_pixels 2023-11-30 20:01:12 -05:00
docs docs: add architecture document 2023-10-10 09:50:57 +00:00
examples Cleanup wlr_matrix.h includes 2023-11-25 08:37:43 +01:00
include render/gles2: add wlr_gles2_renderer_get_buffer_fbo() 2023-12-05 18:57:43 +01:00
protocol input-inhibitor: drop 2023-11-21 20:10:18 +03:00
render render/gles2: add wlr_gles2_renderer_get_buffer_fbo() 2023-12-05 18:57:43 +01:00
tinywl tinywl: check initialized instead of initial_commit 2023-12-07 17:59:07 +03:00
types compositor: drop surface precommit event 2023-12-04 19:32:44 +01:00
util util/transform: add wlr_output_transform_coords() 2023-11-23 11:07:34 +01:00
xcursor xcursor: don't store NULL xcursors 2023-11-19 15:33:39 +03:00
xwayland xwm: don't do anything except mapping on MapRequest 2023-11-27 13:21:17 +03: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 contributing: add safety section 2023-10-04 11:08:58 +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: automatically compute soversion 2023-12-08 12:00:33 +01: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

README.md

wlroots

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.

Building

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

Contributing

See CONTRIBUTING.md.