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 Zeni e5a949a955
backend/drm: implement drm lease function
3 years ago
.builds ci: add smoke test 3 years ago
backend backend/drm: implement drm lease function 3 years ago
docs render: introduce WLR_RENDERER in wlr_renderer_autocreate_with_drm_fd 4 years ago
examples examples/scene-graph: demonstrate scene_rect node type 3 years ago
include backend/drm: implement drm lease function 3 years ago
protocol build: add subproject fallback for wayland-protocols 3 years ago
render render/allocator/gbm: add log message for gbm_bo_get_fd_for_plane 3 years ago
tinywl tinywl: simplify logic for sending pointer events 3 years ago
types output-damage: fix damage on modeset 3 years ago
util util/shm: add allocate_shm_file_pair 3 years ago
xcursor xcursor: fix CVE-2013-2003 4 years ago
xwayland surface: drop wlr_surface_state.buffer_resource 3 years ago
.editorconfig Set .editorconfig ident_size 6 years ago
.gitignore Remove rootston 5 years ago
CONTRIBUTING.md contributing: don't reference issues in commit first line 3 years ago
LICENSE Update LICENSE year (MIT license) 7 years ago
README.md Link to gamja for web chat 3 years ago
meson.build build: add subproject fallback for wayland 3 years ago
meson_options.txt backend: make DRM and libinput backends 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 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. Join our IRC channel: #sway-devel on Libera Chat.

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)
  • 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.