A modular Wayland compositor library
Find a file
Simon Ser 5d054258af
backend/drm: fix segfault in page_flip_handler
Since 5b1b43c68c ("backend/drm: make wlr_drm_plane.{pending,queued,current}_fb
pointers"), current_fb can be NULL if there's no buffer. If current_fb
is not NULL, current_fb->wlr_buf is guaranteed to not be NULL.

Closes: https://github.com/swaywm/wlroots/issues/2634
2021-01-12 11:41:45 +01:00
.builds
backend backend/drm: fix segfault in page_flip_handler 2021-01-12 11:41:45 +01:00
docs
examples render/egl: replace init/finish with create/destroy 2021-01-12 11:31:04 +01:00
include render/egl: remove surface and buffer age args from make_current 2021-01-12 11:31:04 +01:00
protocol
render render/egl: remove surface and buffer age args from make_current 2021-01-12 11:31:04 +01:00
tinywl
types layer shell: rename popup iterator for consistency 2021-01-12 11:26:08 +01:00
util
xcursor
xwayland
.editorconfig
.gitignore
CONTRIBUTING.md
LICENSE
meson.build build: use more consistent feature names in summary 2021-01-12 10:49:33 +01:00
meson_options.txt
README.md
wlroots.syms

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)
  • libuuid (optional, for xdg-foreign 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.