3. 编写第一个Wayland客户端
任务目标
编写一个最小的Wayland客户端程序,使用C语言连接Wayland显示服务(compositor),创建窗口并填充纯色背景,以验证客户端与Wayland服务端的基本通信链路是否正常。
环境与依赖
- Linux系统,已运行Wayland compositor(如weston、sway或gnome-shell的Wayland会话)
- 开发库:
libwayland-client-dev(Debian/Ubuntu)或wayland-devel(Fedora) - 编译工具:
gcc、pkg-config - 可选:
weston(若当前会话非Wayland,可用weston作为嵌套compositor测试)
核心实现
本案例使用Wayland协议的核心接口(wl_display, wl_registry, wl_compositor, wl_surface, wl_shm)完成最小闭环。客户端通过共享内存(wl_shm)提交一帧纯色像素数据,由compositor合成显示。代码不依赖任何第三方UI工具包,直接使用C语言与Wayland协议交互。
// wayland_client.c
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <fcntl.h>
#include <sys/mman.h>
#include <wayland-client.h>
static struct wl_compositor *compositor = NULL;
static struct wl_shm *shm = NULL;
static int width = 320, height = 240;
static void registry_global(void *data, struct wl_registry *registry,
uint32_t name, const char *interface,
uint32_t version) {
if (strcmp(interface, wl_compositor_interface.name) == 0) {
compositor = wl_registry_bind(registry, name,
&wl_compositor_interface, 1);
} else if (strcmp(interface, wl_shm_interface.name) == 0) {
shm = wl_registry_bind(registry, name, &wl_shm_interface, 1);
}
}
static void registry_global_remove(void *data, struct wl_registry *registry,
uint32_t name) {}
static const struct wl_registry_listener registry_listener = {
.global = registry_global,
.global_remove = registry_global_remove
};
static int create_shm_file(size_t size) {
char name[] = "/wl_shm_XXXXXX";
int fd = mkstemp(name);
if (fd < 0) return -1;
if (ftruncate(fd, size) < 0) { close(fd); return -1; }
unlink(name);
return fd;
}
int main(void) {
struct wl_display *display = wl_display_connect(NULL);
if (!display) {
fprintf(stderr, "无法连接Wayland display,请确认在Wayland会话中运行\n");
return 1;
}
struct wl_registry *registry = wl_display_get_registry(display);
wl_registry_add_listener(registry, ®istry_listener, NULL);
wl_display_roundtrip(display);
if (!compositor || !shm) {
fprintf(stderr, "未获取到compositor或shm接口\n");
return 1;
}
struct wl_shm_pool *pool;
struct wl_buffer *buffer;
struct wl_surface *surface;
void *shm_data;
int stride = width * 4;
int size = stride * height;
int fd = create_shm_file(size);
if (fd < 0) { fprintf(stderr, "创建共享内存失败\n"); return 1; }
shm_data = mmap(NULL, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
if (shm_data == MAP_FAILED) { fprintf(stderr, "mmap失败\n"); return 1; }
// 填充纯蓝色背景 (BGRA格式)
for (int i = 0; i < width * height; i++) {
((uint32_t *)shm_data)[i] = 0xFF0000FF; // 蓝色,不透明
}
pool = wl_shm_create_pool(shm, fd, size);
buffer = wl_shm_pool_create_buffer(pool, 0, width, height,
stride, WL_SHM_FORMAT_XRGB8888);
wl_shm_pool_destroy(pool);
surface = wl_compositor_create_surface(compositor);
wl_surface_attach(surface, buffer, 0, 0);
wl_surface_damage(surface, 0, 0, width, height);
wl_surface_commit(surface);
// 保持事件循环运行,等待compositor处理
while (wl_display_dispatch(display) != -1) {
// 持续分发事件;按Ctrl+C终止
}
wl_buffer_destroy(buffer);
wl_surface_destroy(surface);
wl_display_disconnect(display);
munmap(shm_data, size);
close(fd);
return 0;
}
编译与运行
gcc -o wayland_client wayland_client.c $(pkg-config --cflags --libs wayland-client)
./wayland_client
验证方法
- 程序启动后,屏幕上应出现一个320×240像素的蓝色矩形窗口。
- 窗口无响应属正常现象(本案例未实现事件处理),按
Ctrl+C终止程序。 - 若终端输出“无法连接Wayland display”,说明当前会话不是Wayland,可先运行
weston启动嵌套compositor,再在weston终端中执行本程序。 - 若窗口显示为黑色或花屏,检查共享内存格式是否与compositor支持一致(本代码使用XRGB8888,蓝色像素值为
0xFF0000FF,其中高8位为填充字节,实际RGB为0x0000FF)。
预期输出
程序正常运行时无终端输出,仅在连接失败或接口获取失败时打印错误信息。视觉上出现一个纯蓝色窗口即表示Wayland客户端与compositor通信成功。