hyprwm/hyprland-protocols
1
0
Fork 0
mirror of https://github.com/hyprwm/hyprland-protocols.git synced 2025-12-20 13:10:02 +01:00
Code Issues Projects Releases Packages Wiki Activity

hyprland-surface: add set_visible_region (#13)

Browse source 
Allows the clients to specify which region of the surface is supposed to be rendered
This commit is contained in:
outfoxxed 2025-01-22 06:36:32 -08:00 • committed by GitHub
parent 455c055883
commit 5758ab13d6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 28 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
protocols/hyprland-surface-v1.xml
View file

@ -34,7 +34,7 @@
This protocol exposes hyprland-specific wl_surface properties. This protocol exposes hyprland-specific wl_surface properties.
</description> </description>
<interface name="hyprland_surface_manager_v1" version="1"> <interface name="hyprland_surface_manager_v1" version="2">
<description summary="manager for hyprland surface objects"> <description summary="manager for hyprland surface objects">
This interface allows a client to create hyprland surface objects. This interface allows a client to create hyprland surface objects.
</description> </description>
@ -63,7 +63,7 @@
</enum> </enum>
</interface> </interface>
<interface name="hyprland_surface_v1" version="1"> <interface name="hyprland_surface_v1" version="2">
<description summary="hyprland-specific wl_surface properties"> <description summary="hyprland-specific wl_surface properties">
This interface allows access to hyprland-specific properties of a wl_surface. This interface allows access to hyprland-specific properties of a wl_surface.
@ -96,5 +96,31 @@
<entry name="no_surface" value="0" summary="wl_surface was destroyed"/> <entry name="no_surface" value="0" summary="wl_surface was destroyed"/>
<entry name="out_of_range" value="1" summary="given opacity was not in the range 0.0 - 1.0 (inclusive)"/> <entry name="out_of_range" value="1" summary="given opacity was not in the range 0.0 - 1.0 (inclusive)"/>
</enum> </enum>
<request name="set_visible_region" since="2">
<description summary="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.
</description>
<arg name="region" type="object" interface="wl_region" allow-null="true"/>
</request>
</interface> </interface>
</protocol> </protocol>