blankie
/
wlroots
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
4,597 Commits 2 Branches 20 Tags 10 MiB
C 98.9%
Meson 1%
Go to file
Simon Ser 27fba3df43 render: use DRM formats in wlr_texture_from_pixels 2021-02-23 16:09:26 +01:00
.builds backend/x11: use native cursors 2021-02-05 11:45:54 +01:00
backend render: use DRM formats in wlr_renderer_read_pixels 2021-02-23 16:09:26 +01:00
docs render/egl: fail to create wlr_egl on software renderer 2021-01-27 15:50:19 +01:00
examples examples: remove wlroots dep from client examples 2021-02-14 16:49:54 +01:00
include render: use DRM formats in wlr_texture_from_pixels 2021-02-23 16:09:26 +01:00
protocol layer-shell: allow new values for keyboard-interactivity 2021-01-12 20:13:52 +01:00
render render: use DRM formats in wlr_texture_from_pixels 2021-02-23 16:09:26 +01:00
tinywl tinywl: fix wlr_backend_autocreate call 2021-01-07 14:39:04 +01:00
types render: use DRM formats in wlr_renderer_read_pixels 2021-02-23 16:09:26 +01:00
util build: use dictionnary for features instead of configuration_data 2021-02-15 16:32:33 +01:00
xcursor xcursor: make cursor data and metadata const 2021-02-05 10:04:20 +01:00
xwayland build: use dictionnary for features instead of configuration_data 2021-02-15 16:32:33 +01:00
.editorconfig Set .editorconfig ident_size 2019-01-25 11:37:46 +01:00
.gitignore Remove rootston 2019-08-09 08:34:59 +09:00
CONTRIBUTING.md contributing: add note about events that destroy objects 2020-06-08 10:12:38 -06:00
LICENSE Update LICENSE year (MIT license) 2018-04-12 21:29:59 -04:00
README.md backend/x11: drop x11-xcb dependency 2021-02-08 12:29:12 +01:00
meson.build build: bump meson version to 0.56.0 2021-02-15 23:45:26 +01:00
meson_options.txt types: add wlr_xdg_foreign_registry 2021-01-05 20:32:56 +01:00
wlroots.syms util: add wlr_output_destroy_safe 2020-02-17 20:52:37 +01:00

README.md

wlroots

Pluggable, composable, unopinionated modules for building a Wayland compositor; or about 50,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.

wlroots is developed under the direction of the sway project. A variety of wrapper libraries are available for using it with your favorite programming language.

Building

Install dependencies:

  • meson
  • wayland
  • wayland-protocols
  • EGL
  • GLESv2
  • libdrm
  • GBM
  • libinput
  • xkbcommon
  • udev
  • pixman
  • systemd (optional, for logind support)
  • elogind (optional, for logind support on systems without systemd)
  • libuuid (optional, for xdg-foreign support)

If you choose to enable X11 support:

  • xcb
  • xcb-composite
  • xcb-xfixes
  • xcb-xinput
  • xcb-image
  • xcb-render
  • xcb-errors (optional, for improved error reporting)
  • xcb-icccm (optional, for improved Xwayland introspection)

Run these commands:

meson build
ninja -C build

Install like so:

sudo ninja -C build install

Contributing

See CONTRIBUTING.md.