A private fork of wlroots
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Kirill Primak 4c69bc47f4
ext-foreign-toplevel-list-v1: improve/fix update_state()
11 months ago
.builds ci: drop stale dependencies 1 year ago
.gitlab/issue_templates Add GitLab issue template 1 year ago
backend backend/drm: drop unnecessary _XOPEN_SOURCE 11 months ago
docs docs: add architecture document 1 year ago
examples backend: take wl_event_loop instead of wl_display in wlr_backend_autocreate() 11 months ago
include ext-foreign-toplevel-list-v1: new protocol implementation 11 months ago
protocol ext-foreign-toplevel-list-v1: new protocol implementation 11 months ago
render Add more POSIX compliance macros to fix uClibc support 11 months ago
tinywl xdg-shell: drop automatic surface configuration 11 months ago
types ext-foreign-toplevel-list-v1: improve/fix update_state() 11 months ago
util util/transform: add wlr_output_transform_coords() 1 year ago
xcursor Add more POSIX compliance macros to fix uClibc support 11 months ago
xwayland xwayland: add support for _NET_WM_WINDOW_TYPE_DESKTOP atom 11 months ago
.editorconfig Relax 80 column limit 2 years ago
.gitignore gitignore: remove build dir entries 3 years ago
.gitlab-ci.yml ci: add .gitlab-ci.yml 3 years ago
CONTRIBUTING.md contributing: add safety section 1 year ago
LICENSE license: add copyright line for all contributors 1 year ago
README.md backend/drm: use libdisplay-info to parse EDID 2 years ago
meson.build backend/drm: add support for atomic tearing page-flips 11 months ago
meson_options.txt backend/session: make optional 2 years ago
wlroots.syms build: simplify version script 4 years ago

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.