Documentation for <wlr/types/wlr_idle_notify_v1.h>

Back to index

Table of contents

struct wlr_idle_notifier_v1 

struct wlr_idle_notifier_v1 {
	struct wl_global *global;
	
	// private state
	
	bool inhibited;
	struct wl_list notifications; // wlr_idle_notification_v1.link
	
	struct wl_listener display_destroy;
};

An idle notifier, implementing the ext-idle-notify-v1 protocol.

wlr_idle_notifier_v1_create() 

struct wlr_idle_notifier_v1 *wlr_idle_notifier_v1_create(​struct wl_display *display);

Create the ext_idle_notifier_v1 global.

wlr_idle_notifier_v1_notify_activity() 

void wlr_idle_notifier_v1_notify_activity(​struct wlr_idle_notifier_v1 *notifier, struct wlr_seat *seat);

Notify for user activity on a seat.

Compositors should call this function whenever an input event is triggered on a seat.

wlr_idle_notifier_v1_set_inhibited() 

void wlr_idle_notifier_v1_set_inhibited(​struct wlr_idle_notifier_v1 *notifier, bool inhibited);

Inhibit idle.

Compositors should call this function when the idle state is disabled, e.g. because a visible client is using the idle-inhibit protocol.