.TH "wayland::server::zwp_tablet_pad_ring_v2_t" 3 "Wed May 1 2024 17:27:19" "Version 1.0.0" "Wayland++" \" -*- nroff -*- .ad l .nh .SH NAME wayland::server::zwp_tablet_pad_ring_v2_t \- pad ring .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits wayland::server::resource_t\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "std::function< void(std::string, uint32_t)> & \fBon_set_feedback\fP ()" .br .RI "set compositor feedback " .ti -1c .RI "std::function< void()> & \fBon_destroy\fP ()" .br .RI "destroy the ring object " .ti -1c .RI "void \fBsource\fP (zwp_tablet_pad_ring_v2_source const &source, bool post=true)" .br .RI "ring event source " .ti -1c .RI "void \fBangle\fP (double degrees, bool post=true)" .br .RI "angle changed " .ti -1c .RI "void \fBstop\fP (bool post=true)" .br .RI "interaction stopped " .ti -1c .RI "void \fBframe\fP (uint32_t time, bool post=true)" .br .RI "end of a ring event sequence " .ti -1c .RI "bool \fBproxy_has_object\fP () const" .br .RI "Check whether this wrapper actually wraps an object\&. " .ti -1c .RI "void \fBpost_no_memory\fP () const" .br .ti -1c .RI "uint32_t \fBget_id\fP () const" .br .ti -1c .RI "client_t \fBget_client\fP () const" .br .ti -1c .RI "unsigned int \fBget_version\fP () const" .br .ti -1c .RI "std::string \fBget_class\fP ()" .br .in -1c .SS "Static Public Attributes" .in +1c .ti -1c .RI "static constexpr std::uint32_t \fBsource_since_version\fP = 1" .br .RI "Minimum protocol version required for the \fBsource\fP function\&. " .ti -1c .RI "static constexpr std::uint32_t \fBangle_since_version\fP = 1" .br .RI "Minimum protocol version required for the \fBangle\fP function\&. " .ti -1c .RI "static constexpr std::uint32_t \fBstop_since_version\fP = 1" .br .RI "Minimum protocol version required for the \fBstop\fP function\&. " .ti -1c .RI "static constexpr std::uint32_t \fBframe_since_version\fP = 1" .br .RI "Minimum protocol version required for the \fBframe\fP function\&. " .in -1c .SH "Detailed Description" .PP pad ring A circular interaction area, such as the touch ring on the Wacom Intuos Pro series tablets\&. .PP Events on a ring are logically grouped by the wl_tablet_pad_ring\&.frame event\&. .PP Definition at line \fB5633\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&. .SH "Member Function Documentation" .PP .SS "void zwp_tablet_pad_ring_v2_t::angle (double degrees, bool post = \fCtrue\fP)" .PP angle changed .PP \fBParameters\fP .RS 4 \fIdegrees\fP the current angle in degrees .RE .PP Sent whenever the angle on a ring changes\&. .PP The angle is provided in degrees clockwise from the logical north of the ring in the pad's current rotation\&. .PP Definition at line \fB6716\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "void zwp_tablet_pad_ring_v2_t::frame (uint32_t time, bool post = \fCtrue\fP)" .PP end of a ring event sequence .PP \fBParameters\fP .RS 4 \fItime\fP timestamp with millisecond granularity .RE .PP 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\&. .PP 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\&. .PP 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\&. .PP Definition at line \fB6726\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "std::string wayland::server::resource_t::get_class ()\fC [inherited]\fP" Retrieve the interface name (class) of a resource object\&. .PP \fBReturns\fP .RS 4 Interface name of the resource object\&. .RE .PP .SS "client_t wayland::server::resource_t::get_client () const\fC [inherited]\fP" Get the associated client .PP \fBReturns\fP .RS 4 the client that owns the resource\&. .RE .PP .SS "uint32_t wayland::server::resource_t::get_id () const\fC [inherited]\fP" Get the internal ID of the resource .PP \fBReturns\fP .RS 4 the internal ID of the resource .RE .PP .SS "unsigned int wayland::server::resource_t::get_version () const\fC [inherited]\fP" Get interface version .PP \fBReturns\fP .RS 4 Interface version this resource has been constructed with\&. .RE .PP .SS "std::function< void()> & zwp_tablet_pad_ring_v2_t::on_destroy ()" .PP destroy the ring object This destroys the client's resource for this ring object\&. .PP Definition at line \fB6705\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "std::function< void(std::string, uint32_t)> & zwp_tablet_pad_ring_v2_t::on_set_feedback ()" .PP set compositor feedback .PP \fBParameters\fP .RS 4 \fIdescription\fP ring description .br \fIserial\fP serial of the mode switch event .RE .PP 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\&. .PP 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)\&. .PP 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\&. .PP 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\&. .PP Definition at line \fB6699\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "void wayland::server::resource_t::post_no_memory () const\fC [inherited]\fP" Post 'not enough memory' error to the client .PP 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\&. .SS "bool wayland::server::resource_t::proxy_has_object () const\fC [inherited]\fP" .PP Check whether this wrapper actually wraps an object\&. .PP \fBReturns\fP .RS 4 true if there is an underlying object, false if this wrapper is empty .RE .PP .SS "void zwp_tablet_pad_ring_v2_t::source (zwp_tablet_pad_ring_v2_source const & source, bool post = \fCtrue\fP)" .PP ring event source .PP \fBParameters\fP .RS 4 \fIsource\fP the event source .RE .PP Source information for ring events\&. .PP 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\&. .PP 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\&. .PP This event is optional\&. If the source is unknown for an interaction, no event is sent\&. .PP Definition at line \fB6711\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "void zwp_tablet_pad_ring_v2_t::stop (bool post = \fCtrue\fP)" .PP interaction stopped Stop notification for ring events\&. .PP 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\&. .PP Any wp_tablet_pad_ring\&.angle events with the same source after this event should be considered as the start of a new interaction\&. .PP Definition at line \fB6721\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SH "Member Data Documentation" .PP .SS "constexpr std::uint32_t wayland::server::zwp_tablet_pad_ring_v2_t::angle_since_version = 1\fC [static]\fP, \fC [constexpr]\fP" .PP Minimum protocol version required for the \fBangle\fP function\&. .PP Definition at line \fB5730\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&. .SS "constexpr std::uint32_t wayland::server::zwp_tablet_pad_ring_v2_t::frame_since_version = 1\fC [static]\fP, \fC [constexpr]\fP" .PP Minimum protocol version required for the \fBframe\fP function\&. .PP Definition at line \fB5774\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&. .SS "constexpr std::uint32_t wayland::server::zwp_tablet_pad_ring_v2_t::source_since_version = 1\fC [static]\fP, \fC [constexpr]\fP" .PP Minimum protocol version required for the \fBsource\fP function\&. .PP Definition at line \fB5715\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&. .SS "constexpr std::uint32_t wayland::server::zwp_tablet_pad_ring_v2_t::stop_since_version = 1\fC [static]\fP, \fC [constexpr]\fP" .PP Minimum protocol version required for the \fBstop\fP function\&. .PP Definition at line \fB5750\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&. .SH "Author" .PP Generated automatically by Doxygen for Wayland++ from the source code\&.