mirrors/wlroots
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wlroots/wlroots.git synced 2026-04-14 08:22:25 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
A modular Wayland compositor library
7427 commits 72 branches 46 tags 30 MiB
Find a file
Kenny Levinsen 57f8cf9cd4 xwayland: Introduce xwayland_spawn_func_t 
Spawning subprocesses is finicky, and the correct way to do it depends
on the current process state which we have no control of. Signal masks,
handlers, limits, scheduling and open file descriptors are a few
examples of things that inadvertently get inherited and cause issues for
either the parent or the child.

We introduced a temporary workaround against common issues by clearing
signal masks and signal handlers known to cause issues for Xwayland, but
this was only a bandaid.

Introduce xwayland_spawn_func_t, which allows the compositor to specify
an implementation of a process spawner that will be used to launch
Xwayland whenever needed. This spawner can then do any cleanup and
accounting as the compositor sees fit.

The spawner takes 4 arguments: The path to Xwayland, the arguments we
have constructed for Xwayland, the environment variables that must be
set for Xwayland, and the file descriptors that must have CLOEXEC
cleared after fork but before exec to be correctly inherited by
Xwayland.

A default implementation is provided both for convenience and as a
sample for implementers to look at.
2025-03-20 17:13:13 +01:00
.builds ci: fetch gyosu from new upstream 2025-03-06 10:32:09 +01:00
.gitlab/issue_templates Add GitLab issue template 2023-10-08 11:29:13 +00:00
backend backend/drm: fix enabling an output with a custom mode set 2025-03-07 13:00:06 +00:00
docs render: add WLR_RENDERER_FORCE_SOFTWARE env var 2024-12-22 21:37:57 +00:00
examples buffer: introduce wlr_buffer_finish() 2025-01-08 16:06:12 +00:00
include xwayland: Introduce xwayland_spawn_func_t 2025-03-20 17:13:13 +01:00
protocol Bump required w-p version to 1.40 2025-02-14 18:57:37 +00:00
render render/vulkan: unify alpha pre-multiplication in output shader 2025-02-23 15:41:23 +01:00
subprojects build: add Meson wrap manifests for our dependencies 2024-12-22 21:24:03 +00:00
tinywl Assert (almost all) signals have no attached listeners on destroy 2025-01-15 19:53:11 +03:00
types screencopy-v1: drop output_enable listener 2025-03-10 15:33:46 +08:00
util util/matrix: remove unnecessary include 2025-01-27 17:50:18 +01: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 xwayland: Introduce xwayland_spawn_func_t 2025-03-20 17:13:13 +01:00
.editorconfig editorconfig: Unset maximum line length for .git 2024-05-25 07:54:58 +00:00
.gitignore build: add Meson wrap manifests for our dependencies 2024-12-22 21:24:03 +00:00
.gitlab-ci.yml ci: generate and publish HTML documentation 2025-01-31 15:27:03 +00:00
.mailmap .mailmap: add myself 2024-08-05 19:32:24 +03:00
CONTRIBUTING.md CONTRIBUTING.md: mention listener list assertions 2025-01-20 16:17:12 +03:00
LICENSE license: add copyright line for all contributors 2023-07-05 10:27:50 +02:00
meson.build render/pixman: drop cast for pixman_image_set_clip_region32() 2025-01-29 23:33:50 +01:00
meson.options render/allocator: add udmabuf allocator 2024-12-22 21:37:57 +00: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

README.md

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.