Go to file
Simon Ser e93435016e output: fix typo in wlr_output_impl.get_primary_formats docs
The buffer capabilities indicate whether the formats returned are
for DMA-BUFs or shared memory buffers.
2021-11-30 20:49:33 +01:00
.builds ci/archlinux: enable address and undefined sanitizers 2021-11-19 16:42:14 +00:00
backend backend/drm: poison buffers which cannot be scanned out 2021-11-29 14:32:29 +00:00
docs backend: remove noop backend 2021-11-25 16:49:05 +00:00
examples examples: init wlr_output with allocator and renderer 2021-11-18 09:37:57 -05:00
include output: fix typo in wlr_output_impl.get_primary_formats docs 2021-11-30 20:49:33 +01:00
protocol Fix spelling errors 2021-10-02 10:22:13 +02:00
render render/drm_format_set: remove special LINEAR case 2021-11-26 16:40:53 +00:00
tinywl tinywl: build with meson if examples option is enabled 2021-11-19 16:42:14 +00:00
types output: don't leave dangling cursor_front_buffer 2021-11-30 18:32:48 +00:00
util util/token: don't leak /dev/urandom fd to children 2021-11-14 12:30:03 +01:00
xcursor xcursor: fix CVE-2013-2003 2021-05-02 17:04:59 +02:00
xwayland xwayland: add support for -noTouchPointerEmulation 2021-11-02 12:02:51 +01:00
.editorconfig Set .editorconfig ident_size 2019-01-25 11:37:46 +01:00
.gitignore Remove rootston 2019-08-09 08:34:59 +09:00
.gitlab-ci.yml ci: add .gitlab-ci.yml 2021-11-01 16:51:18 +01:00
CONTRIBUTING.md CONTRIBUTING.md: add CoC section 2021-11-06 17:01:53 +03:00
LICENSE Update LICENSE year (MIT license) 2018-04-12 21:29:59 -04:00
README.md s/GitHub/GitLab/ 2021-11-01 18:54:26 +00:00
meson.build tinywl: build with meson if examples option is enabled 2021-11-19 16:42:14 +00:00
meson_options.txt render/vulkan: add Vulkan renderer 2021-10-18 11:51:13 +02: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: #sway-devel on Libera Chat.

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 and GLESv2 (optional, for the GLES2 renderer)
  • Vulkan loader, headers and glslang (optional, for the Vulkan renderer)
  • libdrm
  • GBM
  • libinput (optional, for the libinput backend)
  • xkbcommon
  • udev
  • pixman
  • libseat

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 build/
ninja -C build/

Install like so:

sudo ninja -C build/ install

Contributing

See CONTRIBUTING.md.