Module wayland_protocols::wp::pointer_constraints::zv1::client::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.

Structs

• ZwpConfinedPointerV1
  confined pointer object

Enums

• Event
• Request

Constants

• EVT_CONFINED_OPCODE
  The wire opcode for this event
• EVT_CONFINED_SINCE
  The minimal object version supporting this event
• EVT_UNCONFINED_OPCODE
  The wire opcode for this event
• EVT_UNCONFINED_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
• REQ_SET_REGION_OPCODE
  The wire opcode for this request
• REQ_SET_REGION_SINCE
  The minimal object version supporting this request