package wayland
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=0f882060a4cfe9424ed397676b8e2aaa931d84610beb29cb2ec9c355d1819625
sha512=847781a3d274da7463ad1a2e46bada3663b8dee08fa576ad787e7ba35cb0f39a3e1a0e6e9729db2f643885a35ae32ece0358c5897d31b68907cad44f1b26af31
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 and strips.
A pad device is a set of buttons, rings and strips 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 wp_tablet_seat.pad_added event before any actual events from this pad. This initial event sequence is terminated by a wp_tablet_pad.done event.
All pad features (buttons, rings and strips) are logically divided into groups and all pads have at least one group. The available groups are notified through the wp_tablet_pad.group event; the compositor will emit one event per group before emitting wp_tablet_pad.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
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 wp_tablet_pad.destroy the pad itself.
val leave :
[< `V1 ] 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 ] 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 ] 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 wp_tablet_pad initialization to announce the available buttons.
This event is sent in the initial burst of events before the wp_tablet_pad.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 wp_tablet_pad. 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 wp_tablet_pad.done event.
val group :
([< `V1 ] 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 wp_tablet_pad 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 wp_tablet_pad.done event. At least one group will be announced.
Handlers
Note: Servers will always want to use v1.