A modular Wayland compositor library
Find a file
Jose Maria Casanova Crespo f33853f861 render/gles2: add scissor-based clipping for tile-based renderers
Add an optional scissor-based clipping strategy to the GLES2 render
pass, it is enabled with WLR_GLES2_SCISSOR_CLIP=1 env var. And it is
disabled by default so it doesn't affect current users.

On tile-based renderers like V3D (Broadcom VideoCore, used in Raspberry
Pi), not using scissoring makes the GPU to render the full-surface.
If scissor is applied only the tiles affected are load/render/stored
reducing the GPU usage.

Patch backported to wlroots 0.19 with labwc on Raspberry Pi OS with
v3d running glxgear 300x300 on top left corner of screen:

- Before: labwc uses 21.5% of GPU render availability.
- After : labwc uses  3.3% of GPU render availability.

This patch over wlroots master with sway on Raspberry Pi OS with
v3d running glxgear half-screen and a terminal half screen:

- Before: sway uses 23.5% of GPU render availability.
- After : sway uses 13.6% of GPU render availability.
2026-03-12 22:00:03 +01:00
.builds ci: Run tests and benchmarks 2026-03-09 22:09:40 +00:00
.gitlab/issue_templates Add GitLab issue template 2023-10-08 11:29:13 +00:00
backend backend/x11: ignore DestroyNotify events 2026-03-10 22:44:56 -06:00
docs render: add WLR_RENDERER_FORCE_SOFTWARE env var 2024-12-22 21:37:57 +00:00
examples fullscreen-shell: remove 2025-03-30 01:15:09 +03:00
include render/gles2: add scissor-based clipping for tile-based renderers 2026-03-12 22:00:03 +01:00
protocol wlr-export-dmabuf-unstable-v1: fix typo 2026-03-12 11:03:57 +00:00
render render/gles2: add scissor-based clipping for tile-based renderers 2026-03-12 22:00:03 +01:00
subprojects build: add Meson wrap manifests for our dependencies 2024-12-22 21:24:03 +00:00
test tests: Initial test and benchmark setup 2026-03-09 22:09:40 +00:00
tinywl treewide: fix typos 2026-02-28 04:26:47 -03:00
types Adopt wlr_box_intersects where useful 2026-03-09 22:09:40 +00:00
util util/box: Add wlr_box_intersects 2026-03-09 22:09:40 +00:00
xcursor xcursor: introduce wlr_xcursor_image_get_buffer() 2026-01-05 10:10:32 -05:00
xwayland treewide: make type-check helpers take const pointers 2026-03-06 16:04:21 +08:00
.editorconfig editorconfig: Unset maximum line length for .git 2024-05-25 07:54:58 +00:00
.gitignore git: fix incorrect subprojects ignore in .gitignore 2025-03-23 13:24:15 +01:00
.gitlab-ci.yml ci: update dalligi upstream repo 2026-03-06 09:37:31 -05:00
.mailmap .mailmap: add myself 2024-08-05 19:32:24 +03:00
CONTRIBUTING.md CONTRIBUTING.md: update git host 2026-02-20 00:31:06 +01:00
LICENSE license: add copyright line for all contributors 2023-07-05 10:27:50 +02:00
meson.build tests: Initial test and benchmark setup 2026-03-09 22:09:40 +00:00
meson.options tests: Initial test and benchmark setup 2026-03-09 22:09:40 +00:00
README.md backend/drm: use libdisplay-info to parse EDID 2023-02-28 14:44:02 +00:00
release.sh Add release script 2025-09-22 10:12:43 -04: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.