hyprland_surface_v1¤
Hyprland-specific wl_surface properties
This interface allows access to hyprland-specific properties of a wl_surface.
Once the wl_surface has been destroyed, the hyprland surface object must be destroyed as well. All other operations are a protocol error.
Methods:
-
set_opacity–Set the overall opacity of the surface
-
destroy–Destroy the hyprland surface interface
-
set_visible_region–Set the visible region of the surface
-
no_surface–`wl_surface` was destroyed -
out_of_range–Given opacity was not in the range 0.0 - 1.0 (inclusive)
set_opacity(opacity: float) -> None
Set the overall opacity of the surface
Sets a multiplier for the overall opacity of the surface. This multiplier applies to visual effects such as blur behind the surface in addition to the surface's content.
The default value is 1.0. Setting a value outside of the range 0.0 - 1.0 (inclusive) is a protocol error. Does not take effect until wl_surface.commit is called.
destroy() -> None
Destroy the hyprland surface interface
Destroy the hyprland surface object, resetting properties provided by this interface to their default values on the next wl_surface.commit.
set_visible_region(region: wl_region) -> None
Set the visible region of the surface
This request sets the region of the surface that contains visible content. Visible content refers to content that has an alpha value greater than zero.
The visible region is an optimization hint for the compositor that lets it avoid drawing parts of the surface that are not visible. Setting a visible region that does not contain all content in the surface may result in missing content not being drawn.
The visible region is specified in buffer-local coordinates.
The compositor ignores the parts of the visible region that fall outside of the surface. When all parts of the region fall outside of the buffer geometry, the compositor may avoid rendering the surface entirely.
The initial value for the visible region is empty. Setting the visible region has copy semantics, and the wl_region object can be destroyed immediately. A NULL wl_region causes the visible region to be set to empty.
Does not take effect until wl_surface.commit is called.