logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

wayland::zwp_tablet_pad_ring_v2_t - pad ring

Author

       Generated automatically by Doxygen for Wayland++ from the source code.

Version 1.0.0                                Wed May 1 2024 17:27:19        wayland::zwp_tablet_pad_ring_v2_t(3)

Detailed Description

       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.

       Definition at line 4933 of file wayland-client-protocol-unstable.hpp.

Member Data Documentation

constexprstd::uint32_twayland::zwp_tablet_pad_ring_v2_t::set_feedback_since_version=1[static],[constexpr]
       Minimum protocol version required for the set_feedback function.

       Definition at line 4988 of file wayland-client-protocol-unstable.hpp.

Member Enumeration Documentation

enumclasswayland::proxy_t::wrapper_type[strong],[inherited]
       Underlying wl_proxy type and properties of a proxy_t that affect construction, destruction, and event
       handling

       Enumeratorstandard
              C pointer is a standard type compatible with wl_proxy*. Events are dispatched and it is destructed
              when the proxy_t is destructed. User data is set.

       display
              C  pointer  is  a  wl_display*. No events are dispatched, wl_display_disconnect is called when the
              proxy_t is destructed. User data is set.

       foreign
              C pointer is a standard type compatible with wl_proxy*, but another library owns it and it  should
              not  be  touched  in  a  way  that  could affect the operation of the other library. No events are
              dispatched, wl_proxy_destroy is not called when the  proxy_t  is  destructed,  user  data  is  not
              touched.  Consequently,  there is no reference counting for the proxy_t. Lifetime of such wrappers
              should preferably be short to minimize the chance that the owning library decides to  destroy  the
              wl_proxy.

       proxy_wrapper
              C  pointer  is  a  wl_proxy*  that  was  constructed  with  wl_proxy_create_wrapper. No events are
              dispatched, wl_proxy_wrapper_destroy is called when the proxy_t is destroyed.  Reference  counting
              is  active.  A reference to the proxy_t creating this proxy wrapper is held to extend its lifetime
              until after the proxy wrapper is destroyed.

       Definition at line 116 of file wayland-client.hpp.

Member Function Documentation

wl_proxy*wayland::proxy_t::c_ptr()const[inherited]
       Get a pointer to the underlying C struct.

       Returns
           The underlying wl_proxy wrapped by this proxy_t if it exists, otherwise an exception is thrown

   std::stringwayland::proxy_t::get_class()const[inherited]
       Get the interface name (class) of a proxy object.

       Returns
           The interface name of the object associated with the proxy

   uint32_twayland::proxy_t::get_id()const[inherited]
       Get the id of a proxy object.

       Returns
           The id the object associated with the proxy

   uint32_twayland::proxy_t::get_version()const[inherited]
       Get the protocol object version of a proxy object. Gets the protocol object version of a proxy object, or
       0 if the proxy was created with unversioned API.

       A returned value of 0 means that no version information is  available,  so  the  caller  must  make  safe
       assumptions about the object's real version.

       display_t will always return version 0.

       Returns
           The protocol object version of the proxy or 0

   wrapper_typewayland::proxy_t::get_wrapper_type()const[inline],[inherited]
       Get the type of a proxy object.

       Definition at line 302 of file wayland-client.hpp.

   std::function<void(double)>&zwp_tablet_pad_ring_v2_t::on_angle()
       angle changed

       Parametersdegrees the current angle in degrees

       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.

       Definition at line 7712 of file wayland-client-protocol-unstable.cpp.

   std::function<void(uint32_t)>&zwp_tablet_pad_ring_v2_t::on_frame()
       end of a ring event sequence

       Parameterstime timestamp with millisecond granularity

       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.

       Definition at line 7722 of file wayland-client-protocol-unstable.cpp.

   std::function<void(zwp_tablet_pad_ring_v2_source)>&zwp_tablet_pad_ring_v2_t::on_source()
       ring event source

       Parameterssource the 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.

       Definition at line 7707 of file wayland-client-protocol-unstable.cpp.

   std::function<void()>&zwp_tablet_pad_ring_v2_t::on_stop()
       interaction stopped Stop notification for ring events.

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

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

       Definition at line 7717 of file wayland-client-protocol-unstable.cpp.

   wayland::proxy_t::operatorbool()const[inherited]
       Check whether this wrapper actually wraps an object.

       Returns
           true if there is an underlying object, false if this wrapper is empty

   boolwayland::proxy_t::operator!=(constproxy_t&right)const[inherited]
       Check whether two wrappers refer to different objects.

   boolwayland::proxy_t::operator==(constproxy_t&right)const[inherited]
       Check whether two wrappers refer to the same object.

   boolwayland::proxy_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

   voidwayland::proxy_t::proxy_release()[inherited]
       Release  the  wrapped object (if any), making this an empty wrapper. Note that display_t instances cannot
       be released this way. Attempts to do so are ignored.

       Examplesforeign_display.cpp.

   voidzwp_tablet_pad_ring_v2_t::set_feedback(std::stringconst&description,uint32_tserial)
       set compositor feedback

       Parametersdescription ring description
           serial serial of the mode switch event

       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.

       Definition at line 7701 of file wayland-client-protocol-unstable.cpp.

   voidwayland::proxy_t::set_queue(event_queue_tqueue)[inherited]
       Assign a proxy to an event queue.

       Parametersqueue The event queue that will handle this proxy

       Assign proxy to event queue. Events coming from proxy will be queued in queue instead  of  the  display's
       main queue.

       See also: display_t::dispatch_queue().

       Examplesproxy_wrapper.cpp.

Name

       wayland::zwp_tablet_pad_ring_v2_t - pad ring

Synopsis

       #include <wayland-client-protocol-unstable.hpp>

       Inherits wayland::proxy_t.

   PublicTypes
       enum class wrapper_type { standard, display, foreign, proxy_wrapper }

   PublicMemberFunctions
       void set_feedback (std::string const &description, uint32_t serial)
           set compositor feedback
       std::function< void(zwp_tablet_pad_ring_v2_source)> & on_source ()
           ring event source
       std::function< void(double)> & on_angle ()
           angle changed
       std::function< void()> & on_stop ()
           interaction stopped
       std::function< void(uint32_t)> & on_frame ()
           end of a ring event sequence
       uint32_t get_id () const
           Get the id of a proxy object.
       std::string get_class () const
           Get the interface name (class) of a proxy object.
       uint32_t get_version () const
           Get the protocol object version of a proxy object.
       wrapper_typeget_wrapper_type () const
           Get the type of a proxy object.
       void set_queue (event_queue_t queue)
           Assign a proxy to an event queue.
       wl_proxy * c_ptr () const
           Get a pointer to the underlying C struct.
       bool proxy_has_object () const
           Check whether this wrapper actually wraps an object.
       operatorbool () const
           Check whether this wrapper actually wraps an object.
       bool operator== (const proxy_t &right) const
           Check whether two wrappers refer to the same object.
       bool operator!= (const proxy_t &right) const
           Check whether two wrappers refer to different objects.
       void proxy_release ()
           Release the wrapped object (if any), making this an empty wrapper.

   StaticPublicAttributes
       static constexpr std::uint32_t set_feedback_since_version = 1
           Minimum protocol version required for the set_feedback function.

See Also