From 6634849dd51e75f498a453796a523494618efb51 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Molinari?= <loic.molinari@collabora.com>
Date: Mon, 6 May 2024 19:17:24 +0200
Subject: [PATCH] gl-renderer: Set up debug mode infrastructure
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Set up debug mode initial infrastructure using a dedicated key binding
and make shaders debug a debug mode.

Signed-off-by: Loïc Molinari <loic.molinari@collabora.com>
---
 libweston/renderer-gl/gl-renderer-internal.h |  4 +--
 libweston/renderer-gl/gl-renderer.c          | 35 +++++++++++---------
 libweston/renderer-gl/gl-shaders.c           |  3 --
 man/weston-bindings.man                      |  4 +--
 4 files changed, 23 insertions(+), 23 deletions(-)

diff --git a/libweston/renderer-gl/gl-renderer-internal.h b/libweston/renderer-gl/gl-renderer-internal.h
index 72037212..421d596a 100644
--- a/libweston/renderer-gl/gl-renderer-internal.h
+++ b/libweston/renderer-gl/gl-renderer-internal.h
@@ -165,8 +165,8 @@ struct gl_renderer {
 	struct weston_compositor *compositor;
 	struct weston_log_scope *renderer_scope;
 
-	struct weston_binding *fragment_binding;
-	bool fragment_shader_debug;
+	struct weston_binding *debug_mode_binding;
+	int debug_mode;
 
 	struct weston_binding *wireframe_binding;
 	bool wireframe_debug;
diff --git a/libweston/renderer-gl/gl-renderer.c b/libweston/renderer-gl/gl-renderer.c
index 62ab128c..539de9af 100644
--- a/libweston/renderer-gl/gl-renderer.c
+++ b/libweston/renderer-gl/gl-renderer.c
@@ -66,6 +66,12 @@
 
 #define BUFFER_DAMAGE_COUNT 2
 
+enum gl_debug_mode {
+	DEBUG_MODE_NONE = 0,
+	DEBUG_MODE_SHADERS,
+	DEBUG_MODE_LAST,
+};
+
 enum gl_border_status {
 	BORDER_STATUS_CLEAN = 0,
 	BORDER_TOP_DIRTY = 1 << GL_RENDERER_BORDER_TOP,
@@ -1394,6 +1400,7 @@ draw_mesh(struct gl_renderer *gr,
 		sconf->req.wireframe = wireframe;
 		sconf->wireframe_tex = gr->wireframe_tex;
 	}
+	sconf->req.green_tint = gr->debug_mode == DEBUG_MODE_SHADERS;
 
 	if (!gl_renderer_use_program(gr, sconf))
 		gl_renderer_send_shader_error(pnode); /* Use fallback shader. */
@@ -4149,8 +4156,8 @@ gl_renderer_destroy(struct weston_compositor *ec)
 	wl_array_release(&gr->barycentric_stream);
 	wl_array_release(&gr->indices);
 
-	if (gr->fragment_binding)
-		weston_binding_destroy(gr->fragment_binding);
+	if (gr->debug_mode_binding)
+		weston_binding_destroy(gr->debug_mode_binding);
 	if (gr->wireframe_binding)
 		weston_binding_destroy(gr->wireframe_binding);
 
@@ -4353,18 +4360,15 @@ fail:
 }
 
 static void
-fragment_debug_binding(struct weston_keyboard *keyboard,
-		       const struct timespec *time,
-		       uint32_t key, void *data)
+debug_mode_binding(struct weston_keyboard *keyboard,
+		   const struct timespec *time,
+		   uint32_t key, void *data)
 {
-	struct weston_compositor *ec = data;
-	struct gl_renderer *gr = get_renderer(ec);
-	struct weston_output *output;
+	struct weston_compositor *compositor = data;
+	struct gl_renderer *gr = get_renderer(compositor);
 
-	gr->fragment_shader_debug = !gr->fragment_shader_debug;
-
-	wl_list_for_each(output, &ec->output_list, link)
-		weston_output_damage(output);
+	gr->debug_mode = (gr->debug_mode + 1) % DEBUG_MODE_LAST;
+	weston_compositor_damage_all(compositor);
 }
 
 static void
@@ -4608,10 +4612,9 @@ gl_renderer_setup(struct weston_compositor *ec)
 		return -1;
 	}
 
-	gr->fragment_binding =
-		weston_compositor_add_debug_binding(ec, KEY_S,
-						    fragment_debug_binding,
-						    ec);
+	gr->debug_mode_binding =
+		weston_compositor_add_debug_binding(ec, KEY_M,
+						    debug_mode_binding, ec);
 	gr->wireframe_binding =
 		weston_compositor_add_debug_binding(ec, KEY_F,
 						    wireframe_debug_repaint_binding,
diff --git a/libweston/renderer-gl/gl-shaders.c b/libweston/renderer-gl/gl-shaders.c
index 51df3cf7..b5b2fe45 100644
--- a/libweston/renderer-gl/gl-shaders.c
+++ b/libweston/renderer-gl/gl-shaders.c
@@ -587,9 +587,6 @@ gl_renderer_get_program(struct gl_renderer *gr,
 
 	assert(reqs.pad_bits_ == 0);
 
-	if (gr->fragment_shader_debug)
-		reqs.green_tint = true;
-
 	if (gr->current_shader &&
 	    gl_shader_requirements_cmp(&reqs, &gr->current_shader->key) == 0)
 		return gr->current_shader;
diff --git a/man/weston-bindings.man b/man/weston-bindings.man
index 751111a8..fdf7172c 100644
--- a/man/weston-bindings.man
+++ b/man/weston-bindings.man
@@ -145,9 +145,9 @@ Enable/Disable overlay planes.
 .RS 4
 Start VAAPI recorder.
 .RE
-- KEY_S : 
+- KEY_M :
 .RS 4
-Enable fragment debugging for gl-renderer.
+Cycle through gl-renderer debug modes: none, shaders.
 .RE
 - KEY_F :
 .RS 4