From ef6747a9511304df0e9c30b6ef6f8019ac5609b3 Mon Sep 17 00:00:00 2001 From: Daniel Stone Date: Wed, 8 Oct 2025 11:55:20 +0100 Subject: [PATCH] tests: Document default refresh-rate value Document what the magic refresh-rate values are, and which is set by default. Signed-off-by: Daniel Stone --- tests/weston-test-fixture-compositor.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/tests/weston-test-fixture-compositor.h b/tests/weston-test-fixture-compositor.h index 117446f95..962da197e 100644 --- a/tests/weston-test-fixture-compositor.h +++ b/tests/weston-test-fixture-compositor.h @@ -83,7 +83,9 @@ struct compositor_setup { unsigned height; /** Default output scale. */ int scale; - /** Default output refresh rate (headless backend). */ + /** Default output refresh rate (headless backend); set to + * HIGHEST_REFRESH_RATE for maximum throughput, or to 0 for only + * rendering on demand (e.g. when a screenshot is requested). */ int refresh; /** Default output transform, one of WL_OUTPUT_TRANSFORM_*. */ enum wl_output_transform transform; @@ -115,6 +117,7 @@ compositor_setup_defaults_(struct compositor_setup *setup, * - xwayland: no * - width: 320 * - height: 240 + * - refresh: 0 (repaint only on demand) * - scale: 1 * - transform: WL_OUTPUT_TRANSFORM_NORMAL * - config_file: none