Wayland

The Wayland display server

Wayland logo

Kristian Høgsberg

Intel Corporation

Copyright © 2012 Kristian Høgsberg, Intel Corporation

Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of the copyright holders not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. The copyright holders make no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.

THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Abstract

Wayland is a protocol for a compositor to talk to its clients as well as a C library implementation of that 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.


Table of Contents

Preface
Acknowledgments
1. Introduction
Motivation
The compositing manager as the display server
2. Types of Compositors
System Compositor
Session Compositor
Embedding Compositor
3. Wayland Architecture
X vs. Wayland Architecture
Wayland Rendering
Hardware Enabling for Wayland
4. Wayland Protocol and Model of Operation
Basic Principles
Code Generation
Wire Format
Interfaces
Versioning
Connect Time
Security and Authentication
Creating Objects
Compositor
Surfaces
Input
Output
Data sharing between clients
A. Wayland Protocol Specification
wl_display - core global object
wl_registry - global registry object
wl_callback - callback object
wl_compositor - the compositor singleton
wl_shm_pool - a shared memory pool
wl_shm - shared memory support
wl_buffer - content for a wl_surface
wl_data_offer - offer to transfer data
wl_data_source - offer to transfer data
wl_data_device - data transfer device
wl_data_device_manager - data transfer interface
wl_shell - create desktop-style surfaces
wl_shell_surface - desktop-style metadata interface
wl_surface - an onscreen surface
wl_seat - group of input devices
wl_pointer - pointer input device
wl_keyboard - keyboard input device
wl_touch - touchscreen input device
wl_output - compositor output region
wl_region - region interface
wl_subcompositor - sub-surface compositing
wl_subsurface - sub-surface interface to a wl_surface
B. Client API
map_entry
wl_argument - A union representing all of the basic data types that can be passed along the wayland wire format.
wl_array
wl_display - Represents a connection to the compositor and acts as a proxy to the wl_display singleton object.
wl_event_queue - A queue for wl_proxy object events.
wl_interface
wl_list - doubly-linked list
wl_message
wl_proxy - Represents a protocol object on the client side.
Functions
C. Server API
map_entry
wl_argument - A union representing all of the basic data types that can be passed along the wayland wire format.
wl_array
wl_buffer
wl_client
wl_display
wl_global
wl_interface
wl_list - doubly-linked list
wl_listener - A single listener for Wayland signals.
wl_message
wl_object
wl_resource
wl_shm_buffer
wl_shm_pool
wl_shm_sigbus_data
wl_signal - A source of a type of observable event.
wl_socket
Functions