|
Name |
|
Date |
Size |
#Lines |
LOC |
| .. | | 03-May-2022 | - |
| .builds/ | H | 08-Nov-2020 | - | 85 | 82 |
| backend/ | H | 08-Nov-2020 | - | 12,612 | 10,267 |
| contrib/ | H | 08-Nov-2020 | - | 29 | 22 |
| docs/ | H | 08-Nov-2020 | - | 49 | 34 |
| examples/ | H | 08-Nov-2020 | - | 11,252 | 9,673 |
| include/ | H | 08-Nov-2020 | - | 10,484 | 6,075 |
| protocol/ | H | 08-Nov-2020 | - | 3,388 | 2,848 |
| render/ | H | 08-Nov-2020 | - | 2,624 | 2,136 |
| tinywl/ | H | 08-Nov-2020 | - | 1,188 | 776 |
| types/ | H | 08-Nov-2020 | - | 24,125 | 19,867 |
| util/ | H | 08-Nov-2020 | - | 586 | 469 |
| xcursor/ | H | 03-May-2022 | - | 1,350 | 980 |
| xwayland/ | H | 03-May-2022 | - | 4,550 | 3,776 |
| .editorconfig | H A D | 08-Nov-2020 | 191 | 14 | 11 |
| .gitignore | H A D | 08-Nov-2020 | 88 | 10 | 9 |
| CONTRIBUTING.md | H A D | 08-Nov-2020 | 12.1 KiB | 365 | 283 |
| LICENSE | H A D | 08-Nov-2020 | 1.1 KiB | 21 | 17 |
| README.md | H A D | 08-Nov-2020 | 2.7 KiB | 83 | 66 |
| meson.build | H A D | 08-Nov-2020 | 4.9 KiB | 198 | 174 |
| wlroots.syms | H A D | 08-Nov-2020 | 131 | 12 | 11 |
README.md
1# wlroots
2
3Pluggable, composable, unopinionated modules for building a
4[Wayland](http://wayland.freedesktop.org/) compositor; or about 50,000 lines of
5code you were going to write anyway.
6
7- wlroots provides backends that abstract the underlying display and input
8 hardware, including KMS/DRM, libinput, Wayland, X11, and headless backends,
9 plus any custom backends you choose to write, which can all be created or
10 destroyed at runtime and used in concert with each other.
11- wlroots provides unopinionated, mostly standalone implementations of many
12 Wayland interfaces, both from wayland.xml and various protocol extensions.
13 We also promote the standardization of portable extensions across
14 many compositors.
15- wlroots provides several powerful, standalone, and optional tools that
16 implement components common to many compositors, such as the arrangement of
17 outputs in physical space.
18- wlroots provides an Xwayland abstraction that allows you to have excellent
19 Xwayland support without worrying about writing your own X11 window manager
20 on top of writing your compositor.
21- wlroots provides a renderer abstraction that simple compositors can use to
22 avoid writing GL code directly, but which steps out of the way when your
23 needs demand custom rendering code.
24
25wlroots implements a huge variety of Wayland compositor features and implements
26them *right*, so you can focus on the features that make your compositor
27unique. By using wlroots, you get high performance, excellent hardware
28compatibility, broad support for many wayland interfaces, and comfortable
29development tools - or any subset of these features you like, because all of
30them work independently of one another and freely compose with anything you want
31to implement yourself.
32
33Check out our [wiki](https://github.com/swaywm/wlroots/wiki/Getting-started) to
34get started with wlroots.
35
36wlroots is developed under the direction of the
37[sway](https://github.com/swaywm/sway) project. A variety of wrapper libraries
38[are available](https://github.com/swaywm) for using it with your favorite
39programming language.
40
41## Building
42
43Install dependencies:
44
45* meson
46* wayland
47* wayland-protocols
48* EGL
49* GLESv2
50* libdrm
51* GBM
52* libinput
53* xkbcommon
54* udev
55* pixman
56* systemd (optional, for logind support)
57* elogind (optional, for logind support on systems without systemd)
58
59If you choose to enable X11 support:
60
61* xcb
62* xcb-composite
63* xcb-xfixes
64* xcb-xinput
65* xcb-image
66* xcb-render
67* x11-xcb
68* xcb-errors (optional, for improved error reporting)
69* x11-icccm (optional, for improved Xwayland introspection)
70
71Run these commands:
72
73 meson build
74 ninja -C build
75
76Install like so:
77
78 sudo ninja -C build install
79
80## Contributing
81
82See [CONTRIBUTING.md](https://github.com/swaywm/wlroots/blob/master/CONTRIBUTING.md).
83