mirrors/wlroots
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wlroots/wlroots.git synced 2026-04-13 08:22:16 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
A modular Wayland compositor library
7485 commits 72 branches 46 tags 30 MiB
Find a file
Johan Malm 175c20d954 Revert removal of automatic drm reset on VT switch 
...on the basis that it reduces user-space breakage with respect to
layer-shell clients disappearing on suspend/resume and on VT change.

Revert the following two commits:

- 1edd5e2  "backend/drm: Remove reset from interface"
- 0f255b4  "backend/drm: Remove automatic reset on VT switch"

This it not intended to be reverted on the `master` branch. Instead, the
next wlroots release is anticipated to handle the situation differently,
possibly by splitting some objects and leaving output-related wl_globals
which have been announced to clients. See discussions on [issue-3944].

[issue-3944]: https://gitlab.freedesktop.org/wlroots/wlroots/-/issues/3944#note_3030632

Background:

With [MR-4878] on wlroots-0.19.0, the DRM backend destroys/recreates
outputs on VT switch and in some cases on suspend/resume too. The reason
for this change was that (i) the KMS state is undefined when a VT is
switched away; and (ii) the previous outputs had issues with restoration,
particularly when the output configuration had changed whilst switched
away. This change causes two issues for users:

- Some layer-shell clients do not re-appear on output re-connection, or
  may appear on a different output. Whilst this has always been the case,
  it will now also happen in said situations. It is technically possible
  for layer-shell clients to deal with this more thoughtfully by handling
  the new-output and surface-destroy signals to achieve desired
  behaviours, but such changes take time and meanwhile Desktop Environment
  teams and other users consider this a serious regression.

- Some Gtk clients issue critical warnings on some compositors as they
  assume that at least one output is always available. This will be fixed
  in `Gtk-3.24.50` and is believed to be a harmless warning,

[MR-4878]: https://gitlab.freedesktop.org/wlroots/wlroots/-/merge_requests/4878

Testing:

1. This reversion has been tested with [conky] and [GlassyClock]. With the
reversion applied, the clients remain visible after VT switching.
2. It was also tested with labwc on tty1; and sway on tty2. No adverse
affects were observed when changing output scales on either compositor.

[conky]: https://github.com/brndnmtthws/conky
[GlassyClock]: https://github.com/tsujan/GlassyClock
2025-08-03 13:01:45 +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 Revert removal of automatic drm reset on VT switch 2025-08-03 13:01:45 +01: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 Revert removal of automatic drm reset on VT switch 2025-08-03 13:01:45 +01:00
protocol color-management-v1: new protocol 2025-03-30 16:31:17 +02:00
render render/pixman: null check on newly created image 2025-05-07 21:33:22 +08: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 wlr-foreign-toplevel-management-v1: Simply leave and destroy code 2025-05-06 00:45:09 +02:00
util util/matrix: add matrix_invert() 2025-03-30 16:21:26 +02: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: handle unset _NET_WM_NAME 2025-05-15 10:23:01 +02: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: 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 build: bump version to 0.19.0 2025-05-15 10:47:57 +02: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.