package wayland

You can search for identifiers within the package.

in-package search v0.2.0

Pure OCaml Wayland protocol library

Install

dune-project

Dependency

github.com Readme Changelog Edit opam file Versions (6)

Authors

T

talex5@gmail.com

Maintainers

T

talex5@gmail.com

Sources

wayland-2.2.tbz

sha256=0f882060a4cfe9424ed397676b8e2aaa931d84610beb29cb2ec9c355d1819625

sha512=847781a3d274da7463ad1a2e46bada3663b8dee08fa576ad787e7ba35cb0f39a3e1a0e6e9729db2f643885a35ae32ece0358c5897d31b68907cad44f1b26af31

doc/wayland.protocols/Wayland_protocols/Tablet_v2_client/Zwp_tablet_pad_v2/index.html

Module `Tablet_v2_client.Zwp_tablet_pad_v2`Source

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.

Sourcetype 'v t = ([ `Zwp_tablet_pad_v2 ], 'v, [ `Client ]) Wayland.Proxy.t

Sourcemodule Button_state = Tablet_v2_proto.Zwp_tablet_pad_v2.Button_state

Version 1

Sourceval destroy : [< `V1 ] t -> unit

Destroy the pad object.

Destroy the wp_tablet_pad object. Objects created from this object are unaffected and should be destroyed separately.

Source

val set_feedback : 
  [< `V1 ] t ->
  button:int32 ->
  description:string ->
  serial:int32 ->
  unit

Set compositor feedback.

Requests the compositor to use the provided feedback string associated with this button. This request should be issued immediately after a wp_tablet_pad_group.mode_switch event from the corresponding group is received, or whenever a button is mapped to a different action. See wp_tablet_pad_group.mode_switch for more details.

Clients are encouraged to provide context-aware descriptions for the actions associated with each button, and compositors may use this information to offer visual feedback on the button layout (e.g. on-screen displays).

Button indices start at 0. Setting the feedback string on a button that is reserved by the compositor (i.e. not belonging to any wp_tablet_pad_group) does not generate an error but the compositor is free to ignore the request.

The provided string 'description' is a UTF-8 encoded string to be associated with this ring, and is considered user-visible; general internationalization rules apply.

The serial argument will be that of the last wp_tablet_pad_group.mode_switch event received for the group of this button. Requests providing other serials than the most recent one will be ignored.

Handlers

Note: Servers will always want to use v1.

Sourceclass virtual +'a v1 : object ... end

Handler for a proxy with version >= 1.

On This Page

Version 1
Handlers