From 40df321d7c504be4d32ea3a262dee46e962b6f90 Mon Sep 17 00:00:00 2001 From: Philipp Zabel Date: Mon, 17 Jul 2023 15:20:13 +0200 Subject: [PATCH] libweston: Document struct weston_mode The main point of this is to write down that the refresh field is in units of mHz. Signed-off-by: Philipp Zabel --- include/libweston/libweston.h | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/include/libweston/libweston.h b/include/libweston/libweston.h index 8be2abee..1df73ac1 100644 --- a/include/libweston/libweston.h +++ b/include/libweston/libweston.h @@ -129,12 +129,18 @@ enum weston_surface_protection_mode { WESTON_SURFACE_PROTECTION_MODE_ENFORCED }; +/** Possible mode of an output + * + * \ingroup output + */ struct weston_mode { uint32_t flags; + /** Picture aspect ratio.*/ enum weston_mode_aspect_ratio aspect_ratio; - int32_t width, height; - uint32_t refresh; - struct wl_list link; + int32_t width; /**< Width in pixels. */ + int32_t height; /**< Height in pixels. */ + uint32_t refresh; /**< Refresh rate in mHz. */ + struct wl_list link; /**< in weston_output::mode_list */ }; struct weston_animation {