struct wlr_xwayland ¶

struct wlr_xwayland {
	struct wlr_xwayland_server *server;
	bool own_server;
	struct wlr_xwm *xwm;
	struct wlr_xwayland_shell_v1 *shell_v1;
	struct wlr_xwayland_cursor *cursor;
	
	// Value the DISPLAY environment variable should be set to by the compositor
	const char *display_name;
	
	struct wl_display *wl_display;
	struct wlr_compositor *compositor;
	struct wlr_seat *seat;
	
	struct {
		struct wl_signal destroy;
		struct wl_signal ready;
		struct wl_signal new_surface; // struct wlr_xwayland_surface
		struct wl_signal remove_startup_info; // struct wlr_xwayland_remove_startup_info_event
	} events;
	
	/**
	 * Add a custom event handler to xwayland. Return true if the event was
	 * handled or false to use the default wlr-xwayland handler. wlr-xwayland will
	 * free the event.
	 */
	 bool (*user_event_handler)(​struct wlr_xwayland *wlr_xwayland, xcb_generic_event_t *event);
	
	void *data;
	
	struct {
		struct wl_listener server_start;
		struct wl_listener server_ready;
		struct wl_listener server_destroy;
		struct wl_listener seat_destroy;
		struct wl_listener shell_destroy;
	} WLR_PRIVATE;
};

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_minimize_event ¶

struct wlr_xwayland_minimize_event {
	struct wlr_xwayland_surface *surface;
	bool minimize;
};

struct wlr_xwayland_remove_startup_info_event ¶

struct wlr_xwayland_remove_startup_info_event {
	const char *id;
	xcb_window_t window;
};

struct wlr_xwayland_resize_event ¶

struct wlr_xwayland_resize_event {
	struct wlr_xwayland_surface *surface;
	uint32_t edges;
};

struct wlr_xwayland_surface ¶

struct wlr_xwayland_surface {
	xcb_window_t window_id;
	struct wlr_xwm *xwm;
	uint32_t surface_id;
	uint64_t serial;
	
	struct wl_list link;
	struct wl_list stack_link;
	struct wl_list unpaired_link;
	
	struct wlr_surface *surface;
	struct wlr_addon surface_addon;
	
	int16_t x, y;
	uint16_t width, height;
	bool override_redirect;
	
	char *title;
	char *class;
	char *instance;
	char *role;
	char *startup_id;
	pid_t pid;
	bool has_utf8_title;
	
	struct wl_list children; // wlr_xwayland_surface.parent_link
	struct wlr_xwayland_surface *parent;
	struct wl_list parent_link; // wlr_xwayland_surface.children
	
	xcb_atom_t *window_type;
	size_t window_type_len;
	
	xcb_atom_t *protocols;
	size_t protocols_len;
	
	uint32_t decorations;
	xcb_icccm_wm_hints_t *hints;
	xcb_size_hints_t *size_hints;
	/*
	 * _NET_WM_STRUT_PARTIAL (used by e.g. XWayland panels).
	 * Note that right/bottom values are offsets from the lower
	 * right corner of the X11 screen, and the exact relation
	 * between X11 screen coordinates and the wlr_output_layout
	 * depends on the XWayland implementation.
	 */
	xcb_ewmh_wm_strut_partial_t *strut_partial;
	
	bool pinging;
	struct wl_event_source *ping_timer;
	
	// _NET_WM_STATE
	 bool modal;
	bool fullscreen;
	bool maximized_vert, maximized_horz;
	bool minimized;
	bool withdrawn;
	bool sticky;
	bool shaded;
	bool skip_taskbar;
	bool skip_pager;
	bool above;
	bool below;
	bool demands_attention;
	
	bool has_alpha;
	
	struct {
		struct wl_signal destroy;
		struct wl_signal request_configure; // struct wlr_xwayland_surface_configure_event
		struct wl_signal request_move;
		struct wl_signal request_resize; // struct wlr_xwayland_resize_event
		struct wl_signal request_minimize; // struct wlr_xwayland_minimize_event
		struct wl_signal request_maximize;
		struct wl_signal request_fullscreen;
		struct wl_signal request_activate;
		struct wl_signal request_close;
		struct wl_signal request_sticky;
		struct wl_signal request_shaded;
		struct wl_signal request_skip_taskbar;
		struct wl_signal request_skip_pager;
		struct wl_signal request_above;
		struct wl_signal request_below;
		struct wl_signal request_demands_attention;
		
		struct wl_signal associate;
		struct wl_signal dissociate;
		
		struct wl_signal set_title;
		struct wl_signal set_class;
		struct wl_signal set_role;
		struct wl_signal set_parent;
		struct wl_signal set_startup_id;
		struct wl_signal set_window_type;
		struct wl_signal set_hints;
		struct wl_signal set_decorations;
		struct wl_signal set_strut_partial;
		struct wl_signal set_override_redirect;
		struct wl_signal set_geometry;
		struct wl_signal focus_in;
		struct wl_signal grab_focus;
		/* can be used to set initial maximized/fullscreen geometry */
		struct wl_signal map_request;
		struct wl_signal ping_timeout;
	} events;
	
	void *data;
	
	struct {
		struct wl_listener surface_commit;
		struct wl_listener surface_map;
		struct wl_listener surface_unmap;
	} WLR_PRIVATE;
};

An Xwayland user interface component. It has an absolute position in layout-local coordinates.

The inner struct wlr_surface is valid once the associate event is emitted. Compositors can set up e.g. map and unmap listeners at this point. The struct wlr_surface becomes invalid when the dissociate event is emitted.

struct wlr_xwayland_surface_configure_event ¶

struct wlr_xwayland_surface_configure_event {
	struct wlr_xwayland_surface *surface;
	int16_t x, y;
	uint16_t width, height;
	uint16_t mask; // xcb_config_window_t
};

struct wlr_xwm ¶

struct wlr_xwm;