Go to file
Pekka Paalanen 3ea73cba04 server: document wl_event_loop and wl_event_source
This documents all the public API related to wl_event_loop and
wl_event_source objects.

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
Reviewed-by: Yong Bakos <ybakos@humanoriented.com>
[Pekka: fixed typos pointed by Yong]
[Pekka: fixed typos pointed by Christopher]
Reviewed-By: Christopher James Halse Rogers <christopher.halse.rogers@canonical.com>
2017-08-25 10:35:05 +03:00
cursor cursor: Remove "weston" from anonymous shm filenames 2016-11-21 09:58:25 +00:00
doc server: document wl_event_loop and wl_event_source 2017-08-25 10:35:05 +03:00
m4 Clean up .gitignore files 2010-11-11 20:11:27 -05:00
protocol protocol: add axis_source.wheel_tilt 2017-01-24 12:00:19 +02:00
spec doc: move documentation from the tex file to docbook 2012-03-28 23:04:25 -04:00
src server: document wl_event_loop and wl_event_source 2017-08-25 10:35:05 +03:00
tests connection-test: fix assert 2017-03-16 14:10:47 +02:00
.gitignore tests: add scanner tests 2016-11-23 10:18:44 +02:00
autogen.sh Update autotools configuration 2010-11-06 21:04:03 -04:00
configure.ac Reopen master for regular development 2017-08-08 12:03:27 -07:00
COPYING COPYING: Update to MIT Expat License rather than MIT X License 2015-06-12 15:31:21 -07:00
Makefile.am Pass input/output files as arguments to wayland-scanner 2017-08-18 15:20:24 +03:00
publish-doc publish-doc: Add script for publishing docs to the website 2015-05-27 15:34:20 -07:00
README README: Tiny cosmetic change 2014-10-08 12:20:17 +01:00
TODO Update TODO 2012-10-21 20:53:37 -04:00
wayland-scanner.m4 scanner: check for wayland-scanner.pc before using variables 2013-08-07 16:25:10 -07:00
wayland-scanner.mk Pass input/output files as arguments to wayland-scanner 2017-08-18 15:20:24 +03:00

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
modesetting and evdev input devices, an X application, or a wayland
client itself.  The clients can be traditional applications, X servers
(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
other interactions that must go through the compositor.  However, the
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.

The weston compositor is a reference implementation of a wayland
compositor and the weston repository also includes a few example
clients.

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
for wayland, weston, xwayland and various toolkits.