package wayland

  1. Overview
  2. Docs
Pure OCaml Wayland protocol library

Install 

dune-project
 Dependency

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

Authors

  1. T
    talex5@gmail.com

Maintainers

  1. T
    talex5@gmail.com

Sources

wayland-2.3.tbz
sha256=10627a94f4cef97147991528fcd246f8f27ccbf3026eafdece995b53ee9468a0
sha512=8e319dc236d04cc9084bf81782497899dca12a392d649a2ac7bd1d5edc1101ebe2bc266a033e23ab9ed46a8b692018bc47005036d10872f7825f4aa4009ab825

doc/wayland.protocols/Wayland_protocols/Tablet_v2_server/Zwp_tablet_v2/index.html

Module Tablet_v2_server.Zwp_tablet_v2Source

Graphics tablet device.

The zwp_tablet_v2 interface represents one graphics tablet device. The tablet interface itself does not generate events; all events are generated by zwp_tablet_tool_v2 objects when in proximity above a tablet.

A tablet has a number of static characteristics, e.g. device name and pid/vid. These capabilities are sent in an event sequence after the zwp_tablet_seat_v2.tablet_added event. This initial event sequence is terminated by a zwp_tablet_v2.done event.

Sourcetype 'v t = ([ `Zwp_tablet_v2 ], 'v, [ `Server ]) Wayland.Proxy.t

Version 1

Sourceval removed : [< `V1 | `V2 ] t -> unit

Tablet removed event.

Sent when the tablet has been removed from the system. When a tablet is removed, some tools may be removed.

When this event is received, the client must zwp_tablet_v2.destroy the object.

Sourceval done_ : [< `V1 | `V2 ] t -> unit

Tablet description events sequence complete.

This event is sent immediately to signal the end of the initial burst of descriptive events. A client may consider the static description of the tablet to be complete and finalize initialization of the tablet.

Sourceval path : [< `V1 | `V2 ] t -> path:string -> unit

Path to the device.

A system-specific device path that indicates which device is behind this zwp_tablet_v2. This information may be used to gather additional information about the device, e.g. through libwacom.

A device may have more than one device path. If so, multiple zwp_tablet_v2.path events are sent. A device may be emulated and not have a device path, and in that case this event will not be sent.

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_v2.done event.

Sourceval id : [< `V1 | `V2 ] t -> vid:int32 -> pid:int32 -> unit

Tablet device vendor/product id.

The vendor and product IDs for the tablet device.

The interpretation of the id depends on the zwp_tablet_v2.bustype. Prior to version v2 of this protocol, the id was implied to be a USB vendor and product ID. If no zwp_tablet_v2.bustype is sent, the ID is to be interpreted as USB vendor and product ID.

If the device has no vendor/product ID, this event is not sent. This can happen for virtual devices or non-USB devices, for instance.

This event is sent in the initial burst of events before the zwp_tablet_v2.done event.

Sourceval name : [< `V1 | `V2 ] t -> name:string -> unit

Tablet device name.

A descriptive name for the tablet device.

If the device has no descriptive name, this event is not sent.

This event is sent in the initial burst of events before the zwp_tablet_v2.done event.

Version 2

Sourceval bustype : [< `V2 ] t -> bustype:Imports.Zwp_tablet_v2.Bustype.t -> unit

Tablet device bus type.

The bustype argument is one of the BUS_ defines in the Linux kernel's linux/input.h

If the device has no known bustype or the bustype cannot be queried, this event is not sent.

This event is sent in the initial burst of events before the zwp_tablet_v2.done event.

Handlers

Note: Servers will always want to use v1.

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

Handler for a proxy with version >= 1.

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

Handler for a proxy with version >= 2.