hyprwm/wlroots-hyprland
1
0
Fork 0
mirror of https://github.com/hyprwm/wlroots-hyprland.git synced 2024-12-23 02:19:49 +01:00
Code Issues Projects Releases Packages Wiki Activity
A read-only mirror of https://github.com/hyprwm/wlroots-hyprland
6258 commits 3 branches 0 tags 13 MiB
C 98.7%
Meson 1%
GLSL 0.2%
Find a file
Simon Ser e2647c5151 keyboard: add support for resetting the keymap
2023-05-17 22:08:34 +00:00
.builds backend/drm: use libdisplay-info to parse EDID 2023-02-28 14:44:02 +00:00
backend drm_plane_pick_render_format: return false if no format could be found 2023-05-17 18:24:20 +00:00
docs backend/drm: add libliftoff interface 2023-02-20 18:38:57 +01:00
examples compositor: pass version in wlr_compositor_create 2023-04-14 17:07:26 +02:00
include render/vulkan: allow rendering to non-8-bit buffers 2023-05-12 15:09:02 +00:00
protocol wp-fractional-scale-v1: new protocol implementation 2023-02-08 16:31:39 +01:00
render wlr_drm_format_set_copy: Do not allocate heap 2023-05-14 17:50:08 +02:00
tinywl tinywl: Release everything before destroy 2023-05-02 10:48:31 -04:00
types keyboard: add support for resetting the keymap 2023-05-17 22:08:34 +00:00
util addon: Remove extra newline from logging 2022-12-22 11:18:01 -05:00
xcursor xcursor: Resolve warning in xcursor_build_theme_dir 2023-04-25 10:16:59 +00:00
xwayland xwayland: allow compositor to set withdrawn state 2023-05-04 18:05:00 +00:00
.editorconfig Relax 80 column limit 2022-11-22 18:19:46 +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
CONTRIBUTING.md Switch IRC channel to #wlroots 2023-02-13 14:21:58 +01:00
LICENSE Update LICENSE year (MIT license) 2018-04-12 21:29:59 -04:00
meson.build subcompositor: use bad_parent error 2023-04-14 17:00:17 +02:00
meson_options.txt backend/session: make optional 2022-11-25 16:15:29 +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.