mirror of
https://gitlab.freedesktop.org/wlroots/wlroots.git
synced 2026-06-13 14:32:57 -04:00
A modular Wayland compositor library
53b399d054
When a compositor uses color transforms (ICC profiles) the output's postrender buffer is in the display's color space, not sRGB. A screenshot client receives this buffer and saves it as an untagged PNG, which appears oversaturated in non-colormanaged viewers. To fix this without altering the semantics of the raw output source (which must deliver the exact hardware scanned buffer, including overlays and direct scanout), add an optional, compositor driven scene-per-output capture source. This source re-renders the entire scene graph for a given output with an identity color transform (sRGB), using a hidden headless output to avoid flicker. The new function `wlr_ext_image_capture_source_v1_create_with_scene_output()` takes a wlr_scene, a reference wlr_output (for dimensions, scale, renderer/allocator), and an optional wlr_output_layout (for correct positioning). The source is created on demand in the existing output capture manager when the compositor has called `wlr_ext_output_image_capture_source_manager_v1_set_scene()` and `wlr_ext_output_image_capture_source_manager_v1_set_layout()`. If the compositor never provides a scene, the manager continues to create the original raw output source, preserving backward compatibility and hardware plane capture for compositors that need it. |
||
|---|---|---|
| .builds | ||
| .gitlab/issue_templates | ||
| backend | ||
| docs | ||
| examples | ||
| include | ||
| protocol | ||
| render | ||
| subprojects | ||
| test | ||
| tinywl | ||
| types | ||
| util | ||
| xcursor | ||
| xwayland | ||
| .editorconfig | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| .mailmap | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| meson.build | ||
| meson.options | ||
| README.md | ||
| release.sh | ||
| wlroots.syms | ||
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.