A private fork of wlroots

Go to file

Simon Ser 0ae3c7b1a2 Introduce wlr_shm This is a re-implementation of wl_shm. The motivations for using this over the one shipped in libwayland are: - Properly handle SIGBUS when accessing a wl_buffer's underlying data after the wl_buffer protocol object has been destroyed. With the current code, we just crash if the client does that and then shrinks the backing file. - No need to fight the wl_shm_buffer API anymore. This was awkward because we weren't notified when clients created a wl_shm buffer, and this doesn't play well with our wlr_buffer abstraction. - Access to the underlying FD. This makes it possible to forward the wl_shm buffer to a parent compositor with the Wayland/X11 backends. - Better stride checks. We can use our format table to ensure that the stride is consistent with the bpp and width.		2 years ago
.builds	backend/drm: use pnp.ids to fetch EDID data	2 years ago
backend	backend/x11: use request_state when window is resized	2 years ago
docs	egl: add WLR_EGL_NO_MODIFIERS	2 years ago
examples	wlr_input_device: remove anon union field	3 years ago
include	Introduce wlr_shm	2 years ago
protocol	content-type-v1: new protocol implementation	2 years ago
render	render/pixel_format: import pixel_format_info_check_stride()	2 years ago
tinywl	tinywl: handle view unmap while grabbed	2 years ago
types	Introduce wlr_shm	2 years ago
util	util/region: constify	2 years ago
xcursor	meson: replace join_paths() with / operator	2 years ago
xwayland	compositor: drop role object NULL checks in handlers	2 years ago
.editorconfig	editorconfig: set max_line_length	3 years ago
.gitignore	gitignore: remove build dir entries	3 years ago
.gitlab-ci.yml	ci: add .gitlab-ci.yml	3 years ago
CONTRIBUTING.md	contributing: add section about documentation conventions	3 years ago
LICENSE	Update LICENSE year (MIT license)	7 years ago
README.md	backend/drm: use pnp.ids to fetch EDID data	2 years ago
meson.build	build: bump pixman version	2 years ago
meson_options.txt	build: make GBM optional	3 years ago
wlroots.syms	build: simplify version script	4 years ago

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.