tablet_unstable_v1

• # zwp_tablet_manager_v1

  An object that provides access to the graphics tablets available on this system. All tablets are associated with a seat, to get access to the actual tablets, use wp_tablet_manager.get_tablet_seat.

  Requests

  • #

    get_tablet_seat

    get the tablet seat
    struct zwp_tablet_seat_v1* zwp_tablet_manager_v1_get_tablet_seat(

    struct zwp_tablet_manager_v1* zwp_tablet_manager_v1,

    struct wl_seat* seat /* The wl_seat object to retrieve the tablets for */

    )
    Get the wp_tablet_seat object for the given seat. This object provides access to all graphics tablets in this seat.
  • #

    destroy

    release the memory for the tablet manager object
    void zwp_tablet_manager_v1_destroy(

    struct zwp_tablet_manager_v1* zwp_tablet_manager_v1

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

• # zwp_tablet_seat_v1

  An object that provides access to the graphics tablets available on this seat. After binding to this interface, the compositor sends a set of wp_tablet_seat.tablet_added and wp_tablet_seat.tool_added events.

  Requests

  • #

    destroy

    release the memory for the tablet seat object
    void zwp_tablet_seat_v1_destroy(

    struct zwp_tablet_seat_v1* zwp_tablet_seat_v1

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

  Events

  • #

    tablet_added

    new device notification
    struct zwp_tablet_v1* id /* the newly added graphics tablet */
    This event is sent whenever a new tablet becomes available on this seat. This event only provides the object id of the tablet, any static information about the tablet (device name, vid/pid, etc.) is sent through the wp_tablet interface.
  • #

    tool_added

    a new tool has been used with a tablet
    struct zwp_tablet_tool_v1* id /* the newly added tablet tool */
    This event is sent whenever a tool that has not previously been used with a tablet comes into use. This event only provides the object id of the tool; any static information about the tool (capabilities, type, etc.) is sent through the wp_tablet_tool interface.

• # zwp_tablet_tool_v1

  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.

  Requests

  • #

    set_cursor

    set the tablet tool's surface
    void zwp_tablet_tool_v1_set_cursor(

    struct zwp_tablet_tool_v1* zwp_tablet_tool_v1,

    uint32_t serial, /* serial of the enter event */

    struct wl_surface* surface,

    int32_t hotspot_x, /* surface-local x coordinate */

    int32_t hotspot_y /* surface-local y coordinate */

    )
    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.
  • #

    destroy

    destroy the tool object
    void zwp_tablet_tool_v1_destroy(

    struct zwp_tablet_tool_v1* zwp_tablet_tool_v1

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

  Events

  • #

    type

    tool type
    uint32_t tool_type /* the physical 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.
  • #

    hardware_serial

    unique hardware serial number of the tool
    uint32_t hardware_serial_hi /* the unique serial number of the tool, most significant bits */
    uint32_t hardware_serial_lo /* the unique serial number of the tool, least significant bits */
    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.
  • #

    hardware_id_wacom

    hardware id notification in Wacom's format
    uint32_t hardware_id_hi /* the hardware id, most significant bits */
    uint32_t hardware_id_lo /* the hardware id, least significant bits */
    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.
  • #

    capability

    tool capability notification
    uint32_t capability /* the capability */
    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.
  • #

    done

    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

    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

    proximity in event
    uint32_t serial
    struct zwp_tablet_v1* tablet /* The tablet the tool is in proximity of */
    struct wl_surface* surface /* The current surface the tablet tool is over */
    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.
  • #

    proximity_out

    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

    tablet tool is making contact
    uint32_t serial
    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

    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.
  • #

    motion

    motion event
    wl_fixed_t x /* surface-local x coordinate */
    wl_fixed_t y /* surface-local y coordinate */
    Sent whenever a tablet tool moves.
  • #

    pressure

    pressure change event
    uint32_t pressure /* The current pressure value */
    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.
  • #

    distance

    distance change event
    uint32_t distance /* The current distance value */
    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.
  • #

    tilt

    tilt change event
    int32_t tilt_x /* The current value of the X tilt axis */
    int32_t tilt_y /* The current value of the Y tilt axis */
    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.
  • #

    rotation

    z-rotation change event
    int32_t degrees /* The current rotation of the Z axis */
    Sent whenever the z-rotation axis on the tool changes. The rotation value is in 0.01 of a degree clockwise from the tool's logical neutral position.
  • #

    slider

    Slider position change event
    int32_t position /* The current position of slider */
    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.
  • #

    wheel

    Wheel delta event
    int32_t degrees /* The wheel delta in 0.01 of a degree */
    int32_t clicks /* The wheel delta in discrete clicks */
    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.
  • #

    button

    button event
    uint32_t serial
    uint32_t button /* The button whose state has changed */
    uint32_t state /* Whether the button was pressed or released */
    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.
  • #

    frame

    frame event
    uint32_t time /* The time of the event with millisecond granularity */
    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.

  Enums

  • #

    type

    a physical tool type
    ZWP_TABLET_TOOL_V1_TYPE_PEN /* Pen */
    ZWP_TABLET_TOOL_V1_TYPE_ERASER /* Eraser */
    ZWP_TABLET_TOOL_V1_TYPE_BRUSH /* Brush */
    ZWP_TABLET_TOOL_V1_TYPE_PENCIL /* Pencil */
    ZWP_TABLET_TOOL_V1_TYPE_AIRBRUSH /* Airbrush */
    ZWP_TABLET_TOOL_V1_TYPE_FINGER /* Finger */
    ZWP_TABLET_TOOL_V1_TYPE_MOUSE /* Mouse */
    ZWP_TABLET_TOOL_V1_TYPE_LENS /* Lens */
    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.
  • #

    capability

    capability flags for a tool
    ZWP_TABLET_TOOL_V1_CAPABILITY_TILT /* Tilt axes */
    ZWP_TABLET_TOOL_V1_CAPABILITY_PRESSURE /* Pressure axis */
    ZWP_TABLET_TOOL_V1_CAPABILITY_DISTANCE /* Distance axis */
    ZWP_TABLET_TOOL_V1_CAPABILITY_ROTATION /* Z-rotation axis */
    ZWP_TABLET_TOOL_V1_CAPABILITY_SLIDER /* Slider axis */
    ZWP_TABLET_TOOL_V1_CAPABILITY_WHEEL /* Wheel axis */
    Describes extra capabilities on a tablet. Any tool must provide x and y values, extra axes are device-specific.
  • #

    button_state

    physical button state
    ZWP_TABLET_TOOL_V1_BUTTON_STATE_RELEASED /* button is not pressed */
    ZWP_TABLET_TOOL_V1_BUTTON_STATE_PRESSED /* button is pressed */
    Describes the physical state of a button that produced the button event.
  • #

    error
    ZWP_TABLET_TOOL_V1_ERROR_ROLE /* given wl_surface has another role */

• # zwp_tablet_v1

  The wp_tablet interface represents one graphics tablet device. The tablet interface itself does not generate events; all events are generated by wp_tablet_tool 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 wp_tablet_seat.tablet_added event. This initial event sequence is terminated by a wp_tablet.done event.

  Requests

  • #

    destroy

    destroy the tablet object
    void zwp_tablet_v1_destroy(

    struct zwp_tablet_v1* zwp_tablet_v1

    )
    This destroys the client's resource for this tablet object.

  Events

  • #

    name

    tablet device name
    const char* name /* the device name */
    This event is sent in the initial burst of events before the wp_tablet.done event.
  • #

    id

    tablet device USB vendor/product id
    uint32_t vid /* USB vendor id */
    uint32_t pid /* USB product id */
    This event is sent in the initial burst of events before the wp_tablet.done event.
  • #

    path

    path to the device
    const char* path /* path to local device */
    A system-specific device path that indicates which device is behind this wp_tablet. 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 wp_tablet.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 wp_tablet.done event.
  • #

    done

    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.
  • #

    removed

    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 wp_tablet.destroy the object.

Copyright Info