wayland::server::viewporter_t(3) Wayland++ wayland::server::viewporter_t(3)

wayland::server::viewporter_t - surface cropping and scaling

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

Inherits wayland::server::resource_t.


std::function< void()> & on_destroy ()
unbind from the cropping and scaling interface std::function< void(viewport_t, surface_t)> & on_get_viewport ()
extend surface interface for crop and scale void post_viewport_exists (std::string const &msg)
Post error: the surface already has a viewport object associated. 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 ()

surface cropping and scaling

The global interface exposing surface cropping and scaling capabilities is used to instantiate an interface extension for a wl_surface object. This extended interface will then allow cropping and scaling the surface contents, effectively disconnecting the direct relationship between the buffer and the surface size.

Definition at line 361 of file wayland-server-protocol-extra.hpp.

Retrieve the interface name (class) of a resource object.

Returns

Interface name of the resource object.

Get the associated client

Returns

the client that owns the resource.

Get the internal ID of the resource

Returns

the internal ID of the resource

Get interface version

Returns

Interface version this resource has been constructed with.

unbind from the cropping and scaling interface Informs the server that the client will not be using this protocol object anymore. This does not affect any other objects, wp_viewport objects included.

Definition at line 796 of file wayland-server-protocol-extra.cpp.

extend surface interface for crop and scale

Parameters

id the new viewport interface id
surface the surface

Instantiate an interface extension for the given wl_surface to crop and scale its content. If the given wl_surface already has a wp_viewport object associated, the viewport_exists protocol error is raised.

Definition at line 802 of file wayland-server-protocol-extra.cpp.

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.

Post error: the surface already has a viewport object associated.

Definition at line 808 of file wayland-server-protocol-extra.cpp.

Check whether this wrapper actually wraps an object.

Returns

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

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

Mon Apr 22 2024 09:52:15 Version 1.0.0