nordic-dev.net/wlroots
2
0
Fork 0
mirror of https://gitlab.freedesktop.org/wlroots/wlroots.git synced 2024-11-25 16:42:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
A modular Wayland compositor library
5,800 Commits 70 Branches 31 Tags 22 MiB
C 98.8%
Meson 0.9%
GLSL 0.2%
ccf4e04036
Go to file
Simon Ser ccf4e04036 output: clarify custom modes warning 
References: https://gitlab.freedesktop.org/wlroots/wlroots/-/issues/3514
2022-10-20 10:43:50 +00:00
.builds ci/archlinux: enable address and undefined sanitizers 2021-11-19 16:42:14 +00:00
backend backend/drm: fetch current CRTC once on startup 2022-10-19 00:23:18 +00:00
docs wlr_scene: Account for occlusion by other scene nodes when calculating visibility 2022-08-14 02:38:51 -04:00
examples wlr_input_device: remove anon union field 2022-06-21 18:42:07 +00:00
include output: clarify custom modes warning 2022-10-20 10:43:50 +00:00
protocol idle-notify-v1: new protocol implementation 2022-10-14 13:36:15 +00:00
render render/vulkan: add missing entries in vulkan_strerror() 2022-10-18 16:57:00 +02:00
tinywl tinywl: exit on backend, renderer or allocator creation failure 2022-06-28 13:43:36 +00:00
types output: try to use fixed mode in wlr_output_set_custom_mode() 2022-10-20 09:49:16 +02:00
util util/set: overhaul 2022-08-29 13:48:42 +00:00
xcursor meson: replace join_paths() with / operator 2022-09-14 10:02:56 +02:00
xwayland xwyland/xwm: simplify unpaired_link handling 2022-10-19 09:26:03 +00:00
.editorconfig editorconfig: set max_line_length 2022-01-20 15:09:15 +01: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
CONTRIBUTING.md contributing: add section about documentation conventions 2022-05-25 14:22:58 +00:00
LICENSE Update LICENSE year (MIT license) 2018-04-12 21:29:59 -04:00
meson_options.txt build: make GBM optional 2022-05-30 13:30:08 +00:00
meson.build meson: update default options for libdrm 2022-09-25 12:54:38 +02:00
README.md build: make GBM optional 2022-05-30 13:30:08 +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: #sway-devel 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
  • pixman
  • libseat

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 build/
ninja -C build/

Install like so:

sudo ninja -C build/ install

Contributing

See CONTRIBUTING.md.