Documentation for <wlr/types/wlr_subcompositor.h>

Back to index

Table of contents

struct wlr_subcompositor

struct wlr_subcompositor {
	struct wl_global *global;
	struct wl_listener display_destroy;
	struct {
		struct wl_signal destroy;
	} events;


struct wlr_subcompositor *wlr_subcompositor_create(​struct wl_display *display);

struct wlr_subsurface

struct wlr_subsurface {
	struct wl_resource *resource;
	struct wlr_surface *surface;
	struct wlr_surface *parent;
	struct wlr_subsurface_parent_state current, pending;
	uint32_t cached_seq;
	bool has_cache;
	bool synchronized;
	bool reordered;
	bool mapped;
	bool added;
	struct wl_listener surface_destroy;
	struct wl_listener surface_client_commit;
	struct wl_listener parent_destroy;
	struct {
		struct wl_signal destroy;
		struct wl_signal map;
		struct wl_signal unmap;
	} events;
	void *data;


struct wlr_subsurface *wlr_subsurface_from_wlr_surface(​struct wlr_surface *surface);

Get a struct wlr_subsurface from a struct wlr_surface. Asserts that the surface has the subsurface role. May return NULL even if the surface has the subsurface role if the corresponding subsurface has been destroyed.

struct wlr_subsurface_parent_state

struct wlr_subsurface_parent_state {
	int32_t x, y;
	struct wl_list link;

The sub-surface state describing the sub-surface's relationship with its parent. Contrary to other states, this one is not applied on surface commit. Instead, it's applied on parent surface commit.


bool wlr_surface_is_subsurface(​struct wlr_surface *surface);

Returns true if the surface has the subsurface role.