Go to file
Drew DeVault 6025fcaa09 Update required meson version to 0.47.1 2018-08-24 09:20:25 -04:00
backend Revert "Revert "Merge pull request #1194 from ascent12/meson_feature"" 2018-08-24 19:35:02 +12:00
docs Document WLR_HEADLESS_OUTPUTS 2018-07-18 17:19:41 +02:00
examples Revert "Revert "Merge pull request #1194 from ascent12/meson_feature"" 2018-08-24 19:35:02 +12:00
include Revert "Revert "Merge pull request #1194 from ascent12/meson_feature"" 2018-08-24 19:35:02 +12:00
protocol Revert "Revert "Merge pull request #1194 from ascent12/meson_feature"" 2018-08-24 19:35:02 +12:00
render Change how glgen.sh outputs files 2018-08-24 19:35:21 +12:00
rootston Revert "Revert "Merge pull request #1194 from ascent12/meson_feature"" 2018-08-24 19:35:02 +12:00
types wlr_virtual_keyboard: use wlr_input_device_destroy 2018-08-22 14:43:29 +01:00
util util: include config in os-compatibility.c 2018-07-21 20:39:00 +01:00
xcursor util: add wlr_ prefix to log symbols 2018-07-09 22:49:54 +01:00
xwayland Revert "Revert "Merge pull request #1194 from ascent12/meson_feature"" 2018-08-24 19:35:02 +12:00
.build.yml build: add dependencies for examples/dmabuf-capture 2018-05-29 18:47:20 +01:00
.editorconfig Add wlr_primary_selection_device_manager and wlr_primary_selection_source 2017-12-22 19:20:12 +01:00
.gitignore update .gitignore 2018-03-03 15:23:26 +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 Fix xcb/xkb swap in README 2018-05-05 00:25:11 -05:00
glgen.sh Change how glgen.sh outputs files 2018-08-24 19:35:21 +12:00
meson.build Update required meson version to 0.47.1 2018-08-24 09:20:25 -04:00
meson_options.txt Revert "Revert "Merge pull request #1194 from ascent12/meson_feature"" 2018-08-24 19:35:02 +12: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 40,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.

Status: prior to 1.0 the API is not stable, but we've done most of the work and various projects are using wlroots to build Wayland compositors with.

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-image
  • xcb-render
  • x11-xcb
  • xcb-errors (optional, for improved error reporting)
  • x11-icccm (optional, for improved Xwayland introspection)
  • xcb-xkb (optional, for improved keyboard handling on the X11 backend)

Run these commands:

meson build
ninja -C build

On FreeBSD, you need to pass an extra flag to prevent a linking error: meson build -D b_lundef=false.

Install like so:

sudo ninja -C build install

Running the test compositor

wlroots comes with a test compositor called rootston, which demonstrates the features of the library and is used as a testbed for the development of the library. It may also be useful as a reference for understanding how to use various wlroots features.

If you followed the build instructions above the rootston executable can be found at ./build/rootston/rootston. To use it, refer to the example config at ./rootston/rootston.ini.example and place a config file of your own at rootston.ini in the working directory (or in an arbitrary location via rootston -C). Other options are available, refer to rootston -h.

Contributing

See CONTRIBUTING.md.