Skip to content

wp_viewporter¤

wayland.wp_viewporter ¤

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.

Methods:

  • destroy –

    Unbind from the cropping and scaling interface

  • get_viewport –

    Extend surface interface for crop and scale

error ¤

destroy ¤

destroy() -> None

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.

get_viewport ¤

get_viewport(surface: wl_surface) -> wp_viewport

Extend surface interface for crop and scale

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.

Parameters:

Returns: