wayland::zwp_locked_pointer_v1_t - receive relative pointer motion events

Author

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

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

Detailed Description

       receive relative pointer motion events

       The wp_locked_pointer interface represents a locked pointer state.

       While the lock of this object is active, the wl_pointer objects of the associated seat will not emit any
       wl_pointer.motion events.

       This object will send the event 'locked' when the lock is activated. Whenever the lock is activated, it
       is guaranteed that the locked surface will already have received pointer focus and that the pointer will
       be within the region passed to the request creating this object.

       To unlock the pointer, send the destroy request. This will also destroy the wp_locked_pointer object.

       If the compositor decides to unlock the pointer the unlocked event is sent. See wp_locked_pointer.unlock
       for details.

       When unlocking, the compositor may warp the cursor position to the set cursor position hint. If it does,
       it will not result in any relative motion events emitted via wp_relative_pointer.

       If the surface the lock was requested on is destroyed and the lock is not yet activated, the
       wp_locked_pointer object is now defunct and must be destroyed.

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

Member Data Documentation

constexprstd::uint32_twayland::zwp_locked_pointer_v1_t::set_cursor_position_hint_since_version=1[static],[constexpr]
       Minimum protocol version required for the set_cursor_position_hint function.

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

   constexprstd::uint32_twayland::zwp_locked_pointer_v1_t::set_region_since_version=1[static],[constexpr]

       Minimum protocol version required for the set_region function.

       Definition at line 2671 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()>&zwp_locked_pointer_v1_t::on_locked()
       lock activation event Notification that the pointer lock of the seat's pointer is activated.

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

   std::function<void()>&zwp_locked_pointer_v1_t::on_unlocked()
       lock  deactivation event Notification that the pointer lock of the seat's pointer is no longer active. If
       this is a oneshot pointer lock (see wp_pointer_constraints.lifetime)  this  object  is  now  defunct  and
       should  be  destroyed.  If  this  is a persistent pointer lock (see wp_pointer_constraints.lifetime) this
       pointer lock may again reactivate in the future.

       Definition at line 5844 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_locked_pointer_v1_t::set_cursor_position_hint(doublesurface_x,doublesurface_y)
       set the pointer cursor position hint

       Parameterssurface_x surface-local x coordinate
           surface_y surface-local y coordinate

       Set the cursor position hint relative to the top left corner of the surface.

       If  the  client  is drawing its own cursor, it should update the position hint to the position of its own
       cursor. A compositor may use this information to warp the pointer upon unlock in order to  avoid  pointer
       jumps.

       The  cursor  position  hint  is  double  buffered. The new hint will only take effect when the associated
       surface gets it pending state applied. See wl_surface.commit for details.

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

   voidzwp_locked_pointer_v1_t::set_region(region_tconst&region)
       set a new lock region

       Parametersregion region of surface

       Set a new region used to lock the pointer.

       The  new  lock  region  is double-buffered. The new lock region will only take effect when the associated
       surface gets its pending state applied. See wl_surface.commit for details.

       For details about the lock region, see wp_locked_pointer.

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

Name

       wayland::zwp_locked_pointer_v1_t - receive relative pointer motion events

Synopsis

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

       Inherits wayland::proxy_t.

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

   PublicMemberFunctions
       void set_cursor_position_hint (double surface_x, double surface_y)
           set the pointer cursor position hint
       void set_region (region_t const &region)
           set a new lock region
       std::function< void()> & on_locked ()
           lock activation event
       std::function< void()> & on_unlocked ()
           lock deactivation event
       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_cursor_position_hint_since_version = 1
           Minimum protocol version required for the set_cursor_position_hint function.
       static constexpr std::uint32_t set_region_since_version = 1
           Minimum protocol version required for the set_region function.