mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2025-10-29 05:40:16 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
Core Wayland window system code and protocol
1414 commits 25 branches 109 tags 13 MiB
Find a file
Aaron Faanes 217909c18d doc: Create \comment alias for C-style comments 
Since /* */ do not nest, documentation is forced to either use C++ style
// comments or some other foreign notation. This commit provides an alias
that allows C-style comments to be introduced in code blocks that support
aliases.

It should be noted that this macro will not work within \code blocks, as
Doxygen commands are ignored there. Instead, Doxygen's fenced code
blocks (created via ~~~) must be used for proper output. To demonstrate:

~~~
struct example_node {
        int id;
        \comment{Other members ...}
};
~~~

will roughly yield the following HTML (excluding syntax highlighting):

<pre>
struct example_node {
        int id;
        /* Other members ... */
};
</pre>
2013-09-21 11:29:08 -07:00
cursor pkgconfig: Use configure provided directories 2012-11-27 20:35:50 -05:00
doc doc: Create \comment alias for C-style comments 2013-09-21 11:29:08 -07:00
m4 Clean up .gitignore files 2010-11-11 20:11:27 -05:00
protocol protocol: Add release requests for wl_pointer, wl_keyboard, and wl_touch 2013-08-30 15:46:41 -07:00
spec doc: move documentation from the tex file to docbook 2012-03-28 23:04:25 -04:00
src wayland-server: Improve wording for wl_signal_get's doc 2013-09-16 21:59:28 -07:00
tests Replace two remaining wl_display_add_gloavl() occurences 2013-07-09 19:18:10 -04:00
.gitignore gitignore: add ./compile 2013-09-11 12:15:11 -07:00
autogen.sh Update autotools configuration 2010-11-06 21:04:03 -04:00
configure.ac configure.ac: Bump version to 1.2.90 for master branch 2013-08-30 15:53:55 -07:00
COPYING Add COPYING 2012-04-25 10:12:21 -04:00
Makefile.am build: Add wayland-scanner.pc. 2013-07-03 16:38:12 -04:00
README README: Fix typos 2013-02-14 12:14:54 -05: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

README 

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.