Go to file
Simon Ser e8057bb60c backend/drm: fallback to drmModeAddFB2 2019-06-07 09:06:11 -04:00
.builds Test RDP backend on FreeBSD as well 2019-05-03 20:00:45 +03:00
backend backend/drm: fallback to drmModeAddFB2 2019-06-07 09:06:11 -04:00
docs Add FreeRDP backend for remote desktop support 2019-04-08 08:09:07 -06:00
examples Remove orbital screenshooter and gamma-control 2019-06-02 09:30:47 -04:00
include backend/drm: fallback to drmModeAddFB2 2019-06-07 09:06:11 -04:00
protocol Remove orbital screenshooter and gamma-control 2019-06-02 09:30:47 -04:00
render render/dmabuf: add wlr_dmabuf_attributes_copy 2019-06-07 09:06:11 -04:00
rootston rootston: add support for direct scan-out 2019-06-07 09:06:11 -04:00
tinywl output: refactor frame submission API 2019-04-23 14:34:30 -06:00
types output-damage: support direct scan-out 2019-06-07 09:06:11 -04:00
util util/log: setup wayland log handler 2019-04-07 16:09:00 -06:00
xcursor xcursor: Support XDG user data dir location 2018-11-27 23:21:07 +01:00
xwayland xwayland: set CLOEXEC on /dev/null FD 2019-03-06 00:32:24 +01:00
.editorconfig Set .editorconfig ident_size 2019-01-25 11:37:46 +01:00
.gitignore Add build-*/ to gitignore. 2019-02-04 14:37:16 +01:00
CONTRIBUTING.md util: add wlr_ prefix to log symbols 2018-07-09 22:49:54 +01:00
LICENSE Update LICENSE year (MIT license) 2018-04-12 21:29:59 -04:00
README.md Update READMEs per tinywl merge 2019-01-03 10:10:03 -05:00
glgen.sh Fix missing headers when building without X11 2019-04-22 00:04:08 +03:00
meson.build Update version to 0.6.0 2019-05-03 11:55:46 -04:00
meson_options.txt Add FreeRDP backend for remote desktop support 2019-04-08 08:09:07 -06:00
wlroots.syms Remove symbol versioning from DSO 2018-07-20 11:09:56 +01:00

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.