Skip to content

zwp_confined_pointer_v1¤

wayland.zwp_confined_pointer_v1 ¤

Confined pointer object

The wp_confined_pointer interface represents a confined pointer state.

This object will send the event 'confined' when the confinement is activated. Whenever the confinement is activated, it is guaranteed that the surface the pointer is confined to will already have received pointer focus and that the pointer will be within the region passed to the request creating this object. It is up to the compositor to decide whether this requires some user interaction and if the pointer will warp to within the passed region if outside.

To unconfine the pointer, send the destroy request. This will also destroy the wp_confined_pointer object.

If the compositor decides to unconfine the pointer the unconfined event is sent. The wp_confined_pointer object is at this point defunct and should be destroyed.

Methods:

events

confined ¤

confined() -> None

Pointer confined

Notification that the pointer confinement of the seat's pointer is activated.

unconfined ¤

unconfined() -> None

Pointer unconfined

Notification that the pointer confinement of the seat's pointer is no longer active. If this is a oneshot pointer confinement (see wp_pointer_constraints.lifetime) this object is now defunct and should be destroyed. If this is a persistent pointer confinement (see wp_pointer_constraints.lifetime) this pointer confinement may again reactivate in the future.

destroy ¤

destroy() -> None

Destroy the confined pointer object

Destroy the confined pointer object. If applicable, the compositor will unconfine the pointer.

set_region ¤

set_region(region: wl_region) -> None

Set a new confine region

Set a new region used to confine the pointer.

The new confine region is double-buffered, see wl_surface.commit.

If the confinement is active when the new confinement region is applied and the pointer ends up outside of newly applied region, the pointer may warped to a position within the new confinement region. If warped, a wl_pointer.motion event will be emitted, but no wp_relative_pointer.relative_motion event.

The compositor may also, instead of using the new region, unconfine the pointer.

For details about the confine region, see wp_confined_pointer.

Parameters:

on_confined ¤

on_confined() -> None

Pointer confined.

Override to handle wayland.zwp_confined_pointer_v1.events.confined.

on_unconfined ¤

on_unconfined() -> None

Pointer unconfined.

Override to handle wayland.zwp_confined_pointer_v1.events.unconfined.