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 <daniels@collabora.com>
This commit is contained in:
Daniel Stone 2025-10-08 11:55:20 +01:00 committed by Pekka Paalanen
parent 47f1c1e694
commit ef6747a951

View file

@ -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