Struct TabletTool

pub struct TabletTool { /* private fields */ }

An object representing a tool being used by a device with the DeviceCapability::TabletTool capability.

Tablet events generated by such a device are bound to a specific tool rather than coming from the device directly. Depending on the hardware it is possible to track the same physical tool across multiple Devices, see Tracking unique tools.

Implementations

impl TabletTool

pub fn serial(&self) -> u64

Return the serial number of a tool.

If the tool does not report a serial number, this function returns zero. See Tracking unique tools for details.

pub fn tool_id(&self) -> u64

Return the tool ID for a tool object.

If nonzero, this number identifies the specific type of the tool with more precision than the type returned in tool_type, see Vendor-specific tablet tool types. Not all tablets support a tool ID.

Tablets known to support tool IDs include the Wacom Intuos 3, 4, 5, Wacom Cintiq and Wacom Intuos Pro series.

pub fn tool_type(&self) -> Option<TabletToolType>

Return the tool type for a tool object, see Vendor-specific tablet tool types for details.

A return value of None means the tool type is not known.

pub fn has_button(&self, button: u32) -> bool

Check if a tablet tool has a button with the passed-in code (see linux/input.h).

pub fn has_distance(&self) -> bool

Return whether the tablet tool supports distance.

pub fn has_pressure(&self) -> bool

Return whether the tablet tool supports pressure.

pub fn has_rotation(&self) -> bool

Return whether the tablet tool supports z-rotation.v

pub fn has_slider(&self) -> bool

Return whether the tablet tool has a slider axis.

pub fn has_tilt(&self) -> bool

Return whether the tablet tool supports tilt.

pub fn has_wheel(&self) -> bool

Return whether the tablet tool has a relative wheel.

pub fn is_unique(&self) -> bool

Returns true if the physical tool can be uniquely identified by libinput, or false otherwise.

If a tool can be uniquely identified, keeping a reference to the tool allows tracking the tool across proximity out sequences and across compatible tablets. See Tracking unique tools for more details.

pub fn tablet_tool_has_size(&self) -> bool

Returns whether the tablet tool has a ellipsis major and minor.

Where the underlying hardware only supports one of either major or minor, libinput emulated the other axis as a cicular contact, i.e. major == minor for all values of major.

Trait Implementations

impl AsRaw<libinput_tablet_tool> for TabletTool

fn as_raw(&self) -> *const libinput_tablet_tool

Receive a raw pointer representing this type.

impl Clone for TabletTool

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Context for TabletTool

fn context(&self) -> &Libinput

Returns the underlying libinput context

impl Debug for TabletTool

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

Formats the value using the given formatter.

impl Drop for TabletTool

fn drop(&mut self)

Executes the destructor for this type.

impl FromRaw<libinput_tablet_tool> for TabletTool

unsafe fn from_raw(ffi: *mut libinput_tablet_tool, context: &Libinput) -> Self

Create a new instance of this type from a raw pointer and it’s context. If the type of the struct is a valid libinput type, but is unknown to this library, it panics instead.

impl Hash for TabletTool

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TabletTool

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TabletTool