Struct smithay::wayland::tablet_manager::TabletToolHandle

pub struct TabletToolHandle { /* fields omitted */ }

Handle to a tablet tool device

TabletTool represents a physical tool that has been, or is currently in use with a tablet in seat.

A TabletTool 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.

Implementations

impl TabletToolHandle

pub fn proximity_in(
    &self,
    pos: Point<f64, Logical>,
    focus: (WlSurface, Point<i32, Logical>),
    tablet: &TabletHandle,
    serial: Serial,
    time: u32
)

Notify that this tool is focused on a certain surface.

You provide the location of the tool, in the form of:

• The coordinates of the tool in the global compositor space
• The surface on top of which the tool is, and the coordinates of its origin in the global compositor space.

pub fn proximity_out(&self, time: u32)

Notify that this tool has left proximity.

pub fn tip_down(&self, serial: Serial, time: u32)

Tablet tool is making contact

pub fn tip_up(&self, time: u32)

Tablet tool is no longer making contact

pub fn motion(
    &self,
    pos: Point<f64, Logical>,
    focus: Option<(WlSurface, Point<i32, Logical>)>,
    tablet: &TabletHandle,
    serial: Serial,
    time: u32
)

Notify that the tool moved

You provide the new location of the tool, in the form of:

• The coordinates of the tool in the global compositor space
• The surface on top of which the tool is, and the coordinates of its origin in the global compositor space (or None of the pointer is not on top of a client surface).

This will internally take care of notifying the appropriate client objects of proximity_in/proximity_out events.

pub fn pressure(&self, pressure: f64)

Queue tool pressure update

It will be sent alongside next motion event

pub fn distance(&self, distance: f64)

Queue tool distance update

It will be sent alongside next motion event

pub fn tilt(&self, tilt: (f64, f64))

Queue tool tilt update

It will be sent alongside next motion event

pub fn rotation(&self, rotation: f64)

Queue tool rotation update

It will be sent alongside next motion event

pub fn slider_position(&self, slider: f64)

Queue tool slider update

It will be sent alongside next motion event

pub fn wheel(&self, degrees: f64, clicks: i32)

Queue tool wheel update

It will be sent alongside next motion event

pub fn button(&self, button: u32, state: ButtonState, serial: Serial, time: u32)

Button on the tool was pressed or released

Trait Implementations

impl Clone for TabletToolHandle

fn clone(&self) -> TabletToolHandle

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TabletToolHandle

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

Formats the value using the given formatter.

impl Default for TabletToolHandle

fn default() -> TabletToolHandle

Returns the “default value” for a type.