mirrors/wlroots
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wlroots/wlroots.git synced 2025-11-22 06:59:44 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

output: clarify custom modes warning

Browse source 
References: https://gitlab.freedesktop.org/wlroots/wlroots/-/issues/3514
This commit is contained in:
Simon Ser 2022-10-20 09:54:43 +02:00 • committed by Simon Zeni
parent f0ee563416
commit ccf4e04036
1 changed files with 7 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
include/wlr/types/wlr_output.h
View file

@ -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, void wlr_output_set_mode(struct wlr_output *output,
struct wlr_output_mode *mode); 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 * Setting `refresh` to zero lets the backend pick a preferred value. The
* output needs to be enabled. * output needs to be enabled.
* *