A modular Wayland compositor library
Go to file
Alexander Orzechowski 055c0d28d1 wlr_scene: Don't special case swapchain buffers
This fixes direct scanout VRR. As direct scanout buffers are not part
of the swapchain, we would mistakenly union instead of subtract the damage
meaning it will just accumulate indefinitely.

The reason for this existing in the first place is for compositors that
might want to sidestep scene and commit their own buffers to the output.
In this case, scene could theoretically acknowledge that and update the
damage. Except, this really didn't work because WLR_OUTPUT_STATE_DAMAGE
would need to be defined which is optional. This patch also properly
acknowledges commits without damage.

In the use case of a weird compositor that might want to sidestep scene,
they can just trash the damage ring themselves.

Fixes: #3871
(cherry picked from commit 14e1987f50)
2024-08-15 11:27:36 -04:00
.builds ci: use package x11-servers/xwayland instead of x11-servers/xwayland-devel 2024-07-15 09:58:22 -04:00
.gitlab/issue_templates Add GitLab issue template 2023-10-08 11:29:13 +00:00
backend backend/drm: don't set vsync present flag if page flip was async 2024-08-15 11:13:05 -04:00
docs docs: Add notes about WLR_SCENE_DISABLE_VISIBILITY effectively disabling direct scanout. 2024-05-11 11:59:36 -04:00
examples docs: update comments for wlr_output API changes 2024-07-15 09:58:22 -04:00
include backend/drm: don't set vsync present flag if page flip was async 2024-08-15 11:13:05 -04:00
protocol Switch to stable tablet-v2 protocol 2024-06-27 18:04:00 +00:00
render render/vulkan: Fix draw rect clip region invalid in blend none mod 2024-08-06 08:09:15 -04:00
tinywl tinywl: allow specify pkg-config binary 2024-06-22 15:59:12 +00:00
types wlr_scene: Don't special case swapchain buffers 2024-08-15 11:27:36 -04:00
util util: let wlr_box_closest_point() be within 1/65536 of right/bottom edge 2024-06-25 11:09:33 -04:00
xcursor xcursor/wlr_xcursor: properly clean xcursor in case of realloc failure in load_callback 2024-04-18 16:47:07 +02:00
xwayland Fix memory leak in xwayland.c 2024-08-12 10:08:27 -04:00
.editorconfig editorconfig: Unset maximum line length for .git 2024-05-25 07:54:58 +00:00
.gitignore gitignore: remove build dir entries 2022-06-14 10:08:54 +02:00
.gitlab-ci.yml ci: add .gitlab-ci.yml 2021-11-01 16:51:18 +01:00
.mailmap mailmap: map Isaac's old email to the new one 2024-03-04 14:01:00 +01:00
CONTRIBUTING.md contributing: add safety section 2023-10-04 11:08:58 +02:00
LICENSE license: add copyright line for all contributors 2023-07-05 10:27:50 +02:00
meson_options.txt add an option to enable/disable libliftoff 2024-06-05 22:33:05 -06:00
meson.build build: bump version to 0.18.0 2024-07-12 23:39:50 +02:00
README.md backend/drm: use libdisplay-info to parse EDID 2023-02-28 14:44:02 +00:00
wlroots.syms build: simplify version script 2021-06-17 11:03:21 +02:00

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.