Struct ZwpTabletPadRingV2

pub struct ZwpTabletPadRingV2 { /* private fields */ }

Available on crate feature wayland and Linux only.

pad ring

A circular interaction area, such as the touch ring on the Wacom Intuos Pro series tablets.

Events on a ring are logically grouped by the zwp_tablet_pad_ring_v2.frame event.

See also the Request enum for this interface.

Implementations

impl ZwpTabletPadRingV2

pub fn source(&self, source: Source)

ring event source

Source information for ring events.

This event does not occur on its own. It is sent before a zwp_tablet_pad_ring_v2.frame event and carries the source information for all events within that frame.

The source specifies how this event was generated. If the source is zwp_tablet_pad_ring_v2.source.finger, a zwp_tablet_pad_ring_v2.stop event will be sent when the user lifts the finger off the device.

This event is optional. If the source is unknown for an interaction, no event is sent.

pub fn angle(&self, degrees: f64)

angle changed

Sent whenever the angle on a ring changes.

The angle is provided in degrees clockwise from the logical north of the ring in the pad’s current rotation.

pub fn stop(&self)

interaction stopped

Stop notification for ring events.

For some zwp_tablet_pad_ring_v2.source types, a zwp_tablet_pad_ring_v2.stop event is sent to notify a client that the interaction with the ring has terminated. This enables the client to implement kinetic scrolling. See the zwp_tablet_pad_ring_v2.source documentation for information on when this event may be generated.

Any zwp_tablet_pad_ring_v2.angle events with the same source after this event should be considered as the start of a new interaction.

pub fn frame(&self, time: u32)

end of a ring event sequence

Indicates the end of a set of ring events that logically belong together. A client is expected to accumulate the data in all events within the frame before proceeding.

All zwp_tablet_pad_ring_v2 events before a zwp_tablet_pad_ring_v2.frame event belong logically together. For example, on termination of a finger interaction on a ring the compositor will send a zwp_tablet_pad_ring_v2.source event, a zwp_tablet_pad_ring_v2.stop event and a zwp_tablet_pad_ring_v2.frame event.

A zwp_tablet_pad_ring_v2.frame event is sent for every logical event group, even if the group only contains a single zwp_tablet_pad_ring_v2 event. Specifically, a client may get a sequence: angle, frame, angle, frame, etc.

Trait Implementations

impl Borrow<ObjectId> for ZwpTabletPadRingV2

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ZwpTabletPadRingV2

fn clone(&self) -> ZwpTabletPadRingV2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZwpTabletPadRingV2

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

Formats the value using the given formatter.

impl Hash for ZwpTabletPadRingV2

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

where H: Hasher,

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<Weak<ZwpTabletPadRingV2>> for ZwpTabletPadRingV2

fn eq(&self, other: &Weak<ZwpTabletPadRingV2>) -> 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 PartialEq for ZwpTabletPadRingV2

fn eq(&self, other: &ZwpTabletPadRingV2) -> 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 Resource for ZwpTabletPadRingV2

type Request = Request

The request enum for this interface

type Event<'event> = Event<'event>

The event enum for this interface

fn interface() -> &'static Interface

The interface description

fn id(&self) -> ObjectId

The ID of this object

fn version(&self) -> u32

The version of this object

fn data<U>(&self) -> Option<&U>

where U: 'static,

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn Any + Sync + Send>>

Access the raw data associated with this object.

fn handle(&self) -> &WeakHandle

Access the backend handle associated with this object

fn from_id( conn: &DisplayHandle, id: ObjectId, ) -> Result<ZwpTabletPadRingV2, InvalidId>

Create an object resource from its ID

fn send_event( &self, evt: <ZwpTabletPadRingV2 as Resource>::Event<'_>, ) -> Result<(), InvalidId>

Send an event to this object

fn parse_request( conn: &DisplayHandle, msg: Message<ObjectId, OwnedFd>, ) -> Result<(ZwpTabletPadRingV2, <ZwpTabletPadRingV2 as Resource>::Request), DispatchError>

Parse a event for this object

fn write_event<'a>( &self, conn: &DisplayHandle, msg: <ZwpTabletPadRingV2 as Resource>::Event<'a>, ) -> Result<Message<ObjectId, BorrowedFd<'a>>, InvalidId>

Serialize an event for this object

fn client(&self) -> Option<Client>

The client owning this object

fn is_alive(&self) -> bool

Checks if the Wayland object associated with this proxy is still alive

fn post_error(&self, code: impl Into<u32>, error: impl Into<String>)

Trigger a protocol error on this object

fn downgrade(&self) -> Weak<Self>

Creates a weak handle to this object

impl Eq for ZwpTabletPadRingV2