package wayland
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=10627a94f4cef97147991528fcd246f8f27ccbf3026eafdece995b53ee9468a0
sha512=8e319dc236d04cc9084bf81782497899dca12a392d649a2ac7bd1d5edc1101ebe2bc266a033e23ab9ed46a8b692018bc47005036d10872f7825f4aa4009ab825
doc/wayland.protocols/Wayland_protocols/Tablet_v2_server/Zwp_tablet_pad_v2/index.html
Module Tablet_v2_server.Zwp_tablet_pad_v2Source
A set of buttons, rings, strips and dials.
A pad device is a set of buttons, rings, strips and dials usually physically present on the tablet device itself. Some exceptions exist where the pad device is physically detached, e.g. the Wacom ExpressKey Remote.
Pad devices have no axes that control the cursor and are generally auxiliary devices to the tool devices used on the tablet surface.
A pad device has a number of static characteristics, e.g. the number of rings. These capabilities are sent in an event sequence after the zwp_tablet_seat_v2.pad_added event before any actual events from this pad. This initial event sequence is terminated by a zwp_tablet_pad_v2.done event.
All pad features (buttons, rings, strips and dials) are logically divided into groups and all pads have at least one group. The available groups are notified through the zwp_tablet_pad_v2.group event; the compositor will emit one event per group before emitting zwp_tablet_pad_v2.done.
Groups may have multiple modes. Modes allow clients to map multiple actions to a single pad feature. Only one mode can be active per group, although different groups may have different active modes.
Version 1, 2
Pad removed event.
Sent when the pad has been removed from the system. When a tablet is removed its pad(s) will be removed too.
When this event is received, the client must destroy all rings, strips and groups that were offered by this pad, and issue zwp_tablet_pad_v2.destroy the pad itself.
val leave :
[< `V1 | `V2 ] t ->
serial:int32 ->
surface:([ `Wl_surface ], 'a, [ `Server ]) Wayland.Proxy.t ->
unitLeave event.
Notification that this pad is no longer focused on the specified surface.
val enter :
[< `V1 | `V2 ] t ->
serial:int32 ->
tablet:([ `Zwp_tablet_v2 ], 'a, [ `Server ]) Wayland.Proxy.t ->
surface:([ `Wl_surface ], 'b, [ `Server ]) Wayland.Proxy.t ->
unitEnter event.
Notification that this pad is focused on the specified surface.
val button :
[< `V1 | `V2 ] t ->
time:int32 ->
button:int32 ->
state:Imports.Zwp_tablet_pad_v2.Button_state.t ->
unitPhysical button state.
Sent whenever the physical state of a button changes.
Pad description event sequence complete.
This event signals the end of the initial burst of descriptive events. A client may consider the static description of the pad to be complete and finalize initialization of the pad.
Buttons announced.
Sent on zwp_tablet_pad_v2 initialization to announce the available buttons.
This event is sent in the initial burst of events before the zwp_tablet_pad_v2.done event. This event is only sent when at least one button is available.
Path to the device.
A system-specific device path that indicates which device is behind this zwp_tablet_pad_v2. This information may be used to gather additional information about the device, e.g. through libwacom.
The format of the path is unspecified, it may be a device node, a sysfs path, or some other identifier. It is up to the client to identify the string provided.
This event is sent in the initial burst of events before the zwp_tablet_pad_v2.done event.
val group :
([< `V1 | `V2 ] as 'a) t ->
[[ `Zwp_tablet_pad_group_v2 ], 'a, [ `Server ]] Wayland.Proxy.Handler.t ->
([ `Zwp_tablet_pad_group_v2 ], 'a, [ `Server ]) Wayland.Proxy.tGroup announced.
Sent on zwp_tablet_pad_v2 initialization to announce available groups. One event is sent for each pad group available.
This event is sent in the initial burst of events before the zwp_tablet_pad_v2.done event. At least one group will be announced.
Handlers
Note: Servers will always want to use v1.