Enum Event

#[non_exhaustive]
pub enum Event {
    Type {
        tool_type: WEnum<Type>,
    },
    HardwareSerial {
        hardware_serial_hi: u32,
        hardware_serial_lo: u32,
    },
    HardwareIdWacom {
        hardware_id_hi: u32,
        hardware_id_lo: u32,
    },
    Capability {
        capability: WEnum<Capability>,
    },
    Done,
    Removed,
    ProximityIn {
        serial: u32,
        tablet: ZwpTabletV2,
        surface: WlSurface,
    },
    ProximityOut,
    Down {
        serial: u32,
    },
    Up,
    Motion {
        x: f64,
        y: f64,
    },
    Pressure {
        pressure: u32,
    },
    Distance {
        distance: u32,
    },
    Tilt {
        tilt_x: f64,
        tilt_y: f64,
    },
    Rotation {
        degrees: f64,
    },
    Slider {
        position: i32,
    },
    Wheel {
        degrees: f64,
        clicks: i32,
    },
    Button {
        serial: u32,
        button: u32,
        state: WEnum<ButtonState>,
    },
    Frame {
        time: u32,
    },
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Type

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.

Fields

tool_type: WEnum<Type>

the physical tool type

HardwareSerial

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.

Fields

hardware_serial_hi: u32

the unique serial number of the tool, most significant bits

hardware_serial_lo: u32

the unique serial number of the tool, least significant bits

HardwareIdWacom

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.

Fields

hardware_id_hi: u32

the hardware id, most significant bits

hardware_id_lo: u32

the hardware id, least significant bits

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.

Fields

capability: WEnum<Capability>

the capability

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.

ProximityIn

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.

Fields

serial: u32

tablet: ZwpTabletV2

The tablet the tool is in proximity of

surface: WlSurface

The current surface the tablet tool is over

ProximityOut

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

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.

Fields

serial: u32

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

Sent whenever a tablet tool moves.

Fields

x: f64

surface-local x coordinate

y: f64

surface-local y coordinate

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.

Fields

pressure: u32

The current pressure value

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.

Fields

distance: u32

The current distance value

Tilt

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.

Fields

tilt_x: f64

The current value of the X tilt axis

tilt_y: f64

The current value of the Y tilt axis

Rotation

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.

Fields

degrees: f64

The current rotation of the Z axis

Slider

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.

Fields

position: i32

The current position of slider

Wheel

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.

Fields

degrees: f64

The wheel delta in degrees

clicks: i32

The wheel delta in discrete clicks

Button

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.

Fields

serial: u32

button: u32

The button whose state has changed

state: WEnum<ButtonState>

Whether the button was pressed or released

Frame

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.

Fields

time: u32

The time of the event with millisecond granularity

Implementations

impl Event

pub fn opcode(&self) -> u16

Get the opcode number of this message

Trait Implementations

impl Debug for Event

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.