Core Wayland window system code and protocol
Find a file
Pekka Paalanen 6c3e9b8f54 protocol: try to clarify wl_buffer doc
Fix few typos in wl_buffer description.

Mention backing storage in wl_buffer.destroy.

Try to clarify the wl_buffer.release semantics by not explaining what
*might* happen. It is important to not suggest, that if release does not
come before frame callback, it will not come before attaching a new
buffer to the surface. We want to allow the following scenario:

The compositor is able to texture from wl_buffers directly, but it also
keeps a copy of the surface contents. The copy is updated when the
compositor is idle, to avoid the performance hit on
wl_surface.attach/commit. When the copy completes some time later, the
server sends the release event. If the client has not yet allocated a
second buffer (e.g. it updates rarely), it can reuse the old buffer.

Reported-by: John Kåre Alsaker <john.kare.alsaker@gmail.com>
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2012-10-16 11:06:51 -04:00
cursor Ensure cursor_data.c is included in distribution tarballs 2012-10-09 23:42:52 -04:00
doc docs: Make distcheck happy 2012-10-15 20:48:28 -04:00
m4 Clean up .gitignore files 2010-11-11 20:11:27 -05:00
protocol protocol: try to clarify wl_buffer doc 2012-10-16 11:06:51 -04:00
spec doc: move documentation from the tex file to docbook 2012-03-28 23:04:25 -04:00
src doc: Add doxygen documentation to wl_display_get_error() 2012-10-16 10:50:57 -04:00
tests Change filedescriptor API to be thread safe 2012-10-10 20:59:00 -04:00
.gitignore man: add man-page infrastructure 2012-09-25 11:02:52 -04:00
autogen.sh Update autotools configuration 2010-11-06 21:04:03 -04:00
configure.ac configure.ac: Bump version to 0.99.0 2012-10-15 20:49:41 -04:00
COPYING Add COPYING 2012-04-25 10:12:21 -04:00
Makefile.am configure: Make documentation option work in fact 2012-10-15 13:10:08 -04:00
README README: Update 2012-07-20 12:20:20 -04:00
TODO protocol: Add transform argument to wl_output.geometry event 2012-07-22 15:50:37 -04:00
wayland-scanner.m4.in Split into a core repository that only holds the core Wayland libraries 2011-02-14 22:21:13 -05: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 applications, 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 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.