mirrors/wlroots
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wlroots/wlroots.git synced 2026-04-17 06:46:39 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
A modular Wayland compositor library
7247 commits 72 branches 46 tags 30 MiB
Find a file
Alexander Orzechowski 7ba7f774ca wlr_compositor: Introduce wlr_surface_consume 
If the compositor is running without a renderer, that means that
the compositor must be driven by something external that may or may not
be there. So we have two scenarios:
1. This compositor is currently being watched and driven by some
external source that is consuming buffers. This is okay, because
during the commit handler `surface->current.buffer` and
`surface->buffer_damage` will be usable and things will be handled
like normal.
2. Things break however if the compositor is not currently driven. This
however is commonly temporary. Something may not be interested right now,
but later it can be. In this case we have to accumulate state until
this external consumer is ready. Here, we have to accumulate the
`buffer_damage` and keep the buffer locked until the consumer is ready.

`wlr_surface_consume` needs to be called when the state of this surface
was consumed so that it is safe to release these resources.
2024-09-14 17:43:56 -04:00
.builds ci: Remove package 'gmake' 2024-07-29 11:39:34 -04:00
.gitlab/issue_templates Add GitLab issue template 2023-10-08 11:29:13 +00:00
backend x11/backend: Optimize query_version error handling 2024-09-12 17:52:26 +08:00
docs render: add WLR_RENDER_NO_EXPLICIT_SYNC env var 2024-08-06 17:37:06 +00:00
examples output/render: Drop buffer age from wlr_output_begin_render_pass 2024-08-21 09:45:54 -04:00
include wlr_compositor: Introduce wlr_surface_consume 2024-09-14 17:43:56 -04:00
protocol layer-shell: add v5 support 2024-08-18 01:02:08 +00:00
render gles2/pass: remove duplicate variable declarations 2024-08-27 20:25:18 +08:00
tinywl tinywl: Use wlr_raster 2024-09-14 17:42:41 -04:00
types wlr_compositor: Introduce wlr_surface_consume 2024-09-14 17:43:56 -04:00
util util/box: Introduce wlr_box_contains_box 2024-08-06 20:00:01 -04: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/xwm: listen shell destroy signal 2024-08-13 11:33:04 +08:00
.editorconfig editorconfig: Unset maximum line length for .git 2024-05-25 07:54:58 +00:00
.gitignore gitignore: remove build dir entries 2022-06-14 10:08:54 +02:00
.gitlab-ci.yml ci: add .gitlab-ci.yml 2021-11-01 16:51:18 +01:00
.mailmap .mailmap: add myself 2024-08-05 19:32:24 +03:00
CONTRIBUTING.md contributing: add safety section 2023-10-04 11:08:58 +02:00
LICENSE license: add copyright line for all contributors 2023-07-05 10:27:50 +02:00
meson.build Fix Meson version required for C23 support 2024-08-10 15:54:23 +00:00
meson_options.txt add an option to enable/disable libliftoff 2024-06-05 22:33:05 -06: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.