Go to file
Yong Bakos 1c3213adf0 server: Add doxygen comment for wl_client_for_each
Commit 596024f728 includes a doc comment
with a link to the wl_client_for_each macro, causing an error when generating
documentation.

Add a doc comment to wl_client_for_each, enabling the hyperlink and removing
the error.

Signed-off-by: Yong Bakos <ybakos@humanoriented.com>
Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
2016-08-12 12:43:37 -07:00
cursor (multiple): Include stdint.h 2016-07-25 18:39:32 -07:00
doc doc: Unpublish wl_display_get_additional_shm_formats 2016-06-01 17:34:17 -07:00
m4 Clean up .gitignore files 2010-11-11 20:11:27 -05:00
protocol protocol: Add release (destructor) request to wl_output 2016-08-08 16:22:52 +03:00
spec doc: move documentation from the tex file to docbook 2012-03-28 23:04:25 -04:00
src server: Add doxygen comment for wl_client_for_each 2016-08-12 12:43:37 -07:00
tests Add API to install protocol loggers on the server wl_display 2016-08-12 11:59:46 +03:00
.gitignore gitignore: Ignore some dist generated files 2015-07-30 18:18:25 -07:00
autogen.sh Update autotools configuration 2010-11-06 21:04:03 -04:00
configure.ac configure.ac: bump version to 1.11.90 for open development 2016-06-01 11:08:02 +03:00
COPYING COPYING: Update to MIT Expat License rather than MIT X License 2015-06-12 15:31:21 -07:00
Makefile.am Add API to install protocol loggers on the server wl_display 2016-08-12 11:59:46 +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 Split into a core repository that only holds the core Wayland libraries 2011-02-14 22:21:13 -05: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.