a1bce0ead5
Both global_zombie_object and wl_interface_equal are private, yet were part of public documentation despite not being part of the public API. Move these two definitions to the top of an existing doxygen \cond block, which removes them from the public documentation. Signed-off-by: Yong Bakos <ybakos@humanoriented.com> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com> |
||
---|---|---|
cursor | ||
doc | ||
m4 | ||
protocol | ||
spec | ||
src | ||
tests | ||
.gitignore | ||
autogen.sh | ||
configure.ac | ||
COPYING | ||
Makefile.am | ||
publish-doc | ||
README | ||
TODO | ||
wayland-scanner.m4 | ||
wayland-scanner.mk |
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.