Go to file

Simon Ser 9de93a866f backend/wayland: fallback to wl_shm on missing render node		2021-04-17 09:54:39 +02:00
.builds	ci: Add libseat-dev to alpine	2021-04-14 23:25:07 +02:00
backend	backend/wayland: fallback to wl_shm on missing render node	2021-04-17 09:54:39 +02:00
docs	backend/session: Remove session_impl	2021-04-14 23:25:07 +02:00
examples	examples/rotation: error out on invalid option	2021-04-16 08:58:29 +02:00
include	backend/wayland: add support for wl_shm buffers	2021-04-17 09:54:39 +02:00
protocol	build: remove wayland-scanner fallback	2021-04-11 17:37:54 +02:00
render	render: introduce shared memory allocator	2021-04-17 09:54:39 +02:00
tinywl	tinywl: fix wlr_backend_autocreate call	2021-01-07 14:39:04 +01:00
types	buffer: introduce wlr_buffer_get_shm	2021-04-17 09:54:39 +02:00
util	util/uuid: replace with util/token, remove libuuid	2021-04-11 19:09:36 +02:00
xcursor	xcursor: use memcpy() to append string of known size	2021-04-13 16:55:46 +02:00
xwayland	xwayland/sockets: ensure proper permissions	2021-04-16 11:53:05 +02: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	readme: mark libseat as mandatory dep	2021-04-17 09:48:26 +02:00
meson.build	backend/session: Make libseat mandatory	2021-04-14 23:25:07 +02:00
meson_options.txt	backend/session: Make libseat mandatory	2021-04-14 23:25:07 +02: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
libseat

If you choose to enable X11 support:

xwayland (build-time only, optional at runtime)
xcb
xcb-composite
xcb-xfixes
xcb-xinput
xcb-icccm
xcb-image
xcb-render
xcb-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.