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 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) 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 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 cursor. The role assigned by this request is the same as assigned by wl_pointer.set_cursor meaning the same surface can be used both as a wl_pointer cursor and a wp_tablet cursor. If the surface already has another role, it raises a protocol error. The surface may be used on multiple tablets and across multiple seats. 

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 int32
}

TabletToolRotationEvent : z-rotation change event

Sent whenever the z-rotation axis on the tool changes. The rotation value is in 0.01 of a degree 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 int32
	TiltY int32
}

TabletToolTiltEvent : tilt change event

Sent whenever one or both of the tilt axes on a tool change. Each tilt value is in 0.01 of a degree, 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 int32
	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 0.01 of a degree 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.