From ccf4e040367414f53102b5a10507083688dff9b4 Mon Sep 17 00:00:00 2001 From: Simon Ser Date: Thu, 20 Oct 2022 09:54:43 +0200 Subject: [PATCH] output: clarify custom modes warning References: https://gitlab.freedesktop.org/wlroots/wlroots/-/issues/3514 --- include/wlr/types/wlr_output.h | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/include/wlr/types/wlr_output.h b/include/wlr/types/wlr_output.h index 309c2731..9d146209 100644 --- a/include/wlr/types/wlr_output.h +++ b/include/wlr/types/wlr_output.h @@ -295,7 +295,13 @@ struct wlr_output_mode *wlr_output_preferred_mode(struct wlr_output *output); void wlr_output_set_mode(struct wlr_output *output, struct wlr_output_mode *mode); /** - * Sets a custom mode on the output. If modes are available, they are preferred. + * Sets a custom mode on the output. + * + * When the output advertises fixed modes, custom modes are not guaranteed to + * work correctly, they may result in visual artifacts. If a suitable fixed mode + * is available, compositors should prefer it and use wlr_output_set_mode() + * instead of custom modes. + * * Setting `refresh` to zero lets the backend pick a preferred value. The * output needs to be enabled. *