blankie
/
wlroots
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
5,024 Commits 2 Branches 20 Tags 10 MiB
C 98.9%
Meson 1%
Go to file
Simon Ser 2ddd8e8036 contributing: add new section about commit log 
This is shamelessly stolen from Weston [1].

It's been a while we've transitioned away from merge commits and
work-style commit history, so it'd be nice to mention this in the
docs.

[1]: https://gitlab.freedesktop.org/wayland/weston/-/blob/main/CONTRIBUTING.md#formatting-and-separating-commits
 		2021-08-30 10:29:33 -04:00
.builds ci: add smoke test 2021-08-08 22:13:33 +02:00
backend backend/drm: introduce wlr_drm_bo_handle_table 2021-08-25 10:05:37 -04:00
docs render: introduce WLR_RENDERER in wlr_renderer_autocreate_with_drm_fd 2021-04-20 21:14:27 +02:00
examples examples/scene-graph: new example 2021-08-26 21:12:28 +02:00
include scene: add wlr_scene_node_surface_at 2021-08-26 21:12:28 +02:00
protocol xdg-activation-v1: new protocol implementation 2021-06-02 11:18:25 +02:00
render render/egl: reopen DRM node for GBM 2021-08-25 10:05:37 -04:00
tinywl tinywl: simplify logic for sending pointer events 2021-08-20 16:32:28 +02:00
types scene: add wlr_scene_node_surface_at 2021-08-26 21:12:28 +02:00
util util/box: introduce wlr_fbox_transform() 2021-08-24 10:36:06 +02:00
xcursor xcursor: fix CVE-2013-2003 2021-05-02 17:04:59 +02:00
xwayland xwm: do not restack surfaces on activation 2021-08-28 22:04:01 +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 new section about commit log 2021-08-30 10:29:33 -04:00
LICENSE Update LICENSE year (MIT license) 2018-04-12 21:29:59 -04:00
README.md readme: fix broken IRC web client link 2021-05-26 22:19:41 +02:00
meson.build build: remove "." from include dirs 2021-08-06 19:44:35 +02:00
meson_options.txt backend: make DRM and libinput backends optional 2021-07-22 09:56:38 -04:00
wlroots.syms build: simplify version script 2021-06-17 11:03:21 +02: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. 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.