mirror of
				https://gitlab.freedesktop.org/wlroots/wlroots.git
				synced 2025-11-03 09:01:40 -05:00 
			
		
		
		
	viewporter: add doc comment explaining compositor requirements
This commit is contained in:
		
							parent
							
								
									bb82b6dada
								
							
						
					
					
						commit
						24c397dbf8
					
				
					 1 changed files with 11 additions and 0 deletions
				
			
		| 
						 | 
				
			
			@ -11,6 +11,17 @@
 | 
			
		|||
 | 
			
		||||
#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 wl_global *global;
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue