hyprwm/wlroots-hyprland
1
0
Fork 0
mirror of https://github.com/hyprwm/wlroots-hyprland.git synced 2024-11-22 04:45:58 +01:00
Code Issues Projects Releases Packages Wiki Activity
A read-only mirror of https://github.com/hyprwm/wlroots-hyprland
5868 commits 3 branches 0 tags 13 MiB
C 98.7%
Meson 1%
GLSL 0.2%
Find a file
Simon Ser fe4225d5de output: constify damage APIs
2022-11-11 23:11:17 +00:00
.builds backend/drm: use pnp.ids to fetch EDID data 2022-11-09 00:25:18 +03:00
backend backend: remove const casts for pixman_region32_t 2022-11-11 23:11:17 +00:00
docs egl: add WLR_EGL_NO_MODIFIERS 2022-10-21 09:52:18 +02:00
examples wlr_input_device: remove anon union field 2022-06-21 18:42:07 +00:00
include output: constify damage APIs 2022-11-11 23:11:17 +00:00
protocol wlr-output-management: implement adaptive sync 2022-10-24 16:19:25 +00:00
render render/texture: constify wlr_texture_update_from_buffer() 2022-11-11 23:11:17 +00:00
tinywl tinywl: handle view unmap while grabbed 2022-11-07 20:09:25 +03:00
types output: constify damage APIs 2022-11-11 23:11:17 +00:00
util util/region: constify 2022-11-11 23:11:17 +00:00
xcursor meson: replace join_paths() with / operator 2022-09-14 10:02:56 +02:00
xwayland compositor: drop role object NULL checks in handlers 2022-11-06 17:00:00 +03: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.build build: bump pixman version 2022-11-11 23:11:17 +00:00
meson_options.txt build: make GBM optional 2022-05-30 13:30:08 +00:00
README.md backend/drm: use pnp.ids to fetch EDID data 2022-11-09 00:25:18 +03: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
  • hwdata (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 build/
ninja -C build/

Install like so:

sudo ninja -C build/ install

Contributing

See CONTRIBUTING.md.