Package org.freedesktop.wayland.client

Interface ZwpTabletToolV2Events

public interface ZwpTabletToolV2Events

a physical tablet tool

An object that represents a physical tool that has been, or is currently in use with a tablet in this seat. Each wp_tablet_tool object stays valid until the client destroys it; the compositor reuses the wp_tablet_tool object to indicate that the object's respective physical tool has come into proximity of a tablet again.

A wp_tablet_tool object's relation to a physical tool depends on the tablet's ability to report serial numbers. If the tablet supports this capability, then the object represents a specific physical tool and can be identified even when used on multiple tablets.

A tablet tool has a number of static characteristics, e.g. tool type, hardware_serial and capabilities. These capabilities are sent in an event sequence after the wp_tablet_seat.tool_added event before any actual events from this tool. This initial event sequence is terminated by a wp_tablet_tool.done event.

Tablet tool events are grouped by wp_tablet_tool.frame events. Any events received before a wp_tablet_tool.frame event should be considered part of the same hardware state change.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VERSION

Method Summary

Modifier and Type	Method	Description
void	button(ZwpTabletToolV2Proxy emitter, int serial, int button, int state)	button event
void	capability(ZwpTabletToolV2Proxy emitter, int capability)	tool capability notification
void	distance(ZwpTabletToolV2Proxy emitter, int distance)	distance change event
void	done(ZwpTabletToolV2Proxy emitter)	tool description events sequence complete
void	down(ZwpTabletToolV2Proxy emitter, int serial)	tablet tool is making contact
void	frame(ZwpTabletToolV2Proxy emitter, int time)	frame event
void	hardwareIdWacom(ZwpTabletToolV2Proxy emitter, int hardwareIdHi, int hardwareIdLo)	hardware id notification in Wacom's format
void	hardwareSerial(ZwpTabletToolV2Proxy emitter, int hardwareSerialHi, int hardwareSerialLo)	unique hardware serial number of the tool
void	motion(ZwpTabletToolV2Proxy emitter, Fixed x, Fixed y)	motion event
void	pressure(ZwpTabletToolV2Proxy emitter, int pressure)	pressure change event
void	proximityIn(ZwpTabletToolV2Proxy emitter, int serial, ZwpTabletV2Proxy tablet, WlSurfaceProxy surface)	proximity in event
void	proximityOut(ZwpTabletToolV2Proxy emitter)	proximity out event
void	removed(ZwpTabletToolV2Proxy emitter)	tool removed
void	rotation(ZwpTabletToolV2Proxy emitter, Fixed degrees)	z-rotation change event
void	slider(ZwpTabletToolV2Proxy emitter, int position)	Slider position change event
void	tilt(ZwpTabletToolV2Proxy emitter, Fixed tiltX, Fixed tiltY)	tilt change event
void	type(ZwpTabletToolV2Proxy emitter, int toolType)	tool type
void	up(ZwpTabletToolV2Proxy emitter)	tablet tool is no longer making contact
void	wheel(ZwpTabletToolV2Proxy emitter, Fixed degrees, int clicks)	Wheel delta event

Field Details

VERSION

static final int VERSION

See Also:

• Constant Field Values

Method Details

type

void type(ZwpTabletToolV2Proxy emitter,
 int toolType)

tool type

The tool type is the high-level type of the tool and usually decides the interaction expected from this tool.

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

Parameters:

emitter - The protocol object that emitted the event.

toolType - the physical tool type

hardwareSerial

void hardwareSerial(ZwpTabletToolV2Proxy emitter,
 int hardwareSerialHi,
 int hardwareSerialLo)

unique hardware serial number of the tool

If the physical tool can be identified by a unique 64-bit serial number, this event notifies the client of this serial number.

If multiple tablets are available in the same seat and the tool is uniquely identifiable by the serial number, that tool may move between tablets.

Otherwise, if the tool has no serial number and this event is missing, the tool is tied to the tablet it first comes into proximity with. Even if the physical tool is used on multiple tablets, separate wp_tablet_tool objects will be created, one per tablet.

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

Parameters:

emitter - The protocol object that emitted the event.

hardwareSerialHi - the unique serial number of the tool, most significant bits

hardwareSerialLo - the unique serial number of the tool, least significant bits

hardwareIdWacom

void hardwareIdWacom(ZwpTabletToolV2Proxy emitter,
 int hardwareIdHi,
 int hardwareIdLo)

hardware id notification in Wacom's format

This event notifies the client of a hardware id available on this tool.

The hardware id is a device-specific 64-bit id that provides extra information about the tool in use, beyond the wl_tool.type enumeration. The format of the id is specific to tablets made by Wacom Inc. For example, the hardware id of a Wacom Grip Pen (a stylus) is 0x802.

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

Parameters:

emitter - The protocol object that emitted the event.

hardwareIdHi - the hardware id, most significant bits

hardwareIdLo - the hardware id, least significant bits

capability

void capability(ZwpTabletToolV2Proxy emitter,
 int capability)

tool capability notification

This event notifies the client of any capabilities of this tool, beyond the main set of x/y axes and tip up/down detection.

One event is sent for each extra capability available on this tool.

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

Parameters:

emitter - The protocol object that emitted the event.

capability - the capability

done

void done(ZwpTabletToolV2Proxy emitter)

tool description events sequence complete

This event signals the end of the initial burst of descriptive events. A client may consider the static description of the tool to be complete and finalize initialization of the tool.

Parameters:

emitter - The protocol object that emitted the event.

removed

void removed(ZwpTabletToolV2Proxy emitter)

tool removed

This event is sent when the tool is removed from the system and will send no further events. Should the physical tool come back into proximity later, a new wp_tablet_tool object will be created.

It is compositor-dependent when a tool is removed. A compositor may remove a tool on proximity out, tablet removal or any other reason. A compositor may also keep a tool alive until shutdown.

If the tool is currently in proximity, a proximity_out event will be sent before the removed event. See wp_tablet_tool.proximity_out for the handling of any buttons logically down.

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

Parameters:

emitter - The protocol object that emitted the event.

proximityIn

void proximityIn(ZwpTabletToolV2Proxy emitter,
 int serial,
 @Nonnull
 ZwpTabletV2Proxy tablet,
 @Nonnull
 WlSurfaceProxy surface)

proximity in event

Notification that this tool is focused on a certain surface.

This event can be received when the tool has moved from one surface to another, or when the tool has come back into proximity above the surface.

If any button is logically down when the tool comes into proximity, the respective button event is sent after the proximity_in event but within the same frame as the proximity_in event.

Parameters:

emitter - The protocol object that emitted the event.

serial -

tablet - The tablet the tool is in proximity of

surface - The current surface the tablet tool is over

proximityOut

void proximityOut(ZwpTabletToolV2Proxy emitter)

proximity out event

Notification that this tool has either left proximity, or is no longer focused on a certain surface.

When the tablet tool leaves proximity of the tablet, button release events are sent for each button that was held down at the time of leaving proximity. These events are sent before the proximity_out event but within the same wp_tablet.frame.

If the tool stays within proximity of the tablet, but the focus changes from one surface to another, a button release event may not be sent until the button is actually released or the tool leaves the proximity of the tablet.

Parameters:

emitter - The protocol object that emitted the event.

down

void down(ZwpTabletToolV2Proxy emitter,
 int serial)

tablet tool is making contact

Sent whenever the tablet tool comes in contact with the surface of the tablet.

If the tool is already in contact with the tablet when entering the input region, the client owning said region will receive a wp_tablet.proximity_in event, followed by a wp_tablet.down event and a wp_tablet.frame event.

Note that this event describes logical contact, not physical contact. On some devices, a compositor may not consider a tool in logical contact until a minimum physical pressure threshold is exceeded.

Parameters:

emitter - The protocol object that emitted the event.

serial -

up

void up(ZwpTabletToolV2Proxy emitter)

tablet tool is no longer making contact

Sent whenever the tablet tool stops making contact with the surface of the tablet, or when the tablet tool moves out of the input region and the compositor grab (if any) is dismissed.

If the tablet tool moves out of the input region while in contact with the surface of the tablet and the compositor does not have an ongoing grab on the surface, the client owning said region will receive a wp_tablet.up event, followed by a wp_tablet.proximity_out event and a wp_tablet.frame event. If the compositor has an ongoing grab on this device, this event sequence is sent whenever the grab is dismissed in the future.

Note that this event describes logical contact, not physical contact. On some devices, a compositor may not consider a tool out of logical contact until physical pressure falls below a specific threshold.

Parameters:

emitter - The protocol object that emitted the event.

motion

void motion(ZwpTabletToolV2Proxy emitter,
 @Nonnull
 Fixed x,
 @Nonnull
 Fixed y)

motion event

Sent whenever a tablet tool moves.

Parameters:

emitter - The protocol object that emitted the event.

x - surface-local x coordinate

y - surface-local y coordinate

pressure

void pressure(ZwpTabletToolV2Proxy emitter,
 int pressure)

pressure change event

Sent whenever the pressure axis on a tool changes. The value of this event is normalized to a value between 0 and 65535.

Note that pressure may be nonzero even when a tool is not in logical contact. See the down and up events for more details.

Parameters:

emitter - The protocol object that emitted the event.

pressure - The current pressure value

distance

void distance(ZwpTabletToolV2Proxy emitter,
 int distance)

distance change event

Sent whenever the distance axis on a tool changes. The value of this event is normalized to a value between 0 and 65535.

Note that distance may be nonzero even when a tool is not in logical contact. See the down and up events for more details.

Parameters:

emitter - The protocol object that emitted the event.

distance - The current distance value

tilt

void tilt(ZwpTabletToolV2Proxy emitter,
 @Nonnull
 Fixed tiltX,
 @Nonnull
 Fixed tiltY)

tilt change event

Sent whenever one or both of the tilt axes on a tool change. Each tilt value is in degrees, relative to the z-axis of the tablet. The angle is positive when the top of a tool tilts along the positive x or y axis.

Parameters:

emitter - The protocol object that emitted the event.

tiltX - The current value of the X tilt axis

tiltY - The current value of the Y tilt axis

rotation

void rotation(ZwpTabletToolV2Proxy emitter,
 @Nonnull
 Fixed degrees)

z-rotation change event

Sent whenever the z-rotation axis on the tool changes. The rotation value is in degrees clockwise from the tool's logical neutral position.

Parameters:

emitter - The protocol object that emitted the event.

degrees - The current rotation of the Z axis

slider

void slider(ZwpTabletToolV2Proxy emitter,
 int position)

Slider position change event

Sent whenever the slider position on the tool changes. The value is normalized between -65535 and 65535, with 0 as the logical neutral position of the slider.

The slider is available on e.g. the Wacom Airbrush tool.

Parameters:

emitter - The protocol object that emitted the event.

position - The current position of slider

wheel

void wheel(ZwpTabletToolV2Proxy emitter,
 @Nonnull
 Fixed degrees,
 int clicks)

Wheel delta event

Sent whenever the wheel on the tool emits an event. This event contains two values for the same axis change. The degrees value is in the same orientation as the wl_pointer.vertical_scroll axis. The clicks value is in discrete logical clicks of the mouse wheel. This value may be zero if the movement of the wheel was less than one logical click.

Clients should choose either value and avoid mixing degrees and clicks. The compositor may accumulate values smaller than a logical click and emulate click events when a certain threshold is met. Thus, wl_tablet_tool.wheel events with non-zero clicks values may have different degrees values.

Parameters:

emitter - The protocol object that emitted the event.

degrees - The wheel delta in degrees

clicks - The wheel delta in discrete clicks

button

void button(ZwpTabletToolV2Proxy emitter,
 int serial,
 int button,
 int state)

button event

Sent whenever a button on the tool is pressed or released.

If a button is held down when the tool moves in or out of proximity, button events are generated by the compositor. See wp_tablet_tool.proximity_in and wp_tablet_tool.proximity_out for details.

Parameters:

emitter - The protocol object that emitted the event.

serial -

button - The button whose state has changed

state - Whether the button was pressed or released

frame

void frame(ZwpTabletToolV2Proxy emitter,
 int time)

frame event

Marks the end of a series of axis and/or button updates from the tablet. The Wayland protocol requires axis updates to be sent sequentially, however all events within a frame should be considered one hardware event.

Parameters:

emitter - The protocol object that emitted the event.

time - The time of the event with millisecond granularity