mirror of
https://gitlab.freedesktop.org/wlroots/wlroots.git
synced 2026-04-17 06:46:39 -04:00
A modular Wayland compositor library
7a0cf5ac33
This adds a benchmark for render pass that exercises the following
workload configurations:
1. Rect vs. texture
2. Grid of nodes vs. stack of nodes
3. One output-wide clip vs. 200 line-by-line clips
Each test performs two warm-up runs to give an initial estimate on the
required run counter, and will retry the run until at least 100 ms of
runtime is achieved (see TARGET_NS at the top).
The test uses the Go benchmark output format for compatibility with
benchstat. Each test will print the name of the test, the iteration
count used, the CPU time per operation and if available the GPU time per
operation.
The -count N argument can be used to re-run each test N times, which
benchstat uses to observe how much the results vary.
The test uses XRGB8888 and sRGB to stay within the Vulkan one-pass
pathway. Switch to e.g., XRGB2101010 or gamma22 to test the two-pass
pathway.
Example use with benchstat:
WLR_RENDERER=gles2 ./bench_render_pass -count=10 | tee gles2.txt
WLR_RENDERER=vulkan ./bench_render_pass -count=10 | tee vulkan.txt
benchstat gles2.txt vulkan.txt
Assisted-By: robots
|
||
|---|---|---|
| .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.