Core Wayland window system code and protocol
Find a file
Michel Dänzer 6137c8c213 protocol: Clarify wl_buffer.release description
Sebastian pointed out that the existing text could be read as
wl_buffer.destroy not being allowed before the wl_buffer.release event
arrives, contrary to what the wl_surface.attach description says.
Clarify to be consistent with the latter.

This is a follow-up for
https://gitlab.freedesktop.org/wayland/wayland/-/merge_requests/141 .

Signed-off-by: Michel Dänzer <mdaenzer@redhat.com>

v2:
* Simplify clarification, don't talk about callbacks. (Julian Orth)
* Add reference to details in the description of wl_surface.attach.
  (Daniel Stone)
v3:
* Tweak clarification again. (Sebastian Wick)
v4:
* Make clarification even less ambiguous. (Simon Ser, Julian Orth)
v5:
* Just refer to the description of wl_surface.attach instead of trying
  to clarify anything here. (Sebastian Wick)
2025-03-15 23:12:07 +00:00
.gitlab/issue_templates gitlab: make issue template the default 2023-11-21 15:44:31 +00:00
cursor cursor: add check to ensure wl_shm_create_pool succeeded 2024-10-18 16:49:45 +08:00
doc connection: Reject strings containing NUL bytes 2024-08-18 17:08:56 +00:00
egl egl: Disable symbols check for static builds 2024-03-28 13:13:47 +00:00
protocol protocol: Clarify wl_buffer.release description 2025-03-15 23:12:07 +00:00
src client: document get_listener behavior for dispatchers 2025-03-15 23:07:39 +00:00
tests scanner: use separate guards for validator functions 2025-02-23 23:38:15 +01:00
.editorconfig editorconfig: add settings for the .gitlab-ci.yml file 2020-06-05 08:22:34 +10:00
.gitignore build: drop autotools 2021-03-05 09:15:04 +00:00
.gitlab-ci.yml ci: Update ci-templates 2025-01-21 16:43:45 +00:00
.mailmap Add a .mailmap file 2023-03-25 11:17:32 -05:00
.triage-policies.yml Add a triage-policies file for bugbot 2023-07-07 21:18:08 +10:00
CONTRIBUTING.md CONTRIBUTING: fix typo "excercising" 2020-12-17 16:03:14 -05:00
COPYING COPYING: Update to MIT Expat License rather than MIT X License 2015-06-12 15:31:21 -07:00
meson.build meson: Fix use of install_data() without specifying install_dir 2024-08-15 14:13:57 +01:00
meson_options.txt meson: Use proper type for bools 2022-04-02 17:04:08 +03:00
README.md readme: convert to Markdown 2023-02-13 19:57:15 +01:00
release.sh release.sh: Don't push *all* tags 2023-01-16 10:03:54 +00:00
releasing.txt Add release.sh 2022-07-14 08:04:43 +00:00
wayland-scanner.m4 build: check wayland-scanner version 2020-01-16 17:25:06 +01:00
wayland-scanner.mk Pass input/output files as arguments to wayland-scanner 2017-08-18 15:20:24 +03:00

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.

Building the wayland libraries is fairly simple, aside from libffi, they don't have many dependencies:

$ git clone https://gitlab.freedesktop.org/wayland/wayland
$ cd wayland
$ meson build/ --prefix=PREFIX
$ ninja -C build/ install

where PREFIX is where you want to install the libraries.

See https://wayland.freedesktop.org for documentation.