Product SiteDocumentation Site

Documentation 1.3

Wayland

The Wayland display server

Edition 1

Wayland logo

Kristian Høgsberg

Intel Corporation

Legal Notice

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.
Preface
Acknowledgments
1. Introduction
1.1. Motivation
1.2. The compositing manager as the display server
2. Types of Compositors
2.1. System Compositor
2.2. Session Compositor
2.3. Embedding Compositor
3. Wayland Architecture
3.1. X vs. Wayland Architecture
3.2. Wayland Rendering
3.3. Hardware Enabling for Wayland
4. Wayland Protocol and Model of Operation
4.1. Basic Principles
4.2. Code Generation
4.3. Wire Format
4.4. Interfaces
4.5. Versioning
4.6. Connect Time
4.7. Security and Authentication
4.8. Creating Objects
4.9. Compositor
4.10. Surfaces
4.11. Input
4.12. Output
4.13. Data sharing between clients
A. Wayland Protocol Specification
A.1. wl_display - core global object
A.2. wl_registry - global registry object
A.3. wl_callback - callback object
A.4. wl_compositor - the compositor singleton
A.5. wl_shm_pool - a shared memory pool
A.6. wl_shm - shared memory support
A.7. wl_buffer - content for a wl_surface
A.8. wl_data_offer - offer to transfer data
A.9. wl_data_source - offer to transfer data
A.10. wl_data_device - data transfer device
A.11. wl_data_device_manager - data transfer interface
A.12. wl_shell - create desktop-style surfaces
A.13. wl_shell_surface - desktop-style metadata interface
A.14. wl_surface - an onscreen surface
A.15. wl_seat - group of input devices
A.16. wl_pointer - pointer input device
A.17. wl_keyboard - keyboard input device
A.18. wl_touch - touchscreen input device
A.19. wl_output - compositor output region
A.20. wl_region - region interface
5. Wayland Library
5.1. Client API
5.2. Server API