Package org.freedesktop.wayland.server

Class ZwpTabletPadRingV2Resource

java.lang.Object

org.freedesktop.wayland.server.Resource<ZwpTabletPadRingV2Requests>

org.freedesktop.wayland.server.ZwpTabletPadRingV2Resource

All Implemented Interfaces:

WaylandObject

public class ZwpTabletPadRingV2Resource
extends Resource<ZwpTabletPadRingV2Requests>

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 wl_tablet_pad_ring.frame event.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INTERFACE_NAME

Fields inherited from class org.freedesktop.wayland.server.Resource

wlResourcePtr

Constructor Summary

Constructors

Constructor	Description
ZwpTabletPadRingV2Resource(MemorySegment pointer)
ZwpTabletPadRingV2Resource(Client client, int version, int id, ZwpTabletPadRingV2Requests implementation)

Method Summary

Modifier and Type	Method	Description
void	angle(Fixed degrees)	angle changed
void	frame(int time)	end of a ring event sequence
void	source(int source)	ring event source
void	stop()	interaction stopped

Methods inherited from class org.freedesktop.wayland.server.Resource

addDestroyListener, destroy, equals, getClient, getId, getImplementation, getPointer, getVersion, hashCode, postError, postEvent, postEvent, register, unregister

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

INTERFACE_NAME

public static final String INTERFACE_NAME

See Also:

• Constant Field Values

Constructor Details

ZwpTabletPadRingV2Resource

public ZwpTabletPadRingV2Resource(Client client,
 int version,
 int id,
 ZwpTabletPadRingV2Requests implementation)

ZwpTabletPadRingV2Resource

public ZwpTabletPadRingV2Resource(MemorySegment pointer)

Method Details

source

public void source(int source)

ring event source

Source information for ring events.

This event does not occur on its own. It is sent before a wp_tablet_pad_ring.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 wp_tablet_pad_ring.source.finger, a wp_tablet_pad_ring.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.

Parameters:

source - the event source

angle

public void angle(@Nonnull
 Fixed degrees)

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.

Parameters:

degrees - the current angle in degrees

stop

public void stop()

interaction stopped

Stop notification for ring events.

For some wp_tablet_pad_ring.source types, a wp_tablet_pad_ring.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 wp_tablet_pad_ring.source documentation for information on when this event may be generated.

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

frame

public void frame(int time)

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 wp_tablet_pad_ring events before a wp_tablet_pad_ring.frame event belong logically together. For example, on termination of a finger interaction on a ring the compositor will send a wp_tablet_pad_ring.source event, a wp_tablet_pad_ring.stop event and a wp_tablet_pad_ring.frame event.

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

Parameters:

time - timestamp with millisecond granularity