tablet

package
v0.0.0-...-0ad78d1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 30, 2023 License: BSD-2-Clause Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Tablet 

type Tablet struct {
	client.BaseProxy
	// contains filtered or unexported fields
}

Tablet : graphics tablet device

The wp_tablet interface represents one graphics tablet device. The tablet interface itself does not generate events; all events are generated by wp_tablet_tool objects when in proximity above a tablet.

A tablet has a number of static characteristics, e.g. device name and pid/vid. These capabilities are sent in an event sequence after the wp_tablet_seat.tablet_added event. This initial event sequence is terminated by a wp_tablet.done event.

func NewTablet 

func NewTablet(ctx *client.Context) *Tablet

NewTablet : graphics tablet device

The wp_tablet interface represents one graphics tablet device. The tablet interface itself does not generate events; all events are generated by wp_tablet_tool objects when in proximity above a tablet.

A tablet has a number of static characteristics, e.g. device name and pid/vid. These capabilities are sent in an event sequence after the wp_tablet_seat.tablet_added event. This initial event sequence is terminated by a wp_tablet.done event.

func (*Tablet) Destroy 

func (i *Tablet) Destroy() error

Destroy : destroy the tablet object

This destroys the client's resource for this tablet object.

func (*Tablet) Dispatch 

func (i *Tablet) Dispatch(opcode uint32, fd int, data []byte)

func (*Tablet) SetDoneHandler 

func (i *Tablet) SetDoneHandler(f TabletDoneHandlerFunc)

SetDoneHandler : sets handler for TabletDoneEvent

func (*Tablet) SetIdHandler 

func (i *Tablet) SetIdHandler(f TabletIdHandlerFunc)

SetIdHandler : sets handler for TabletIdEvent

func (*Tablet) SetNameHandler 

func (i *Tablet) SetNameHandler(f TabletNameHandlerFunc)

SetNameHandler : sets handler for TabletNameEvent

func (*Tablet) SetPathHandler 

func (i *Tablet) SetPathHandler(f TabletPathHandlerFunc)

SetPathHandler : sets handler for TabletPathEvent

func (*Tablet) SetRemovedHandler 

func (i *Tablet) SetRemovedHandler(f TabletRemovedHandlerFunc)

SetRemovedHandler : sets handler for TabletRemovedEvent

type TabletDoneEvent 

type TabletDoneEvent struct{}

TabletDoneEvent : tablet description events sequence complete

This event is sent immediately to signal the end of the initial burst of descriptive events. A client may consider the static description of the tablet to be complete and finalize initialization of the tablet.

type TabletDoneHandlerFunc 

type TabletDoneHandlerFunc func(TabletDoneEvent)

type TabletIdEvent 

type TabletIdEvent struct {
	Vid uint32
	Pid uint32
}

TabletIdEvent : tablet device USB vendor/product id

This event is sent in the initial burst of events before the wp_tablet.done event.

type TabletIdHandlerFunc 

type TabletIdHandlerFunc func(TabletIdEvent)

type TabletManager 

type TabletManager struct {
	client.BaseProxy
}

TabletManager : controller object for graphic tablet devices

An object that provides access to the graphics tablets available on this system. All tablets are associated with a seat, to get access to the actual tablets, use wp_tablet_manager.get_tablet_seat.

func NewTabletManager 

func NewTabletManager(ctx *client.Context) *TabletManager

NewTabletManager : controller object for graphic tablet devices

An object that provides access to the graphics tablets available on this system. All tablets are associated with a seat, to get access to the actual tablets, use wp_tablet_manager.get_tablet_seat.

func (*TabletManager) Destroy 

func (i *TabletManager) Destroy() error

Destroy : release the memory for the tablet manager object

Destroy the wp_tablet_manager object. Objects created from this object are unaffected and should be destroyed separately.

func (*TabletManager) GetTabletSeat 

func (i *TabletManager) GetTabletSeat(seat *client.Seat) (*TabletSeat, error)

GetTabletSeat : get the tablet seat

Get the wp_tablet_seat object for the given seat. This object provides access to all graphics tablets in this seat. 

seat: The wl_seat object to retrieve the tablets for

type TabletNameEvent 

type TabletNameEvent struct {
	Name string
}

TabletNameEvent : tablet device name

This event is sent in the initial burst of events before the wp_tablet.done event.

type TabletNameHandlerFunc 

type TabletNameHandlerFunc func(TabletNameEvent)

type TabletPad 

type TabletPad struct {
	client.BaseProxy
	// contains filtered or unexported fields
}

TabletPad : a set of buttons, rings and strips

A pad device is a set of buttons, rings and strips usually physically present on the tablet device itself. Some exceptions exist where the pad device is physically detached, e.g. the Wacom ExpressKey Remote.

Pad devices have no axes that control the cursor and are generally auxiliary devices to the tool devices used on the tablet surface.

A pad device has a number of static characteristics, e.g. the number of rings. These capabilities are sent in an event sequence after the wp_tablet_seat.pad_added event before any actual events from this pad. This initial event sequence is terminated by a wp_tablet_pad.done event.

All pad features (buttons, rings and strips) are logically divided into groups and all pads have at least one group. The available groups are notified through the wp_tablet_pad.group event; the compositor will emit one event per group before emitting wp_tablet_pad.done.

Groups may have multiple modes. Modes allow clients to map multiple actions to a single pad feature. Only one mode can be active per group, although different groups may have different active modes.

func NewTabletPad 

func NewTabletPad(ctx *client.Context) *TabletPad

NewTabletPad : a set of buttons, rings and strips

A pad device is a set of buttons, rings and strips usually physically present on the tablet device itself. Some exceptions exist where the pad device is physically detached, e.g. the Wacom ExpressKey Remote.

Pad devices have no axes that control the cursor and are generally auxiliary devices to the tool devices used on the tablet surface.

A pad device has a number of static characteristics, e.g. the number of rings. These capabilities are sent in an event sequence after the wp_tablet_seat.pad_added event before any actual events from this pad. This initial event sequence is terminated by a wp_tablet_pad.done event.

All pad features (buttons, rings and strips) are logically divided into groups and all pads have at least one group. The available groups are notified through the wp_tablet_pad.group event; the compositor will emit one event per group before emitting wp_tablet_pad.done.

Groups may have multiple modes. Modes allow clients to map multiple actions to a single pad feature. Only one mode can be active per group, although different groups may have different active modes.

func (*TabletPad) Destroy 

func (i *TabletPad) Destroy() error

Destroy : destroy the pad object

Destroy the wp_tablet_pad object. Objects created from this object are unaffected and should be destroyed separately.

func (*TabletPad) Dispatch 

func (i *TabletPad) Dispatch(opcode uint32, fd int, data []byte)

func (*TabletPad) SetButtonHandler 

func (i *TabletPad) SetButtonHandler(f TabletPadButtonHandlerFunc)

SetButtonHandler : sets handler for TabletPadButtonEvent

func (*TabletPad) SetButtonsHandler 

func (i *TabletPad) SetButtonsHandler(f TabletPadButtonsHandlerFunc)

SetButtonsHandler : sets handler for TabletPadButtonsEvent

func (*TabletPad) SetDoneHandler 

func (i *TabletPad) SetDoneHandler(f TabletPadDoneHandlerFunc)

SetDoneHandler : sets handler for TabletPadDoneEvent

func (*TabletPad) SetEnterHandler 

func (i *TabletPad) SetEnterHandler(f TabletPadEnterHandlerFunc)

SetEnterHandler : sets handler for TabletPadEnterEvent

func (*TabletPad) SetFeedback 

func (i *TabletPad) SetFeedback(button uint32, description string, serial uint32) error

SetFeedback : set compositor feedback

Requests the compositor to use the provided feedback string associated with this button. This request should be issued immediately after a wp_tablet_pad_group.mode_switch event from the corresponding group is received, or whenever a button is mapped to a different action. See wp_tablet_pad_group.mode_switch for more details.

Clients are encouraged to provide context-aware descriptions for the actions associated with each button, and compositors may use this information to offer visual feedback on the button layout (e.g. on-screen displays).

Button indices start at 0. Setting the feedback string on a button that is reserved by the compositor (i.e. not belonging to any wp_tablet_pad_group) does not generate an error but the compositor is free to ignore the request.

The provided string 'description' is a UTF-8 encoded string to be associated with this ring, and is considered user-visible; general internationalization rules apply.

The serial argument will be that of the last wp_tablet_pad_group.mode_switch event received for the group of this button. Requests providing other serials than the most recent one will be ignored. 

button: button index
description: button description
serial: serial of the mode switch event

func (*TabletPad) SetGroupHandler 

func (i *TabletPad) SetGroupHandler(f TabletPadGroupHandlerFunc)

SetGroupHandler : sets handler for TabletPadGroupEvent

func (*TabletPad) SetLeaveHandler 

func (i *TabletPad) SetLeaveHandler(f TabletPadLeaveHandlerFunc)

SetLeaveHandler : sets handler for TabletPadLeaveEvent

func (*TabletPad) SetPathHandler 

func (i *TabletPad) SetPathHandler(f TabletPadPathHandlerFunc)

SetPathHandler : sets handler for TabletPadPathEvent

func (*TabletPad) SetRemovedHandler 

func (i *TabletPad) SetRemovedHandler(f TabletPadRemovedHandlerFunc)

SetRemovedHandler : sets handler for TabletPadRemovedEvent

type TabletPadButtonEvent 

type TabletPadButtonEvent struct {
	Time   uint32
	Button uint32
	State  uint32
}

TabletPadButtonEvent : physical button state

Sent whenever the physical state of a button changes.

type TabletPadButtonHandlerFunc 

type TabletPadButtonHandlerFunc func(TabletPadButtonEvent)

type TabletPadButtonState 

type TabletPadButtonState uint32
const (
	// TabletPadButtonStateReleased : the button is not pressed
	TabletPadButtonStateReleased TabletPadButtonState = 0
	// TabletPadButtonStatePressed : the button is pressed
	TabletPadButtonStatePressed TabletPadButtonState = 1
)

TabletPadButtonState : physical button state

Describes the physical state of a button that caused the button event.

func (TabletPadButtonState) Name 

func (e TabletPadButtonState) Name() string

func (TabletPadButtonState) String 

func (e TabletPadButtonState) String() string

func (TabletPadButtonState) Value 

func (e TabletPadButtonState) Value() string

type TabletPadButtonsEvent 

type TabletPadButtonsEvent struct {
	Buttons uint32
}

TabletPadButtonsEvent : buttons announced

Sent on wp_tablet_pad initialization to announce the available buttons.

This event is sent in the initial burst of events before the wp_tablet_pad.done event. This event is only sent when at least one button is available.

type TabletPadButtonsHandlerFunc 

type TabletPadButtonsHandlerFunc func(TabletPadButtonsEvent)

type TabletPadDoneEvent 

type TabletPadDoneEvent struct{}

TabletPadDoneEvent : pad description event sequence complete

This event signals the end of the initial burst of descriptive events. A client may consider the static description of the pad to be complete and finalize initialization of the pad.

type TabletPadDoneHandlerFunc 

type TabletPadDoneHandlerFunc func(TabletPadDoneEvent)

type TabletPadEnterEvent 

type TabletPadEnterEvent struct {
	Serial  uint32
	Tablet  *Tablet
	Surface *client.Surface
}

TabletPadEnterEvent : enter event

Notification that this pad is focused on the specified surface.

type TabletPadEnterHandlerFunc 

type TabletPadEnterHandlerFunc func(TabletPadEnterEvent)

type TabletPadGroup 

type TabletPadGroup struct {
	client.BaseProxy
	// contains filtered or unexported fields
}

TabletPadGroup : a set of buttons, rings and strips

A pad group describes a distinct (sub)set of buttons, rings and strips present in the tablet. The criteria of this grouping is usually positional, eg. if a tablet has buttons on the left and right side, 2 groups will be presented. The physical arrangement of groups is undisclosed and may change on the fly.

Pad groups will announce their features during pad initialization. Between the corresponding wp_tablet_pad.group event and wp_tablet_pad_group.done, the pad group will announce the buttons, rings and strips contained in it, plus the number of supported modes.

Modes are a mechanism to allow multiple groups of actions for every element in the pad group. The number of groups and available modes in each is persistent across device plugs. The current mode is user-switchable, it will be announced through the wp_tablet_pad_group.mode_switch event both whenever it is switched, and after wp_tablet_pad.enter.

The current mode logically applies to all elements in the pad group, although it is at clients' discretion whether to actually perform different actions, and/or issue the respective .set_feedback requests to notify the compositor. See the wp_tablet_pad_group.mode_switch event for more details.

func NewTabletPadGroup 

func NewTabletPadGroup(ctx *client.Context) *TabletPadGroup

NewTabletPadGroup : a set of buttons, rings and strips

A pad group describes a distinct (sub)set of buttons, rings and strips present in the tablet. The criteria of this grouping is usually positional, eg. if a tablet has buttons on the left and right side, 2 groups will be presented. The physical arrangement of groups is undisclosed and may change on the fly.

Pad groups will announce their features during pad initialization. Between the corresponding wp_tablet_pad.group event and wp_tablet_pad_group.done, the pad group will announce the buttons, rings and strips contained in it, plus the number of supported modes.

Modes are a mechanism to allow multiple groups of actions for every element in the pad group. The number of groups and available modes in each is persistent across device plugs. The current mode is user-switchable, it will be announced through the wp_tablet_pad_group.mode_switch event both whenever it is switched, and after wp_tablet_pad.enter.

The current mode logically applies to all elements in the pad group, although it is at clients' discretion whether to actually perform different actions, and/or issue the respective .set_feedback requests to notify the compositor. See the wp_tablet_pad_group.mode_switch event for more details.

func (*TabletPadGroup) Destroy 

func (i *TabletPadGroup) Destroy() error

Destroy : destroy the pad object

Destroy the wp_tablet_pad_group object. Objects created from this object are unaffected and should be destroyed separately.

func (*TabletPadGroup) Dispatch 

func (i *TabletPadGroup) Dispatch(opcode uint32, fd int, data []byte)

func (*TabletPadGroup) SetButtonsHandler 

func (i *TabletPadGroup) SetButtonsHandler(f TabletPadGroupButtonsHandlerFunc)

SetButtonsHandler : sets handler for TabletPadGroupButtonsEvent

func (*TabletPadGroup) SetDoneHandler 

func (i *TabletPadGroup) SetDoneHandler(f TabletPadGroupDoneHandlerFunc)

SetDoneHandler : sets handler for TabletPadGroupDoneEvent

func (*TabletPadGroup) SetModeSwitchHandler 

func (i *TabletPadGroup) SetModeSwitchHandler(f TabletPadGroupModeSwitchHandlerFunc)

SetModeSwitchHandler : sets handler for TabletPadGroupModeSwitchEvent

func (*TabletPadGroup) SetModesHandler 

func (i *TabletPadGroup) SetModesHandler(f TabletPadGroupModesHandlerFunc)

SetModesHandler : sets handler for TabletPadGroupModesEvent

func (*TabletPadGroup) SetRingHandler 

func (i *TabletPadGroup) SetRingHandler(f TabletPadGroupRingHandlerFunc)

SetRingHandler : sets handler for TabletPadGroupRingEvent

func (*TabletPadGroup) SetStripHandler 

func (i *TabletPadGroup) SetStripHandler(f TabletPadGroupStripHandlerFunc)

SetStripHandler : sets handler for TabletPadGroupStripEvent

type TabletPadGroupButtonsEvent 

type TabletPadGroupButtonsEvent struct {
	Buttons []byte
}

TabletPadGroupButtonsEvent : buttons announced

Sent on wp_tablet_pad_group initialization to announce the available buttons in the group. Button indices start at 0, a button may only be in one group at a time.

This event is first sent in the initial burst of events before the wp_tablet_pad_group.done event.

Some buttons are reserved by the compositor. These buttons may not be assigned to any wp_tablet_pad_group. Compositors may broadcast this event in the case of changes to the mapping of these reserved buttons. If the compositor happens to reserve all buttons in a group, this event will be sent with an empty array.

type TabletPadGroupButtonsHandlerFunc 

type TabletPadGroupButtonsHandlerFunc func(TabletPadGroupButtonsEvent)

type TabletPadGroupDoneEvent 

type TabletPadGroupDoneEvent struct{}

TabletPadGroupDoneEvent : tablet group description events sequence complete

This event is sent immediately to signal the end of the initial burst of descriptive events. A client may consider the static description of the tablet to be complete and finalize initialization of the tablet group.

type TabletPadGroupDoneHandlerFunc 

type TabletPadGroupDoneHandlerFunc func(TabletPadGroupDoneEvent)

type TabletPadGroupEvent 

type TabletPadGroupEvent struct {
	PadGroup *TabletPadGroup
}

TabletPadGroupEvent : group announced

Sent on wp_tablet_pad initialization to announce available groups. One event is sent for each pad group available.

This event is sent in the initial burst of events before the wp_tablet_pad.done event. At least one group will be announced.

type TabletPadGroupHandlerFunc 

type TabletPadGroupHandlerFunc func(TabletPadGroupEvent)

type TabletPadGroupModeSwitchEvent 

type TabletPadGroupModeSwitchEvent struct {
	Time   uint32
	Serial uint32
	Mode   uint32
}

TabletPadGroupModeSwitchEvent : mode switch event

Notification that the mode was switched.

A mode applies to all buttons, rings and strips in a group simultaneously, but a client is not required to assign different actions for each mode. For example, a client may have mode-specific button mappings but map the ring to vertical scrolling in all modes. Mode indices start at 0.

Switching modes is compositor-dependent. The compositor may provide visual cues to the client about the mode, e.g. by toggling LEDs on the tablet device. Mode-switching may be software-controlled or controlled by one or more physical buttons. For example, on a Wacom Intuos Pro, the button inside the ring may be assigned to switch between modes.

The compositor will also send this event after wp_tablet_pad.enter on each group in order to notify of the current mode. Groups that only feature one mode will use mode=0 when emitting this event.

If a button action in the new mode differs from the action in the previous mode, the client should immediately issue a wp_tablet_pad.set_feedback request for each changed button.

If a ring or strip action in the new mode differs from the action in the previous mode, the client should immediately issue a wp_tablet_ring.set_feedback or wp_tablet_strip.set_feedback request for each changed ring or strip.

type TabletPadGroupModeSwitchHandlerFunc 

type TabletPadGroupModeSwitchHandlerFunc func(TabletPadGroupModeSwitchEvent)

type TabletPadGroupModesEvent 

type TabletPadGroupModesEvent struct {
	Modes uint32
}

TabletPadGroupModesEvent : mode-switch ability announced

Sent on wp_tablet_pad_group initialization to announce that the pad group may switch between modes. A client may use a mode to store a specific configuration for buttons, rings and strips and use the wl_tablet_pad_group.mode_switch event to toggle between these configurations. Mode indices start at 0.

Switching modes is compositor-dependent. See the wp_tablet_pad_group.mode_switch event for more details.

This event is sent in the initial burst of events before the wp_tablet_pad_group.done event. This event is only sent when more than more than one mode is available.

type TabletPadGroupModesHandlerFunc 

type TabletPadGroupModesHandlerFunc func(TabletPadGroupModesEvent)

type TabletPadGroupRingEvent 

type TabletPadGroupRingEvent struct {
	Ring *TabletPadRing
}

TabletPadGroupRingEvent : ring announced

Sent on wp_tablet_pad_group initialization to announce available rings. One event is sent for each ring available on this pad group.

This event is sent in the initial burst of events before the wp_tablet_pad_group.done event.

type TabletPadGroupRingHandlerFunc 

type TabletPadGroupRingHandlerFunc func(TabletPadGroupRingEvent)

type TabletPadGroupStripEvent 

type TabletPadGroupStripEvent struct {
	Strip *TabletPadStrip
}

TabletPadGroupStripEvent : strip announced

Sent on wp_tablet_pad initialization to announce available strips. One event is sent for each strip available on this pad group.

This event is sent in the initial burst of events before the wp_tablet_pad_group.done event.

type TabletPadGroupStripHandlerFunc 

type TabletPadGroupStripHandlerFunc func(TabletPadGroupStripEvent)

type TabletPadLeaveEvent 

type TabletPadLeaveEvent struct {
	Serial  uint32
	Surface *client.Surface
}

TabletPadLeaveEvent : leave event

Notification that this pad is no longer focused on the specified surface.

type TabletPadLeaveHandlerFunc 

type TabletPadLeaveHandlerFunc func(TabletPadLeaveEvent)

type TabletPadPathEvent 

type TabletPadPathEvent struct {
	Path string
}

TabletPadPathEvent : path to the device

A system-specific device path that indicates which device is behind this wp_tablet_pad. This information may be used to gather additional information about the device, e.g. through libwacom.

The format of the path is unspecified, it may be a device node, a sysfs path, or some other identifier. It is up to the client to identify the string provided.

This event is sent in the initial burst of events before the wp_tablet_pad.done event.

type TabletPadPathHandlerFunc 

type TabletPadPathHandlerFunc func(TabletPadPathEvent)

type TabletPadRemovedEvent 

type TabletPadRemovedEvent struct{}

TabletPadRemovedEvent : pad removed event

Sent when the pad has been removed from the system. When a tablet is removed its pad(s) will be removed too.

When this event is received, the client must destroy all rings, strips and groups that were offered by this pad, and issue wp_tablet_pad.destroy the pad itself.

type TabletPadRemovedHandlerFunc 

type TabletPadRemovedHandlerFunc func(TabletPadRemovedEvent)

type TabletPadRing 

type TabletPadRing struct {
	client.BaseProxy
	// contains filtered or unexported fields
}

TabletPadRing : 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.

func NewTabletPadRing 

func NewTabletPadRing(ctx *client.Context) *TabletPadRing

NewTabletPadRing : 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.

func (*TabletPadRing) Destroy 

func (i *TabletPadRing) Destroy() error

Destroy : destroy the ring object

This destroys the client's resource for this ring object.

func (*TabletPadRing) Dispatch 

func (i *TabletPadRing) Dispatch(opcode uint32, fd int, data []byte)

func (*TabletPadRing) SetAngleHandler 

func (i *TabletPadRing) SetAngleHandler(f TabletPadRingAngleHandlerFunc)

SetAngleHandler : sets handler for TabletPadRingAngleEvent

func (*TabletPadRing) SetFeedback 

func (i *TabletPadRing) SetFeedback(description string, serial uint32) error

SetFeedback : set compositor feedback

Request that the compositor use the provided feedback string associated with this ring. This request should be issued immediately after a wp_tablet_pad_group.mode_switch event from the corresponding group is received, or whenever the ring is mapped to a different action. See wp_tablet_pad_group.mode_switch for more details.

Clients are encouraged to provide context-aware descriptions for the actions associated with the ring; compositors may use this information to offer visual feedback about the button layout (eg. on-screen displays).

The provided string 'description' is a UTF-8 encoded string to be associated with this ring, and is considered user-visible; general internationalization rules apply.

The serial argument will be that of the last wp_tablet_pad_group.mode_switch event received for the group of this ring. Requests providing other serials than the most recent one will be ignored. 

description: ring description
serial: serial of the mode switch event

func (*TabletPadRing) SetFrameHandler 

func (i *TabletPadRing) SetFrameHandler(f TabletPadRingFrameHandlerFunc)

SetFrameHandler : sets handler for TabletPadRingFrameEvent

func (*TabletPadRing) SetSourceHandler 

func (i *TabletPadRing) SetSourceHandler(f TabletPadRingSourceHandlerFunc)

SetSourceHandler : sets handler for TabletPadRingSourceEvent

func (*TabletPadRing) SetStopHandler 

func (i *TabletPadRing) SetStopHandler(f TabletPadRingStopHandlerFunc)

SetStopHandler : sets handler for TabletPadRingStopEvent

type TabletPadRingAngleEvent 

type TabletPadRingAngleEvent struct {
	Degrees float64
}

TabletPadRingAngleEvent : 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.

type TabletPadRingAngleHandlerFunc 

type TabletPadRingAngleHandlerFunc func(TabletPadRingAngleEvent)

type TabletPadRingFrameEvent 

type TabletPadRingFrameEvent struct {
	Time uint32
}

TabletPadRingFrameEvent : 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.

type TabletPadRingFrameHandlerFunc 

type TabletPadRingFrameHandlerFunc func(TabletPadRingFrameEvent)

type TabletPadRingSource 

type TabletPadRingSource uint32
const (
	// TabletPadRingSourceFinger : finger
	TabletPadRingSourceFinger TabletPadRingSource = 1
)

TabletPadRingSource : ring axis source

Describes the source types for ring events. This indicates to the client how a ring event was physically generated; a client may adjust the user interface accordingly. For example, events from a "finger" source may trigger kinetic scrolling.

func (TabletPadRingSource) Name 

func (e TabletPadRingSource) Name() string

func (TabletPadRingSource) String 

func (e TabletPadRingSource) String() string

func (TabletPadRingSource) Value 

func (e TabletPadRingSource) Value() string

type TabletPadRingSourceEvent 

type TabletPadRingSourceEvent struct {
	Source uint32
}

TabletPadRingSourceEvent : 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.

type TabletPadRingSourceHandlerFunc 

type TabletPadRingSourceHandlerFunc func(TabletPadRingSourceEvent)

type TabletPadRingStopEvent 

type TabletPadRingStopEvent struct{}

TabletPadRingStopEvent : 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.

type TabletPadRingStopHandlerFunc 

type TabletPadRingStopHandlerFunc func(TabletPadRingStopEvent)

type TabletPadStrip 

type TabletPadStrip struct {
	client.BaseProxy
	// contains filtered or unexported fields
}

TabletPadStrip : pad strip

A linear interaction area, such as the strips found in Wacom Cintiq models.

Events on a strip are logically grouped by the wl_tablet_pad_strip.frame event.

func NewTabletPadStrip 

func NewTabletPadStrip(ctx *client.Context) *TabletPadStrip

NewTabletPadStrip : pad strip

A linear interaction area, such as the strips found in Wacom Cintiq models.

Events on a strip are logically grouped by the wl_tablet_pad_strip.frame event.

func (*TabletPadStrip) Destroy 

func (i *TabletPadStrip) Destroy() error

Destroy : destroy the strip object

This destroys the client's resource for this strip object.

func (*TabletPadStrip) Dispatch 

func (i *TabletPadStrip) Dispatch(opcode uint32, fd int, data []byte)

func (*TabletPadStrip) SetFeedback 

func (i *TabletPadStrip) SetFeedback(description string, serial uint32) error

SetFeedback : set compositor feedback

Requests the compositor to use the provided feedback string associated with this strip. This request should be issued immediately after a wp_tablet_pad_group.mode_switch event from the corresponding group is received, or whenever the strip is mapped to a different action. See wp_tablet_pad_group.mode_switch for more details.

Clients are encouraged to provide context-aware descriptions for the actions associated with the strip, and compositors may use this information to offer visual feedback about the button layout (eg. on-screen displays).

The provided string 'description' is a UTF-8 encoded string to be associated with this ring, and is considered user-visible; general internationalization rules apply.

The serial argument will be that of the last wp_tablet_pad_group.mode_switch event received for the group of this strip. Requests providing other serials than the most recent one will be ignored. 

description: strip description
serial: serial of the mode switch event

func (*TabletPadStrip) SetFrameHandler 

func (i *TabletPadStrip) SetFrameHandler(f TabletPadStripFrameHandlerFunc)

SetFrameHandler : sets handler for TabletPadStripFrameEvent

func (*TabletPadStrip) SetPositionHandler 

func (i *TabletPadStrip) SetPositionHandler(f TabletPadStripPositionHandlerFunc)

SetPositionHandler : sets handler for TabletPadStripPositionEvent

func (*TabletPadStrip) SetSourceHandler 

func (i *TabletPadStrip) SetSourceHandler(f TabletPadStripSourceHandlerFunc)

SetSourceHandler : sets handler for TabletPadStripSourceEvent

func (*TabletPadStrip) SetStopHandler 

func (i *TabletPadStrip) SetStopHandler(f TabletPadStripStopHandlerFunc)

SetStopHandler : sets handler for TabletPadStripStopEvent

type TabletPadStripFrameEvent 

type TabletPadStripFrameEvent struct {
	Time uint32
}

TabletPadStripFrameEvent : end of a strip event sequence

Indicates the end of a set of events that represent one logical hardware strip event. A client is expected to accumulate the data in all events within the frame before proceeding.

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

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

type TabletPadStripFrameHandlerFunc 

type TabletPadStripFrameHandlerFunc func(TabletPadStripFrameEvent)

type TabletPadStripPositionEvent 

type TabletPadStripPositionEvent struct {
	Position uint32
}

TabletPadStripPositionEvent : position changed

Sent whenever the position on a strip changes.

The position is normalized to a range of [0, 65535], the 0-value represents the top-most and/or left-most position of the strip in the pad's current rotation.

type TabletPadStripPositionHandlerFunc 

type TabletPadStripPositionHandlerFunc func(TabletPadStripPositionEvent)

type TabletPadStripSource 

type TabletPadStripSource uint32
const (
	// TabletPadStripSourceFinger : finger
	TabletPadStripSourceFinger TabletPadStripSource = 1
)

TabletPadStripSource : strip axis source

Describes the source types for strip events. This indicates to the client how a strip event was physically generated; a client may adjust the user interface accordingly. For example, events from a "finger" source may trigger kinetic scrolling.

func (TabletPadStripSource) Name 

func (e TabletPadStripSource) Name() string

func (TabletPadStripSource) String 

func (e TabletPadStripSource) String() string

func (TabletPadStripSource) Value 

func (e TabletPadStripSource) Value() string

type TabletPadStripSourceEvent 

type TabletPadStripSourceEvent struct {
	Source uint32
}

TabletPadStripSourceEvent : strip event source

Source information for strip events.

This event does not occur on its own. It is sent before a wp_tablet_pad_strip.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_strip.source.finger, a wp_tablet_pad_strip.stop event will be sent when the user lifts their finger off the device.

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

type TabletPadStripSourceHandlerFunc 

type TabletPadStripSourceHandlerFunc func(TabletPadStripSourceEvent)

type TabletPadStripStopEvent 

type TabletPadStripStopEvent struct{}

TabletPadStripStopEvent : interaction stopped

Stop notification for strip events.

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

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

type TabletPadStripStopHandlerFunc 

type TabletPadStripStopHandlerFunc func(TabletPadStripStopEvent)

type TabletPathEvent 

type TabletPathEvent struct {
	Path string
}

TabletPathEvent : path to the device

A system-specific device path that indicates which device is behind this wp_tablet. This information may be used to gather additional information about the device, e.g. through libwacom.

A device may have more than one device path. If so, multiple wp_tablet.path events are sent. A device may be emulated and not have a device path, and in that case this event will not be sent.

The format of the path is unspecified, it may be a device node, a sysfs path, or some other identifier. It is up to the client to identify the string provided.

This event is sent in the initial burst of events before the wp_tablet.done event.

type TabletPathHandlerFunc 

type TabletPathHandlerFunc func(TabletPathEvent)

type TabletRemovedEvent 

type TabletRemovedEvent struct{}

TabletRemovedEvent : tablet removed event

Sent when the tablet has been removed from the system. When a tablet is removed, some tools may be removed.

When this event is received, the client must wp_tablet.destroy the object.

type TabletRemovedHandlerFunc 

type TabletRemovedHandlerFunc func(TabletRemovedEvent)

type TabletSeat 

type TabletSeat struct {
	client.BaseProxy
	// contains filtered or unexported fields
}

TabletSeat : controller object for graphic tablet devices of a seat

An object that provides access to the graphics tablets available on this seat. After binding to this interface, the compositor sends a set of wp_tablet_seat.tablet_added and wp_tablet_seat.tool_added events.

func NewTabletSeat 

func NewTabletSeat(ctx *client.Context) *TabletSeat

NewTabletSeat : controller object for graphic tablet devices of a seat

An object that provides access to the graphics tablets available on this seat. After binding to this interface, the compositor sends a set of wp_tablet_seat.tablet_added and wp_tablet_seat.tool_added events.

func (*TabletSeat) Destroy 

func (i *TabletSeat) Destroy() error

Destroy : release the memory for the tablet seat object

Destroy the wp_tablet_seat object. Objects created from this object are unaffected and should be destroyed separately.

func (*TabletSeat) Dispatch 

func (i *TabletSeat) Dispatch(opcode uint32, fd int, data []byte)

func (*TabletSeat) SetPadAddedHandler 

func (i *TabletSeat) SetPadAddedHandler(f TabletSeatPadAddedHandlerFunc)

SetPadAddedHandler : sets handler for TabletSeatPadAddedEvent

func (*TabletSeat) SetTabletAddedHandler 

func (i *TabletSeat) SetTabletAddedHandler(f TabletSeatTabletAddedHandlerFunc)

SetTabletAddedHandler : sets handler for TabletSeatTabletAddedEvent

func (*TabletSeat) SetToolAddedHandler 

func (i *TabletSeat) SetToolAddedHandler(f TabletSeatToolAddedHandlerFunc)

SetToolAddedHandler : sets handler for TabletSeatToolAddedEvent

type TabletSeatPadAddedEvent 

type TabletSeatPadAddedEvent struct {
	Id *TabletPad
}

TabletSeatPadAddedEvent : new pad notification

This event is sent whenever a new pad is known to the system. Typically, pads are physically attached to tablets and a pad_added event is sent immediately after the wp_tablet_seat.tablet_added. However, some standalone pad devices logically attach to tablets at runtime, and the client must wait for wp_tablet_pad.enter to know the tablet a pad is attached to.

This event only provides the object id of the pad. All further features (buttons, strips, rings) are sent through the wp_tablet_pad interface.

type TabletSeatPadAddedHandlerFunc 

type TabletSeatPadAddedHandlerFunc func(TabletSeatPadAddedEvent)

type TabletSeatTabletAddedEvent 

type TabletSeatTabletAddedEvent struct {
	Id *Tablet
}

TabletSeatTabletAddedEvent : new device notification

This event is sent whenever a new tablet becomes available on this seat. This event only provides the object id of the tablet, any static information about the tablet (device name, vid/pid, etc.) is sent through the wp_tablet interface.

type TabletSeatTabletAddedHandlerFunc 

type TabletSeatTabletAddedHandlerFunc func(TabletSeatTabletAddedEvent)

type TabletSeatToolAddedEvent 

type TabletSeatToolAddedEvent struct {
	Id *TabletTool
}

TabletSeatToolAddedEvent : a new tool has been used with a tablet

This event is sent whenever a tool that has not previously been used with a tablet comes into use. This event only provides the object id of the tool; any static information about the tool (capabilities, type, etc.) is sent through the wp_tablet_tool interface.

type TabletSeatToolAddedHandlerFunc 

type TabletSeatToolAddedHandlerFunc func(TabletSeatToolAddedEvent)

type TabletTool 

type TabletTool struct {
	client.BaseProxy
	// contains filtered or unexported fields
}

TabletTool : a physical tablet tool

An object that represents a physical tool that has been, or is currently in use with a tablet in this seat. Each wp_tablet_tool object stays valid until the client destroys it; the compositor reuses the wp_tablet_tool object to indicate that the object's respective physical tool has come into proximity of a tablet again.

A wp_tablet_tool object's 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.

A tablet tool has a number of static characteristics, e.g. tool type, hardware_serial and capabilities. These capabilities are sent in an event sequence after the wp_tablet_seat.tool_added event before any actual events from this tool. This initial event sequence is terminated by a wp_tablet_tool.done event.

Tablet tool events are grouped by wp_tablet_tool.frame events. Any events received before a wp_tablet_tool.frame event should be considered part of the same hardware state change.

func NewTabletTool 

func NewTabletTool(ctx *client.Context) *TabletTool

NewTabletTool : a physical tablet tool

An object that represents a physical tool that has been, or is currently in use with a tablet in this seat. Each wp_tablet_tool object stays valid until the client destroys it; the compositor reuses the wp_tablet_tool object to indicate that the object's respective physical tool has come into proximity of a tablet again.

A wp_tablet_tool object's 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.

A tablet tool has a number of static characteristics, e.g. tool type, hardware_serial and capabilities. These capabilities are sent in an event sequence after the wp_tablet_seat.tool_added event before any actual events from this tool. This initial event sequence is terminated by a wp_tablet_tool.done event.

Tablet tool events are grouped by wp_tablet_tool.frame events. Any events received before a wp_tablet_tool.frame event should be considered part of the same hardware state change.

func (*TabletTool) Destroy 

func (i *TabletTool) Destroy() error

Destroy : destroy the tool object

This destroys the client's resource for this tool object.

func (*TabletTool) Dispatch 

func (i *TabletTool) Dispatch(opcode uint32, fd int, data []byte)

func (*TabletTool) SetButtonHandler 

func (i *TabletTool) SetButtonHandler(f TabletToolButtonHandlerFunc)

SetButtonHandler : sets handler for TabletToolButtonEvent

func (*TabletTool) SetCapabilityHandler 

func (i *TabletTool) SetCapabilityHandler(f TabletToolCapabilityHandlerFunc)

SetCapabilityHandler : sets handler for TabletToolCapabilityEvent

func (*TabletTool) SetCursor 

func (i *TabletTool) SetCursor(serial uint32, surface *client.Surface, hotspotX, hotspotY int32) error

SetCursor : set the tablet tool's surface

Sets the surface of the cursor used for this tool on the given tablet. This request only takes effect if the tool is in proximity of one of the requesting client's surfaces or the surface parameter is the current pointer surface. If there was a previous surface set with this request it is replaced. If surface is NULL, the cursor image is hidden.

The parameters hotspot_x and hotspot_y define the position of the pointer surface relative to the pointer location. Its top-left corner is always at (x, y) - (hotspot_x, hotspot_y), where (x, y) are the coordinates of the pointer location, in surface-local coordinates.

On surface.attach requests to the pointer surface, hotspot_x and hotspot_y are decremented by the x and y parameters passed to the request. Attach must be confirmed by wl_surface.commit as usual.

The hotspot can also be updated by passing the currently set pointer surface to this request with new values for hotspot_x and hotspot_y.

The current and pending input regions of the wl_surface are cleared, and wl_surface.set_input_region is ignored until the wl_surface is no longer used as the cursor. When the use as a cursor ends, the current and pending input regions become undefined, and the wl_surface is unmapped.

This request gives the surface the role of a wp_tablet_tool cursor. A surface may only ever be used as the cursor surface for one wp_tablet_tool. If the surface already has another role or has previously been used as cursor surface for a different tool, a protocol error is raised. 

serial: serial of the enter event
hotspotX: surface-local x coordinate
hotspotY: surface-local y coordinate

func (*TabletTool) SetDistanceHandler 

func (i *TabletTool) SetDistanceHandler(f TabletToolDistanceHandlerFunc)

SetDistanceHandler : sets handler for TabletToolDistanceEvent

func (*TabletTool) SetDoneHandler 

func (i *TabletTool) SetDoneHandler(f TabletToolDoneHandlerFunc)

SetDoneHandler : sets handler for TabletToolDoneEvent

func (*TabletTool) SetDownHandler 

func (i *TabletTool) SetDownHandler(f TabletToolDownHandlerFunc)

SetDownHandler : sets handler for TabletToolDownEvent

func (*TabletTool) SetFrameHandler 

func (i *TabletTool) SetFrameHandler(f TabletToolFrameHandlerFunc)

SetFrameHandler : sets handler for TabletToolFrameEvent

func (*TabletTool) SetHardwareIdWacomHandler 

func (i *TabletTool) SetHardwareIdWacomHandler(f TabletToolHardwareIdWacomHandlerFunc)

SetHardwareIdWacomHandler : sets handler for TabletToolHardwareIdWacomEvent

func (*TabletTool) SetHardwareSerialHandler 

func (i *TabletTool) SetHardwareSerialHandler(f TabletToolHardwareSerialHandlerFunc)

SetHardwareSerialHandler : sets handler for TabletToolHardwareSerialEvent

func (*TabletTool) SetMotionHandler 

func (i *TabletTool) SetMotionHandler(f TabletToolMotionHandlerFunc)

SetMotionHandler : sets handler for TabletToolMotionEvent

func (*TabletTool) SetPressureHandler 

func (i *TabletTool) SetPressureHandler(f TabletToolPressureHandlerFunc)

SetPressureHandler : sets handler for TabletToolPressureEvent

func (*TabletTool) SetProximityInHandler 

func (i *TabletTool) SetProximityInHandler(f TabletToolProximityInHandlerFunc)

SetProximityInHandler : sets handler for TabletToolProximityInEvent

func (*TabletTool) SetProximityOutHandler 

func (i *TabletTool) SetProximityOutHandler(f TabletToolProximityOutHandlerFunc)

SetProximityOutHandler : sets handler for TabletToolProximityOutEvent

func (*TabletTool) SetRemovedHandler 

func (i *TabletTool) SetRemovedHandler(f TabletToolRemovedHandlerFunc)

SetRemovedHandler : sets handler for TabletToolRemovedEvent

func (*TabletTool) SetRotationHandler 

func (i *TabletTool) SetRotationHandler(f TabletToolRotationHandlerFunc)

SetRotationHandler : sets handler for TabletToolRotationEvent

func (*TabletTool) SetSliderHandler 

func (i *TabletTool) SetSliderHandler(f TabletToolSliderHandlerFunc)

SetSliderHandler : sets handler for TabletToolSliderEvent

func (*TabletTool) SetTiltHandler 

func (i *TabletTool) SetTiltHandler(f TabletToolTiltHandlerFunc)

SetTiltHandler : sets handler for TabletToolTiltEvent

func (*TabletTool) SetTypeHandler 

func (i *TabletTool) SetTypeHandler(f TabletToolTypeHandlerFunc)

SetTypeHandler : sets handler for TabletToolTypeEvent

func (*TabletTool) SetUpHandler 

func (i *TabletTool) SetUpHandler(f TabletToolUpHandlerFunc)

SetUpHandler : sets handler for TabletToolUpEvent

func (*TabletTool) SetWheelHandler 

func (i *TabletTool) SetWheelHandler(f TabletToolWheelHandlerFunc)

SetWheelHandler : sets handler for TabletToolWheelEvent

type TabletToolButtonEvent 

type TabletToolButtonEvent struct {
	Serial uint32
	Button uint32
	State  uint32
}

TabletToolButtonEvent : 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.

type TabletToolButtonHandlerFunc 

type TabletToolButtonHandlerFunc func(TabletToolButtonEvent)

type TabletToolButtonState 

type TabletToolButtonState uint32
const (
	// TabletToolButtonStateReleased : button is not pressed
	TabletToolButtonStateReleased TabletToolButtonState = 0
	// TabletToolButtonStatePressed : button is pressed
	TabletToolButtonStatePressed TabletToolButtonState = 1
)

TabletToolButtonState : physical button state

Describes the physical state of a button that produced the button event.

func (TabletToolButtonState) Name 

func (e TabletToolButtonState) Name() string

func (TabletToolButtonState) String 

func (e TabletToolButtonState) String() string

func (TabletToolButtonState) Value 

func (e TabletToolButtonState) Value() string

type TabletToolCapability 

type TabletToolCapability uint32
const (
	// TabletToolCapabilityTilt : Tilt axes
	TabletToolCapabilityTilt TabletToolCapability = 1
	// TabletToolCapabilityPressure : Pressure axis
	TabletToolCapabilityPressure TabletToolCapability = 2
	// TabletToolCapabilityDistance : Distance axis
	TabletToolCapabilityDistance TabletToolCapability = 3
	// TabletToolCapabilityRotation : Z-rotation axis
	TabletToolCapabilityRotation TabletToolCapability = 4
	// TabletToolCapabilitySlider : Slider axis
	TabletToolCapabilitySlider TabletToolCapability = 5
	// TabletToolCapabilityWheel : Wheel axis
	TabletToolCapabilityWheel TabletToolCapability = 6
)

TabletToolCapability : capability flags for a tool

Describes extra capabilities on a tablet.

Any tool must provide x and y values, extra axes are device-specific.

func (TabletToolCapability) Name 

func (e TabletToolCapability) Name() string

func (TabletToolCapability) String 

func (e TabletToolCapability) String() string

func (TabletToolCapability) Value 

func (e TabletToolCapability) Value() string

type TabletToolCapabilityEvent 

type TabletToolCapabilityEvent struct {
	Capability uint32
}

TabletToolCapabilityEvent : 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.

type TabletToolCapabilityHandlerFunc 

type TabletToolCapabilityHandlerFunc func(TabletToolCapabilityEvent)

type TabletToolDistanceEvent 

type TabletToolDistanceEvent struct {
	Distance uint32
}

TabletToolDistanceEvent : 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.

type TabletToolDistanceHandlerFunc 

type TabletToolDistanceHandlerFunc func(TabletToolDistanceEvent)

type TabletToolDoneEvent 

type TabletToolDoneEvent struct{}

TabletToolDoneEvent : 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.

type TabletToolDoneHandlerFunc 

type TabletToolDoneHandlerFunc func(TabletToolDoneEvent)

type TabletToolDownEvent 

type TabletToolDownEvent struct {
	Serial uint32
}

TabletToolDownEvent : 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.

type TabletToolDownHandlerFunc 

type TabletToolDownHandlerFunc func(TabletToolDownEvent)

type TabletToolError 

type TabletToolError uint32
const (
	// TabletToolErrorRole : given wl_surface has another role
	TabletToolErrorRole TabletToolError = 0
)

TabletToolError :

func (TabletToolError) Name 

func (e TabletToolError) Name() string

func (TabletToolError) String 

func (e TabletToolError) String() string

func (TabletToolError) Value 

func (e TabletToolError) Value() string

type TabletToolFrameEvent 

type TabletToolFrameEvent struct {
	Time uint32
}

TabletToolFrameEvent : 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.

type TabletToolFrameHandlerFunc 

type TabletToolFrameHandlerFunc func(TabletToolFrameEvent)

type TabletToolHardwareIdWacomEvent 

type TabletToolHardwareIdWacomEvent struct {
	HardwareIdHi uint32
	HardwareIdLo uint32
}

TabletToolHardwareIdWacomEvent : 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.

type TabletToolHardwareIdWacomHandlerFunc 

type TabletToolHardwareIdWacomHandlerFunc func(TabletToolHardwareIdWacomEvent)

type TabletToolHardwareSerialEvent 

type TabletToolHardwareSerialEvent struct {
	HardwareSerialHi uint32
	HardwareSerialLo uint32
}

TabletToolHardwareSerialEvent : 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.

type TabletToolHardwareSerialHandlerFunc 

type TabletToolHardwareSerialHandlerFunc func(TabletToolHardwareSerialEvent)

type TabletToolMotionEvent 

type TabletToolMotionEvent struct {
	X float64
	Y float64
}

TabletToolMotionEvent : motion event

Sent whenever a tablet tool moves.

type TabletToolMotionHandlerFunc 

type TabletToolMotionHandlerFunc func(TabletToolMotionEvent)

type TabletToolPressureEvent 

type TabletToolPressureEvent struct {
	Pressure uint32
}

TabletToolPressureEvent : 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.

type TabletToolPressureHandlerFunc 

type TabletToolPressureHandlerFunc func(TabletToolPressureEvent)

type TabletToolProximityInEvent 

type TabletToolProximityInEvent struct {
	Serial  uint32
	Tablet  *Tablet
	Surface *client.Surface
}

TabletToolProximityInEvent : 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.

type TabletToolProximityInHandlerFunc 

type TabletToolProximityInHandlerFunc func(TabletToolProximityInEvent)

type TabletToolProximityOutEvent 

type TabletToolProximityOutEvent struct{}

TabletToolProximityOutEvent : 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.

type TabletToolProximityOutHandlerFunc 

type TabletToolProximityOutHandlerFunc func(TabletToolProximityOutEvent)

type TabletToolRemovedEvent 

type TabletToolRemovedEvent struct{}

TabletToolRemovedEvent : 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.

type TabletToolRemovedHandlerFunc 

type TabletToolRemovedHandlerFunc func(TabletToolRemovedEvent)

type TabletToolRotationEvent 

type TabletToolRotationEvent struct {
	Degrees float64
}

TabletToolRotationEvent : 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.

type TabletToolRotationHandlerFunc 

type TabletToolRotationHandlerFunc func(TabletToolRotationEvent)

type TabletToolSliderEvent 

type TabletToolSliderEvent struct {
	Position int32
}

TabletToolSliderEvent : 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.

type TabletToolSliderHandlerFunc 

type TabletToolSliderHandlerFunc func(TabletToolSliderEvent)

type TabletToolTiltEvent 

type TabletToolTiltEvent struct {
	TiltX float64
	TiltY float64
}

TabletToolTiltEvent : 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.

type TabletToolTiltHandlerFunc 

type TabletToolTiltHandlerFunc func(TabletToolTiltEvent)

type TabletToolType 

type TabletToolType uint32
const (
	// TabletToolTypePen : Pen
	TabletToolTypePen TabletToolType = 0x140
	// TabletToolTypeEraser : Eraser
	TabletToolTypeEraser TabletToolType = 0x141
	// TabletToolTypeBrush : Brush
	TabletToolTypeBrush TabletToolType = 0x142
	// TabletToolTypePencil : Pencil
	TabletToolTypePencil TabletToolType = 0x143
	// TabletToolTypeAirbrush : Airbrush
	TabletToolTypeAirbrush TabletToolType = 0x144
	// TabletToolTypeFinger : Finger
	TabletToolTypeFinger TabletToolType = 0x145
	// TabletToolTypeMouse : Mouse
	TabletToolTypeMouse TabletToolType = 0x146
	// TabletToolTypeLens : Lens
	TabletToolTypeLens TabletToolType = 0x147
)

TabletToolType : a physical tool type

Describes the physical type of a tool. The physical type of a tool generally defines its base usage.

The mouse tool represents a mouse-shaped tool that is not a relative device but bound to the tablet's surface, providing absolute coordinates.

The lens tool is a mouse-shaped tool with an attached lens to provide precision focus.

func (TabletToolType) Name 

func (e TabletToolType) Name() string

func (TabletToolType) String 

func (e TabletToolType) String() string

func (TabletToolType) Value 

func (e TabletToolType) Value() string

type TabletToolTypeEvent 

type TabletToolTypeEvent struct {
	ToolType uint32
}

TabletToolTypeEvent : 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.

type TabletToolTypeHandlerFunc 

type TabletToolTypeHandlerFunc func(TabletToolTypeEvent)

type TabletToolUpEvent 

type TabletToolUpEvent struct{}

TabletToolUpEvent : 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.

type TabletToolUpHandlerFunc 

type TabletToolUpHandlerFunc func(TabletToolUpEvent)

type TabletToolWheelEvent 

type TabletToolWheelEvent struct {
	Degrees float64
	Clicks  int32
}

TabletToolWheelEvent : 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.

type TabletToolWheelHandlerFunc 

type TabletToolWheelHandlerFunc func(TabletToolWheelEvent)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.