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.
 
 
 
Simon Zeni 9dd6e2b905
backend/libinput: add devices wl_list
3 years ago
.builds ci/archlinux: enable address and undefined sanitizers 3 years ago
backend backend/libinput: add devices wl_list 3 years ago
docs backend: remove noop backend 3 years ago
examples examples/input-method: Don't crash on NULL surrounding text 3 years ago
include backend/libinput: add devices wl_list 3 years ago
protocol ext-session-lock-v1: new protocol implementation 3 years ago
render render: allow texture creation while rendering 3 years ago
tinywl xdg-toplevel: fix functions' main argument type 3 years ago
types types/wlr_virtual_pointer_v1: fix wlr_pointer destroy sequence 3 years ago
util util/global: remove wl_display arg from wlr_global_destroy_safe 3 years ago
xcursor xcursor: garbage collect XcursorLibraryLoadImages 3 years ago
xwayland Xwayland: use -displayfd instead of USR1 3 years ago
.editorconfig editorconfig: set max_line_length 3 years ago
.gitignore Remove rootston 5 years ago
.gitlab-ci.yml ci: add .gitlab-ci.yml 3 years ago
CONTRIBUTING.md CONTRIBUTING.md: update construction/destruction functions' description 3 years ago
LICENSE Update LICENSE year (MIT license) 7 years ago
README.md readme: drop mention of the Sway project 3 years ago
meson.build build: simplify Meson subproject fallbacks 3 years ago
meson_options.txt render/vulkan: add Vulkan renderer 3 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: #sway-devel 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
  • 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.