Merge pull request #731 from swaywm/layer-surfaces

Implement wlr-layer-shell protocol & rendering

2 files changed, 304 insertions, 0 deletions

diff --git a/examples/layer-shell.c b/examples/layer-shell.c
new file mode 100644
index 00000000..70407888
--- /dev/null
+++ b/examples/layer-shell.c
@@ -0,0 +1,298 @@
+#define _POSIX_C_SOURCE 199309L
+#include <assert.h>
+#include <GLES2/gl2.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <time.h>
+#include <unistd.h>
+#include <wayland-client.h>
+#include <wayland-egl.h>
+#include <wlr/render/egl.h>
+#include <wlr/util/log.h>
+#include "wlr-layer-shell-unstable-v1-client-protocol.h"
+
+static struct wl_compositor *compositor = NULL;
+static struct zwlr_layer_shell_v1 *layer_shell = NULL;
+struct zwlr_layer_surface_v1 *layer_surface;
+static struct wl_output *wl_output = NULL;
+
+struct wl_surface *wl_surface;
+struct wlr_egl egl;
+struct wl_egl_window *egl_window;
+struct wlr_egl_surface *egl_surface;
+struct wl_callback *frame_callback;
+
+static uint32_t output = 0;
+static uint32_t layer = ZWLR_LAYER_SHELL_V1_LAYER_BACKGROUND;
+static uint32_t anchor = 0;
+static uint32_t width = 256, height = 256;
+static int32_t margin_top = 0;
+static double alpha = 1.0;
+static bool run_display = true;
+static bool animate = false;
+static double frame = 0;
+
+static struct {
+	struct timespec last_frame;
+	float color[3];
+	int dec;
+} demo;
+
+static void draw(void);
+
+static void surface_frame_callback(
+		void *data, struct wl_callback *cb, uint32_t time) {
+	wl_callback_destroy(cb);
+	frame_callback = NULL;
+	draw();
+}
+
+static struct wl_callback_listener frame_listener = {
+	.done = surface_frame_callback
+};
+
+static void draw(void) {
+	eglMakeCurrent(egl.display, egl_surface, egl_surface, egl.context);
+
+	struct timespec ts;
+	clock_gettime(CLOCK_MONOTONIC, &ts);
+
+	long ms = (ts.tv_sec - demo.last_frame.tv_sec) * 1000 +
+		(ts.tv_nsec - demo.last_frame.tv_nsec) / 1000000;
+	int inc = (demo.dec + 1) % 3;
+
+	demo.color[inc] += ms / 2000.0f;
+	demo.color[demo.dec] -= ms / 2000.0f;
+
+	if (demo.color[demo.dec] < 0.0f) {
+		demo.color[inc] = 1.0f;
+		demo.color[demo.dec] = 0.0f;
+		demo.dec = inc;
+	}
+
+	if (animate) {
+		frame += ms / 50.0;
+		int32_t old_top = margin_top;
+		margin_top = -(20 - ((int)frame % 20));
+		if (old_top != margin_top) {
+			zwlr_layer_surface_v1_set_margin(layer_surface,
+					margin_top, 0, 0, 0);
+			wl_surface_commit(wl_surface);
+		}
+	}
+
+	glViewport(0, 0, width, height);
+	glClearColor(demo.color[0], demo.color[1], demo.color[2], alpha);
+	glClear(GL_COLOR_BUFFER_BIT);
+
+	frame_callback = wl_surface_frame(wl_surface);
+	wl_callback_add_listener(frame_callback, &frame_listener, NULL);
+
+	eglSwapBuffers(egl.display, egl_surface);
+
+	demo.last_frame = ts;
+}
+
+static void layer_surface_configure(void *data,
+		struct zwlr_layer_surface_v1 *surface,
+		uint32_t serial, uint32_t w, uint32_t h) {
+	width = w;
+	height = h;
+	if (egl_window) {
+		wl_egl_window_resize(egl_window, width, height, 0, 0);
+	}
+	zwlr_layer_surface_v1_ack_configure(surface, serial);
+}
+
+static void layer_surface_closed(void *data,
+		struct zwlr_layer_surface_v1 *surface) {
+	eglDestroySurface(egl.display, egl_surface);
+	wl_egl_window_destroy(egl_window);
+	zwlr_layer_surface_v1_destroy(surface);
+	wl_surface_destroy(wl_surface);
+	run_display = false;
+}
+
+struct zwlr_layer_surface_v1_listener layer_surface_listener = {
+	.configure = layer_surface_configure,
+	.closed = layer_surface_closed,
+};
+
+static void handle_global(void *data, struct wl_registry *registry,
+		uint32_t name, const char *interface, uint32_t version) {
+	if (strcmp(interface, "wl_compositor") == 0) {
+		compositor = wl_registry_bind(registry, name,
+				&wl_compositor_interface, 1);
+	} else if (strcmp(interface, "wl_output") == 0) {
+		if (output == 0 && !wl_output) {
+			wl_output = wl_registry_bind(registry, name,
+					&wl_output_interface, 1);
+		} else {
+			output--;
+		}
+	} else if (strcmp(interface, zwlr_layer_shell_v1_interface.name) == 0) {
+		layer_shell = wl_registry_bind(
+				registry, name, &zwlr_layer_shell_v1_interface, 1);
+	}
+}
+
+static void handle_global_remove(void *data, struct wl_registry *registry,
+		uint32_t name) {
+	// who cares
+}
+
+static const struct wl_registry_listener registry_listener = {
+	.global = handle_global,
+	.global_remove = handle_global_remove,
+};
+
+int main(int argc, char **argv) {
+	wlr_log_init(L_DEBUG, NULL);
+	char *namespace = "wlroots";
+	int exclusive_zone = 0;
+	int32_t margin_right = 0, margin_bottom = 0, margin_left = 0;
+	bool found;
+	int c;
+	while ((c = getopt(argc, argv, "nw:h:o:l:a:x:m:t:")) != -1) {
+		switch (c) {
+		case 'o':
+			output = atoi(optarg);
+			break;
+		case 'w':
+			width = atoi(optarg);
+			break;
+		case 'h':
+			height = atoi(optarg);
+			break;
+		case 'x':
+			exclusive_zone = atoi(optarg);
+			break;
+		case 'l': {
+			struct {
+				char *name;
+				enum zwlr_layer_shell_v1_layer value;
+			} layers[] = {
+				{ "background", ZWLR_LAYER_SHELL_V1_LAYER_BACKGROUND },
+				{ "bottom", ZWLR_LAYER_SHELL_V1_LAYER_BOTTOM },
+				{ "top", ZWLR_LAYER_SHELL_V1_LAYER_TOP },
+				{ "overlay", ZWLR_LAYER_SHELL_V1_LAYER_OVERLAY },
+			};
+			found = false;
+			for (size_t i = 0; i < sizeof(layers) / sizeof(layers[0]); ++i) {
+				if (strcmp(optarg, layers[i].name) == 0) {
+					layer = layers[i].value;
+					found = true;
+					break;
+				}
+			}
+			if (!found) {
+				fprintf(stderr, "invalid layer %s\n", optarg);
+				return 1;
+			}
+			break;
+		}
+		case 'a': {
+			struct {
+				char *name;
+				uint32_t value;
+			} anchors[] = {
+				{ "top", ZWLR_LAYER_SURFACE_V1_ANCHOR_TOP },
+				{ "bottom", ZWLR_LAYER_SURFACE_V1_ANCHOR_BOTTOM },
+				{ "left", ZWLR_LAYER_SURFACE_V1_ANCHOR_LEFT },
+				{ "right", ZWLR_LAYER_SURFACE_V1_ANCHOR_RIGHT },
+			};
+			found = false;
+			for (size_t i = 0; i < sizeof(anchors) / sizeof(anchors[0]); ++i) {
+				if (strcmp(optarg, anchors[i].name) == 0) {
+					anchor |= anchors[i].value;
+					found = true;
+					break;
+				}
+			}
+			if (!found) {
+				fprintf(stderr, "invalid anchor %s\n", optarg);
+				return 1;
+			}
+			break;
+		}
+		case 't':
+			alpha = atof(optarg);
+			break;
+		case 'm': {
+			char *endptr = optarg;
+			margin_top = strtol(endptr, &endptr, 10);
+			assert(*endptr == ',');
+			margin_right = strtol(endptr + 1, &endptr, 10);
+			assert(*endptr == ',');
+			margin_bottom = strtol(endptr + 1, &endptr, 10);
+			assert(*endptr == ',');
+			margin_left = strtol(endptr + 1, &endptr, 10);
+			assert(!*endptr);
+			break;
+		}
+		case 'n':
+			animate = true;
+			break;
+		default:
+			break;
+		}
+	}
+
+	struct wl_display *display = wl_display_connect(NULL);
+	if (display == NULL) {
+		fprintf(stderr, "Failed to create display\n");
+		return 1;
+	}
+
+	struct wl_registry *registry = wl_display_get_registry(display);
+	wl_registry_add_listener(registry, &registry_listener, NULL);
+	wl_display_roundtrip(display);
+
+	if (compositor == NULL) {
+		fprintf(stderr, "wl-compositor not available\n");
+		return 1;
+	}
+	if (layer_shell == NULL) {
+		fprintf(stderr, "layer-shell not available\n");
+		return 1;
+	}
+	if (wl_output == NULL) {
+		fprintf(stderr, "wl_output not available\n");
+		return 1;
+	}
+
+	EGLint attribs[] = { EGL_ALPHA_SIZE, 8, EGL_NONE };
+	wlr_egl_init(&egl, EGL_PLATFORM_WAYLAND_EXT, display,
+			attribs, WL_SHM_FORMAT_ARGB8888);
+
+	wl_surface = wl_compositor_create_surface(compositor);
+	assert(wl_surface);
+
+	layer_surface = zwlr_layer_shell_v1_get_layer_surface(layer_shell,
+				wl_surface, wl_output, layer, namespace);
+	assert(layer_surface);
+	zwlr_layer_surface_v1_set_size(layer_surface, width, height);
+	zwlr_layer_surface_v1_set_anchor(layer_surface, anchor);
+	zwlr_layer_surface_v1_set_exclusive_zone(layer_surface, exclusive_zone);
+	zwlr_layer_surface_v1_set_margin(layer_surface,
+			margin_top, margin_right, margin_bottom, margin_left);
+	zwlr_layer_surface_v1_add_listener(layer_surface,
+				   &layer_surface_listener, layer_surface);
+	// TODO: interactivity
+	wl_surface_commit(wl_surface);
+	wl_display_roundtrip(display);
+
+	egl_window = wl_egl_window_create(wl_surface, width, height);
+	assert(egl_window);
+	egl_surface = wlr_egl_create_surface(&egl, egl_window);
+	assert(egl_surface);
+
+	wl_display_roundtrip(display);
+	draw();
+
+	while (wl_display_dispatch(display) != -1 && run_display) {
+		// This space intentionally left blank
+	}
+	return 0;
+}
diff --git a/examples/meson.build b/examples/meson.build
index a83def8f..558af4ac 100644
--- a/examples/meson.build
+++ b/examples/meson.build
@@ -48,3 +48,9 @@ executable(
 	dependencies: [wayland_client, wlr_protos, wlroots, threads],
 	link_with: lib_shared,
 )
+
+executable(
+	'layer-shell',
+	'layer-shell.c',
+	dependencies: [wayland_client, wlr_protos, wlroots]
+)