zwp_tablet_tool_v1¤
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.
Methods:
-
set_cursor–Set the tablet tool's surface
-
destroy–Destroy the tool object
-
on_type–Tool type.
-
on_hardware_serial–Unique hardware serial number of the tool.
-
on_hardware_id_wacom–Hardware id notification in wacom's format.
-
on_capability–Tool capability notification.
-
on_done–Tool description events sequence complete.
-
on_removed–Tool removed.
-
on_proximity_in–Proximity in event.
-
on_proximity_out–Proximity out event.
-
on_down–Tablet tool is making contact.
-
on_up–Tablet tool is no longer making contact.
-
on_motion–Motion event.
-
on_pressure–Pressure change event.
-
on_distance–Distance change event.
-
on_tilt–Tilt change event.
-
on_rotation–Z-rotation change event.
-
on_slider–Slider position change event.
-
on_wheel–Wheel delta event.
-
on_button–Button event.
-
on_frame–Frame event.
A physical tool type
Describes the physical type of a tool. The physical type of a tool generally defines its base usage.
The mouse tool represents a mouse-shaped tool that is not a relative device but bound to the tablet's surface, providing absolute coordinates.
The lens tool is a mouse-shaped tool with an attached lens to provide precision focus.
hardware_serial(hardware_serial_hi: int, hardware_serial_lo: int) -> None
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:
hardware_id_wacom(hardware_id_hi: int, hardware_id_lo: int) -> None
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:
capability(capability: capability) -> None
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:
-
(capability¤capability) –The capability
done() -> None
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.
removed() -> None
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.
proximity_in(serial: int, tablet: zwp_tablet_v1, surface: wl_surface) -> None
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:
-
(tablet¤zwp_tablet_v1) –The tablet the tool is in proximity of
-
(surface¤wl_surface) –The current surface the tablet tool is over
proximity_out() -> None
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.
down(serial: int) -> None
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.
up() -> None
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.
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:
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:
Tilt change event
Sent whenever one or both of the tilt axes on a tool change. Each tilt value is in 0.01 of a degree, 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:
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:
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 0.01 of a degree 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:
button(serial: int, button: int, state: button_state) -> None
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:
-
(button¤int) –The button whose state has changed
-
(state¤button_state) –Whether the button was pressed or released
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:
Set the tablet tool's surface
Sets the surface of the cursor used for this tool on the given tablet. This request only takes effect if the tool is in proximity of one of the requesting client's surfaces or the surface parameter is the current pointer surface. If there was a previous surface set with this request it is replaced. If surface is NULL, the cursor image is hidden.
The parameters hotspot_x and hotspot_y define the position of the pointer surface relative to the pointer location. Its top-left corner is always at (x, y) - (hotspot_x, hotspot_y), where (x, y) are the coordinates of the pointer location, in surface-local coordinates.
On surface.attach requests to the pointer surface, hotspot_x and hotspot_y are decremented by the x and y parameters passed to the request. Attach must be confirmed by wl_surface.commit as usual.
The hotspot can also be updated by passing the currently set pointer surface to this request with new values for hotspot_x and hotspot_y.
The current and pending input regions of the wl_surface are cleared, and wl_surface.set_input_region is ignored until the wl_surface is no longer used as the cursor. When the use as a cursor ends, the current and pending input regions become undefined, and the wl_surface is unmapped.
This request gives the surface the role of a cursor. The role assigned by this request is the same as assigned by wl_pointer.set_cursor meaning the same surface can be used both as a wl_pointer cursor and a wp_tablet cursor. If the surface already has another role, it raises a protocol error. The surface may be used on multiple tablets and across multiple seats.
Parameters:
destroy() -> None
Destroy the tool object
This destroys the client's resource for this tool object.
on_type(tool_type: type) -> None
Tool type.
Override to handle wayland.zwp_tablet_tool_v1.events.type.
Unique hardware serial number of the tool.
Override to handle wayland.zwp_tablet_tool_v1.events.hardware_serial.
Hardware id notification in wacom's format.
Override to handle wayland.zwp_tablet_tool_v1.events.hardware_id_wacom.
on_capability(capability: capability) -> None
Tool capability notification.
Override to handle wayland.zwp_tablet_tool_v1.events.capability.
on_done() -> None
Tool description events sequence complete.
Override to handle wayland.zwp_tablet_tool_v1.events.done.
on_removed() -> None
Tool removed.
Override to handle wayland.zwp_tablet_tool_v1.events.removed.
on_proximity_in(serial: int, tablet: zwp_tablet_v1, surface: wl_surface) -> None
Proximity in event.
Override to handle wayland.zwp_tablet_tool_v1.events.proximity_in.
on_proximity_out() -> None
Proximity out event.
Override to handle wayland.zwp_tablet_tool_v1.events.proximity_out.
on_down(serial: int) -> None
Tablet tool is making contact.
Override to handle wayland.zwp_tablet_tool_v1.events.down.
on_up() -> None
Tablet tool is no longer making contact.
Override to handle wayland.zwp_tablet_tool_v1.events.up.
Motion event.
Override to handle wayland.zwp_tablet_tool_v1.events.motion.
on_pressure(pressure: int) -> None
Pressure change event.
Override to handle wayland.zwp_tablet_tool_v1.events.pressure.
on_distance(distance: int) -> None
Distance change event.
Override to handle wayland.zwp_tablet_tool_v1.events.distance.
Tilt change event.
Override to handle wayland.zwp_tablet_tool_v1.events.tilt.
on_rotation(degrees: int) -> None
Z-rotation change event.
Override to handle wayland.zwp_tablet_tool_v1.events.rotation.
on_slider(position: int) -> None
Slider position change event.
Override to handle wayland.zwp_tablet_tool_v1.events.slider.
Wheel delta event.
Override to handle wayland.zwp_tablet_tool_v1.events.wheel.
on_button(serial: int, button: int, state: button_state) -> None
Button event.
Override to handle wayland.zwp_tablet_tool_v1.events.button.
on_frame(time: int) -> None
Frame event.
Override to handle wayland.zwp_tablet_tool_v1.events.frame.