From 24c397dbf888e9dc8a8b5ce4010f34eeb9158881 Mon Sep 17 00:00:00 2001 From: Simon Ser Date: Mon, 6 Sep 2021 18:38:01 +0200 Subject: viewporter: add doc comment explaining compositor requirements --- include/wlr/types/wlr_viewporter.h | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/include/wlr/types/wlr_viewporter.h b/include/wlr/types/wlr_viewporter.h index b695420d..0fdd34c8 100644 --- a/include/wlr/types/wlr_viewporter.h +++ b/include/wlr/types/wlr_viewporter.h @@ -11,6 +11,17 @@ #include +/** + * Implementation for the viewporter protocol. + * + * When enabling viewporter, compositors need to update their rendering logic: + * + * - The size of the surface texture may not match the surface size anymore. + * Compositors must use the surface size only. + * - Compositors must call wlr_render_subtexture_with_matrix when rendering a + * surface texture with the source box returned by + * wlr_surface_get_buffer_source_box. + */ struct wlr_viewporter { struct wl_global *global; -- cgit v1.2.3