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_confined_pointer_v1_t,surface_t,pointer_t,region_t,zwp_pointer_constraints_v1_lifetime)>&zwp_pointer_constraints_v1_t::on_confine_pointer()
confine pointer to a region
Parametersidsurface surface to lock pointer to
pointer the pointer that should be confined
region region of surface
lifetime confinement lifetime
The confine_pointer request lets the client request to confine the pointer cursor to a given region. This
request may not take effect immediately; in the future, when the compositor deems implementation-
specific constraints are satisfied, the pointer confinement will be activated and the compositor sends a
confined event.
The intersection of the region passed with this request and the input region of the surface is used to
determine where the pointer must be in order for the confinement to activate. It is up to the compositor
whether to warp the pointer or require some kind of user interaction for the confinement to activate. If
the region is null the surface input region is used.
The request will create a new object wp_confined_pointer which is used to interact with the confinement
as well as receive updates about its state. See the the description of wp_confined_pointer for further
information.
Definition at line 5382 of file wayland-server-protocol-unstable.cpp.
std::function<void()>&zwp_pointer_constraints_v1_t::on_destroy()
destroy the pointer constraints manager object Used by the client to notify the server that it will no
longer use this pointer constraints object.
Definition at line 5370 of file wayland-server-protocol-unstable.cpp.
std::function<void(zwp_locked_pointer_v1_t,surface_t,pointer_t,region_t,zwp_pointer_constraints_v1_lifetime)>&zwp_pointer_constraints_v1_t::on_lock_pointer()
lock pointer to a position
Parametersidsurface surface to lock pointer to
pointer the pointer that should be locked
region region of surface
lifetime lock lifetime
The lock_pointer request lets the client request to disable movements of the virtual pointer (i.e. the
cursor), effectively locking the pointer to a position. This request may not take effect immediately; in
the future, when the compositor deems implementation-specific constraints are satisfied, the pointer lock
will be activated and the compositor sends a locked event.
The protocol provides no guarantee that the constraints are ever satisfied, and does not require the
compositor to send an error if the constraints cannot ever be satisfied. It is thus possible to request a
lock that will never activate.
There may not be another pointer constraint of any kind requested or active on the surface for any of the
wl_pointer objects of the seat of the passed pointer when requesting a lock. If there is, an error will
be raised. See general pointer lock documentation for more details.
The intersection of the region passed with this request and the input region of the surface is used to
determine where the pointer must be in order for the lock to activate. It is up to the compositor whether
to warp the pointer or require some kind of user interaction for the lock to activate. If the region is
null the surface input region is used.
A surface may receive pointer focus without the lock being activated.
The request creates a new object wp_locked_pointer which is used to interact with the lock as well as
receive updates about its state. See the the description of wp_locked_pointer for further information.
Note that while a pointer is locked, the wl_pointer objects of the corresponding seat will not emit any
wl_pointer.motion events, but relative motion events will still be emitted via wp_relative_pointer
objects of the same seat. wl_pointer.axis and wl_pointer.button events are unaffected.
Definition at line 5376 of file wayland-server-protocol-unstable.cpp.
voidzwp_pointer_constraints_v1_t::post_already_constrained(std::stringconst&msg)
Post error: pointer constraint already requested on that surface.
Definition at line 5388 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