Module ext_idle_notification_v1

Available on crate features staging and client only.

idle notification

This interface is used by the compositor to send idle notification events to clients.

Initially the notification object is not idle. The notification object becomes idle when no user activity has happened for at least the timeout duration, starting from the creation of the notification object. User activity may include input events or a presence sensor, but is compositor-specific.

How this notification responds to idle inhibitors depends on how it was constructed. If constructed from the get_idle_notification request, then if an idle inhibitor is active (e.g. another client has created a zwp_idle_inhibitor_v1 on a visible surface), the compositor must not make the notification object idle. However, if constructed from the get_input_idle_notification request, then idle inhibitors are ignored, and only input from the user, e.g. from a keyboard or mouse, counts as activity.

When the notification object becomes idle, an idled event is sent. When user activity starts again, the notification object stops being idle, a resumed event is sent and the timeout is restarted.

Structs

ExtIdleNotificationV1

idle notification

Enums

Event

Request

Constants

EVT_IDLED_OPCODE

The wire opcode for this event

EVT_IDLED_SINCE

The minimal object version supporting this event

EVT_RESUMED_OPCODE

The wire opcode for this event

EVT_RESUMED_SINCE

The minimal object version supporting this event

REQ_DESTROY_OPCODE

The wire opcode for this request

REQ_DESTROY_SINCE

The minimal object version supporting this request