mirror of
				https://gitlab.freedesktop.org/wlroots/wlroots.git
				synced 2025-11-03 09:01:40 -05:00 
			
		
		
		
	xwayland: add a few docs
This commit is contained in:
		
							parent
							
								
									dd2061b073
								
							
						
					
					
						commit
						73d2fd4d4f
					
				
					 1 changed files with 20 additions and 2 deletions
				
			
		| 
						 | 
					@ -21,6 +21,21 @@ struct wlr_xwm;
 | 
				
			||||||
struct wlr_data_source;
 | 
					struct wlr_data_source;
 | 
				
			||||||
struct wlr_drag;
 | 
					struct wlr_drag;
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					/**
 | 
				
			||||||
 | 
					 * Xwayland integration.
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 | 
					 * This includes a utility to start and monitor the Xwayland process (see
 | 
				
			||||||
 | 
					 * struct wlr_xwayland_server), an implementation of the xwayland_shell_v1
 | 
				
			||||||
 | 
					 * Wayland protocol, and a X11 window manager.
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 | 
					 * Compositors are expected to set DISPLAY (see display_name) and listen to the
 | 
				
			||||||
 | 
					 * new_surface event.
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 | 
					 * Compositors may want to only expose the xwayland_shell_v1 Wayland global to
 | 
				
			||||||
 | 
					 * the Xwayland client. To do so, they can set up a global filter via
 | 
				
			||||||
 | 
					 * wl_display_set_global_filter() to ensure the global stored in
 | 
				
			||||||
 | 
					 * shell_v1.global is only exposed to the client stored in server.client.
 | 
				
			||||||
 | 
					 */
 | 
				
			||||||
struct wlr_xwayland {
 | 
					struct wlr_xwayland {
 | 
				
			||||||
	struct wlr_xwayland_server *server;
 | 
						struct wlr_xwayland_server *server;
 | 
				
			||||||
	bool own_server;
 | 
						bool own_server;
 | 
				
			||||||
| 
						 | 
					@ -28,6 +43,7 @@ struct wlr_xwayland {
 | 
				
			||||||
	struct wlr_xwayland_shell_v1 *shell_v1;
 | 
						struct wlr_xwayland_shell_v1 *shell_v1;
 | 
				
			||||||
	struct wlr_xwayland_cursor *cursor;
 | 
						struct wlr_xwayland_cursor *cursor;
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
						// Value the DISPLAY environment variable should be set to by the compositor
 | 
				
			||||||
	const char *display_name;
 | 
						const char *display_name;
 | 
				
			||||||
 | 
					
 | 
				
			||||||
	struct wl_display *wl_display;
 | 
						struct wl_display *wl_display;
 | 
				
			||||||
| 
						 | 
					@ -47,13 +63,15 @@ struct wlr_xwayland {
 | 
				
			||||||
	 */
 | 
						 */
 | 
				
			||||||
	int (*user_event_handler)(struct wlr_xwm *xwm, xcb_generic_event_t *event);
 | 
						int (*user_event_handler)(struct wlr_xwm *xwm, xcb_generic_event_t *event);
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
						void *data;
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
						// private state
 | 
				
			||||||
 | 
					
 | 
				
			||||||
	struct wl_listener server_start;
 | 
						struct wl_listener server_start;
 | 
				
			||||||
	struct wl_listener server_ready;
 | 
						struct wl_listener server_ready;
 | 
				
			||||||
	struct wl_listener server_destroy;
 | 
						struct wl_listener server_destroy;
 | 
				
			||||||
	struct wl_listener seat_destroy;
 | 
						struct wl_listener seat_destroy;
 | 
				
			||||||
	struct wl_listener shell_destroy;
 | 
						struct wl_listener shell_destroy;
 | 
				
			||||||
 | 
					 | 
				
			||||||
	void *data;
 | 
					 | 
				
			||||||
};
 | 
					};
 | 
				
			||||||
 | 
					
 | 
				
			||||||
enum wlr_xwayland_surface_decorations {
 | 
					enum wlr_xwayland_surface_decorations {
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue