blankie
/
wlroots
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

viewporter: add doc comment explaining compositor requirements

This commit is contained in:
Simon Ser 2021-09-06 18:38:01 +02:00
parent bb82b6dada
commit 24c397dbf8
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
include/wlr/types/wlr_viewporter.h
View File

@ -11,6 +11,17 @@
#include <wayland-server-core.h> #include <wayland-server-core.h>
/**
* 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 wlr_viewporter {
struct wl_global *global; struct wl_global *global;