Documentation for <wlr/types/wlr_pointer_constraints_v1.h>

Back to index

Table of contents

struct wlr_pointer_constraint_v1 

struct wlr_pointer_constraint_v1 {
	struct wlr_pointer_constraints_v1 *pointer_constraints;
	
	struct wl_resource *resource;
	struct wlr_surface *surface;
	struct wlr_seat *seat;
	enum zwp_pointer_constraints_v1_lifetime lifetime;
	enum wlr_pointer_constraint_v1_type type;
	pixman_region32_t region;
	
	struct wlr_pointer_constraint_v1_state current, pending;
	
	struct wl_list link; // wlr_pointer_constraints_v1.constraints
	
	struct {
		/**
		 * Called when a pointer constraint's region is updated,
		 * post-surface-commit.
		 */
		struct wl_signal set_region;
		struct wl_signal destroy;
	} events;
	
	void *data;
	
	struct {
		struct wl_listener surface_commit;
		struct wl_listener surface_destroy;
		struct wl_listener seat_destroy;
		
		struct wlr_surface_synced synced;
	} WLR_PRIVATE;
};

wlr_pointer_constraint_v1_send_activated() 

void wlr_pointer_constraint_v1_send_activated(​struct wlr_pointer_constraint_v1 *constraint);

wlr_pointer_constraint_v1_send_deactivated() 

void wlr_pointer_constraint_v1_send_deactivated(​struct wlr_pointer_constraint_v1 *constraint);

Deactivate the constraint. May destroy the constraint.

struct wlr_pointer_constraint_v1_state 

struct wlr_pointer_constraint_v1_state {
	uint32_t committed; // enum wlr_pointer_constraint_v1_state_field
	pixman_region32_t region;
	
	// only valid for locked_pointer
	struct {
		bool enabled;
		double x, y;
	} cursor_hint;
};

enum wlr_pointer_constraint_v1_state_field 

enum wlr_pointer_constraint_v1_state_field {
	WLR_POINTER_CONSTRAINT_V1_STATE_REGION,
	WLR_POINTER_CONSTRAINT_V1_STATE_CURSOR_HINT,
};

enum wlr_pointer_constraint_v1_type 

enum wlr_pointer_constraint_v1_type {
	WLR_POINTER_CONSTRAINT_V1_LOCKED,
	WLR_POINTER_CONSTRAINT_V1_CONFINED,
};

struct wlr_pointer_constraints_v1 

struct wlr_pointer_constraints_v1 {
	struct wl_global *global;
	struct wl_list constraints; // wlr_pointer_constraint_v1.link
	
	struct {
		struct wl_signal destroy;
		
		/**
		 * Called when a new pointer constraint is created.
		 *
		 * The data pointer is a struct wlr_pointer_constraint_v1.
		 */
		struct wl_signal new_constraint;
	} events;
	
	void *data;
	
	struct {
		struct wl_listener display_destroy;
	} WLR_PRIVATE;
};

wlr_pointer_constraints_v1_constraint_for_surface() 

struct wlr_pointer_constraint_v1 *wlr_pointer_constraints_v1_constraint_for_surface(​struct wlr_pointer_constraints_v1 *pointer_constraints, struct wlr_surface *surface, struct wlr_seat *seat);

wlr_pointer_constraints_v1_create() 

struct wlr_pointer_constraints_v1 *wlr_pointer_constraints_v1_create(​struct wl_display *display);