Package org.freedesktop.wayland.server

Interface ZwpTabletToolV2Requests

public interface ZwpTabletToolV2Requests

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	destroy(ZwpTabletToolV2Resource requester)	destroy the tool object
void	setCursor(ZwpTabletToolV2Resource requester, int serial, WlSurfaceResource surface, int hotspotX, int hotspotY)	set the tablet tool's surface

Field Details

VERSION

static final int VERSION

See Also:

• Constant Field Values

Method Details

setCursor

void setCursor(ZwpTabletToolV2Resource requester,
 int serial,
 @Nullable
 WlSurfaceResource surface,
 int hotspotX,
 int hotspotY)

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 wp_tablet_tool cursor. A surface may only ever be used as the cursor surface for one wp_tablet_tool. If the surface already has another role or has previously been used as cursor surface for a different tool, a protocol error is raised.

Parameters:

requester - The protocol object that made the request.

serial - serial of the proximity_in event

surface -

hotspotX - surface-local x coordinate

hotspotY - surface-local y coordinate

destroy

void destroy(ZwpTabletToolV2Resource requester)

destroy the tool object

This destroys the client's resource for this tool object.

Parameters:

requester - The protocol object that made the request.