wayland::server::zwp_pointer_gesture_pinch_v1_t - a pinch gesture object

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

Version 1.0.0                                Wed May 1 2024 17wayland::server::zwp_pointer_gesture_pinch_v1_t(3)

       a pinch gesture object

       A pinch gesture object notifies a client about a multi-finger pinch gesture detected on an indirect input
       device such as a touchpad. The gesture is usually initiated by multiple fingers moving towards each other
       or away from each other, or by two or more fingers rotating around a logical center of gravity. The
       precise conditions of when such a gesture is detected are implementation-dependent.

       A gesture consists of three stages: begin, update (optional) and end. There cannot be multiple
       simultaneous hold, pinch or swipe gestures on a same pointer/seat, how compositors prevent these
       situations is implementation-dependent.

       A gesture may be cancelled by the compositor or the hardware. Clients should not consider performing
       permanent or irreversible actions until the end of a gesture has been received.

       Definition at line 3312 of file wayland-server-protocol-unstable.hpp.

constexprstd::uint32_twayland::server::zwp_pointer_gesture_pinch_v1_t::begin_since_version=1[static],[constexpr]
       Minimum protocol version required for the begin function.

       Definition at line 3357 of file wayland-server-protocol-unstable.hpp.

   constexprstd::uint32_twayland::server::zwp_pointer_gesture_pinch_v1_t::end_since_version=1[static],[constexpr]
       Minimum protocol version required for the end function.

       Definition at line 3404 of file wayland-server-protocol-unstable.hpp.

   constexprstd::uint32_twayland::server::zwp_pointer_gesture_pinch_v1_t::update_since_version=1[static],[constexpr]
       Minimum protocol version required for the update function.

       Definition at line 3384 of file wayland-server-protocol-unstable.hpp.

voidzwp_pointer_gesture_pinch_v1_t::begin(uint32_tserial,uint32_ttime,surface_tconst&surface,uint32_tfingers,boolpost=true)
       multi-finger pinch begin

       Parametersserialtime timestamp with millisecond granularity
           surfacefingers number of fingers

       This event is sent when a multi-finger pinch gesture is detected on the device.

       Definition at line 5675 of file wayland-server-protocol-unstable.cpp.

   voidzwp_pointer_gesture_pinch_v1_t::end(uint32_tserial,uint32_ttime,int32_tcancelled,boolpost=true)
       multi-finger pinch end

       Parametersserialtime timestamp with millisecond granularity
           cancelled 1 if the gesture was cancelled, 0 otherwise

       This event is sent when a multi-finger pinch gesture ceases to be valid. This may happen when one or more
       fingers are lifted or the gesture is cancelled.

       When a gesture is cancelled, the client should undo state changes caused by this gesture. What causes a
       gesture to be cancelled is implementation-dependent.

       Definition at line 5685 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.

   std::function<void()>&zwp_pointer_gesture_pinch_v1_t::on_destroy()
       destroy the pinch gesture object

       Definition at line 5669 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.

   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_pointer_gesture_pinch_v1_t::update(uint32_ttime,doubledx,doubledy,doublescale,doublerotation,boolpost=true)
       multi-finger pinch motion

       Parameterstime timestamp with millisecond granularity
           dx delta x coordinate in surface coordinate space
           dy delta y coordinate in surface coordinate space
           scale scale relative to the initial finger position
           rotation angle in degrees cw relative to the previous event

       This event is sent when a multi-finger pinch gesture changes the position of the logical center, the
       rotation or the relative scale.

       The dx and dy coordinates are relative coordinates in the surface coordinate space of the logical center
       of the gesture.

       The scale factor is an absolute scale compared to the pointer_gesture_pinch.begin event, e.g. a scale of
       2 means the fingers are now twice as far apart as on pointer_gesture_pinch.begin.

       The rotation is the relative angle in degrees clockwise compared to the previous
       pointer_gesture_pinch.begin or pointer_gesture_pinch.update event.

       Definition at line 5680 of file wayland-server-protocol-unstable.cpp.

       wayland::server::zwp_pointer_gesture_pinch_v1_t - a pinch gesture object

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

       Inherits wayland::server::resource_t.

   PublicMemberFunctions
       std::function< void()> & on_destroy ()
           destroy the pinch gesture object
       void begin (uint32_t serial, uint32_t time, surface_t const &surface, uint32_t fingers, bool post=true)
           multi-finger pinch begin
       void update (uint32_t time, double dx, double dy, double scale, double rotation, bool post=true)
           multi-finger pinch motion
       void end (uint32_t serial, uint32_t time, int32_t cancelled, bool post=true)
           multi-finger pinch end
       bool proxy_has_object () const
           Check whether this wrapper actually wraps an object.
       void post_no_memory () const
       uint32_t get_id () const
       client_t get_client () const
       unsigned int get_version () const
       std::string get_class ()

   StaticPublicAttributes
       static constexpr std::uint32_t begin_since_version = 1
           Minimum protocol version required for the begin function.
       static constexpr std::uint32_t update_since_version = 1
           Minimum protocol version required for the update function.
       static constexpr std::uint32_t end_since_version = 1
           Minimum protocol version required for the end function.