A private fork of wlroots
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Simon Ser 49115e9d5d
render: rename wlr_renderer_get_dmabuf_formats
4 years ago
.builds session: Add libseat backend 4 years ago
backend backend/headless: use a format suitable for rendering 4 years ago
contrib build: replace version with soversion 5 years ago
docs xwayland: introduce WLR_XWAYLAND for specifying which Xwayland to use 4 years ago
examples Remove unneeded includes from wlr_input_device.h 4 years ago
include render: rename wlr_renderer_get_dmabuf_formats 4 years ago
protocol foreign toplevel: Fix whitespace error 4 years ago
render render: rename wlr_renderer_get_dmabuf_formats 4 years ago
tinywl Replace wlr_key_state with wl_keyboard_key_state 4 years ago
types render: rename wlr_renderer_get_dmabuf_formats 4 years ago
util util/region: add wlr_region_scale_xy 5 years ago
xcursor Fix undefined behavior 4 years ago
xwayland xwayland: log unhandled NET_WM_STATE property changes 4 years ago
.editorconfig Set .editorconfig ident_size 6 years ago
.gitignore Remove rootston 5 years ago
CONTRIBUTING.md contributing: add note about events that destroy objects 5 years ago
LICENSE Update LICENSE year (MIT license) 7 years ago
README.md Remove libcap support 5 years ago
meson.build render/egl: stop including eglmesaext.h 4 years ago
meson_options.txt session: Add libseat backend 4 years ago
wlroots.syms util: add wlr_output_destroy_safe 5 years ago

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)

If you choose to enable X11 support:

  • xcb
  • xcb-composite
  • xcb-xfixes
  • xcb-xinput
  • xcb-image
  • xcb-render
  • x11-xcb
  • xcb-errors (optional, for improved error reporting)
  • x11-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.