voidzwp_tablet_tool_v1_t::button(uint32_tserial,uint32_tbutton,zwp_tablet_tool_v1_button_stateconst&state,boolpost=true)
button event
Parametersserialbutton The button whose state has changed
state Whether the button was pressed or released
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.
Definition at line 6274 of file wayland-server-protocol-unstable.cpp.
voidzwp_tablet_tool_v1_t::capability(zwp_tablet_tool_v1_capabilityconst&capability,boolpost=true)
tool capability notification
Parameterscapability the capability
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.
Definition at line 6204 of file wayland-server-protocol-unstable.cpp.
voidzwp_tablet_tool_v1_t::distance(uint32_tdistance,boolpost=true)
distance change event
Parametersdistance The current distance value
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.
Definition at line 6249 of file wayland-server-protocol-unstable.cpp.
voidzwp_tablet_tool_v1_t::done(boolpost=true)
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.
Definition at line 6209 of file wayland-server-protocol-unstable.cpp.
voidzwp_tablet_tool_v1_t::down(uint32_tserial,boolpost=true)
tablet tool is making contact
Parametersserial
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.
Definition at line 6229 of file wayland-server-protocol-unstable.cpp.
voidzwp_tablet_tool_v1_t::frame(uint32_ttime,boolpost=true)
frame event
Parameterstime The time of the event with millisecond granularity
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.
Definition at line 6279 of file wayland-server-protocol-unstable.cpp.
std::stringwayland::server::resource_t::get_class()[inherited]
Retrieve the interface name (class) of a resource object.
Returns
Interface name of the resource object.
client_twayland::server::resource_t::get_client()const[inherited]
Get the associated client
Returns
the client that owns the resource.
uint32_twayland::server::resource_t::get_id()const[inherited]
Get the internal ID of the resource
Returns
the internal ID of the resource
unsignedintwayland::server::resource_t::get_version()const[inherited]
Get interface version
Returns
Interface version this resource has been constructed with.
voidzwp_tablet_tool_v1_t::hardware_id_wacom(uint32_thardware_id_hi,uint32_thardware_id_lo,boolpost=true)
hardware id notification in Wacom's format
Parametershardware_id_hi the hardware id, most significant bits
hardware_id_lo the hardware id, least significant bits
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.
Definition at line 6199 of file wayland-server-protocol-unstable.cpp.
voidzwp_tablet_tool_v1_t::hardware_serial(uint32_thardware_serial_hi,uint32_thardware_serial_lo,boolpost=true)
unique hardware serial number of the tool
Parametershardware_serial_hi the unique serial number of the tool, most significant bits
hardware_serial_lo the unique serial number of the tool, least significant bits
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.
Definition at line 6194 of file wayland-server-protocol-unstable.cpp.
voidzwp_tablet_tool_v1_t::motion(doublex,doubley,boolpost=true)
motion event
Parametersx surface-local x coordinate
y surface-local y coordinate
Sent whenever a tablet tool moves.
Definition at line 6239 of file wayland-server-protocol-unstable.cpp.
std::function<void()>&zwp_tablet_tool_v1_t::on_destroy()
destroy the tool object This destroys the client's resource for this tool object.
Definition at line 6183 of file wayland-server-protocol-unstable.cpp.
std::function<void(uint32_t,surface_t,int32_t,int32_t)>&zwp_tablet_tool_v1_t::on_set_cursor()
set the tablet tool's surface
Parametersserial serial of the enter event
surfacehotspot_x surface-local x coordinate
hotspot_y surface-local y coordinate
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.
Definition at line 6177 of file wayland-server-protocol-unstable.cpp.
voidwayland::server::resource_t::post_no_memory()const[inherited]
Post 'not enough memory' error to the client
If the compositor has not enough memory to fulfill a certail request of the client, this function can be
called to notify the client of this circumstance.
voidzwp_tablet_tool_v1_t::post_role(std::stringconst&msg)
Post error: given wl_surface has another role.
Definition at line 6284 of file wayland-server-protocol-unstable.cpp.
voidzwp_tablet_tool_v1_t::pressure(uint32_tpressure,boolpost=true)
pressure change event
Parameterspressure The current pressure value
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.
Definition at line 6244 of file wayland-server-protocol-unstable.cpp.
voidzwp_tablet_tool_v1_t::proximity_in(uint32_tserial,zwp_tablet_v1_tconst&tablet,surface_tconst&surface,boolpost=true)
proximity in event
Parametersserialtablet The tablet the tool is in proximity of
surface The current surface the tablet tool is over
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.
Definition at line 6219 of file wayland-server-protocol-unstable.cpp.
voidzwp_tablet_tool_v1_t::proximity_out(boolpost=true)
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.
Definition at line 6224 of file wayland-server-protocol-unstable.cpp.
boolwayland::server::resource_t::proxy_has_object()const[inherited]
Check whether this wrapper actually wraps an object.
Returns
true if there is an underlying object, false if this wrapper is empty
voidzwp_tablet_tool_v1_t::removed(boolpost=true)
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.
Definition at line 6214 of file wayland-server-protocol-unstable.cpp.
voidzwp_tablet_tool_v1_t::rotation(int32_tdegrees,boolpost=true)
z-rotation change event
Parametersdegrees The current rotation of the Z axis
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.
Definition at line 6259 of file wayland-server-protocol-unstable.cpp.
voidzwp_tablet_tool_v1_t::slider(int32_tposition,boolpost=true)
Slider position change event.
Parametersposition The current position of slider
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.
Definition at line 6264 of file wayland-server-protocol-unstable.cpp.
voidzwp_tablet_tool_v1_t::tilt(int32_ttilt_x,int32_ttilt_y,boolpost=true)
tilt change event
Parameterstilt_x The current value of the X tilt axis
tilt_y The current value of the Y tilt axis
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.
Definition at line 6254 of file wayland-server-protocol-unstable.cpp.
voidzwp_tablet_tool_v1_t::type(zwp_tablet_tool_v1_typeconst&tool_type,boolpost=true)
tool type
Parameterstool_type the physical 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.
Definition at line 6189 of file wayland-server-protocol-unstable.cpp.
voidzwp_tablet_tool_v1_t::up(boolpost=true)
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.
Definition at line 6234 of file wayland-server-protocol-unstable.cpp.
voidzwp_tablet_tool_v1_t::wheel(int32_tdegrees,int32_tclicks,boolpost=true)
Wheel delta event.
Parametersdegrees The wheel delta in 0.01 of a degree
clicks The wheel delta in discrete clicks
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.
Definition at line 6269 of file wayland-server-protocol-unstable.cpp.
Install Now
PNG Icons
