README 1.56 KB
Newer Older
1 2 3 4 5
What is Wayland

Wayland is a project to define a protocol for a compositor to talk to
its clients as well as a library implementation of the protocol.  The
compositor can be a standalone display server running on Linux kernel
Siddharth Heroor's avatar
Siddharth Heroor committed
6
modesetting and evdev input devices, an X application, or a wayland
Peter Hutterer's avatar
Peter Hutterer committed
7
client itself.  The clients can be traditional applications, X servers
8 9 10 11 12 13 14
(rootless or fullscreen) or other display servers.

The wayland protocol is essentially only about input handling and
buffer management.  The compositor receives input events and forwards
them to the relevant client.  The clients creates buffers and renders
into them and notifies the compositor when it needs to redraw.  The
protocol also handles drag and drop, selections, window management and
Diego Viola's avatar
Diego Viola committed
15
other interactions that must go through the compositor.  However, the
16 17 18 19
protocol does not handle rendering, which is one of the features that
makes wayland so simple.  All clients are expected to handle rendering
themselves, typically through cairo or OpenGL.

Kristian Høgsberg's avatar
Kristian Høgsberg committed
20 21
The weston compositor is a reference implementation of a wayland
compositor and the weston repository also includes a few example
Siddharth Heroor's avatar
Siddharth Heroor committed
22
clients.
Kristian Høgsberg's avatar
Kristian Høgsberg committed
23 24 25 26 27 28 29 30 31 32 33 34

Building the wayland libraries is fairly simple, aside from libffi,
they don't have many dependencies:

    $ git clone git://anongit.freedesktop.org/wayland/wayland
    $ cd wayland
    $ ./autogen.sh --prefix=PREFIX
    $ make
    $ make install

where PREFIX is where you want to install the libraries.  See
http://wayland.freedesktop.org for more complete build instructions
Siddharth Heroor's avatar
Siddharth Heroor committed
35
for wayland, weston, xwayland and various toolkits.