Alpha modifier protocol
wp_alpha_modifier_v1
This interface allows a client to set a factor for the alpha values on a surface, which can be used to offload such operations to the compositor, which can in turn for example offload them to KMS.
Warning! The protocol described in this file is currently in the testing phase. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes can only be done by creating a new major version of the extension.
destroy()
Destroy the alpha modifier manager. This doesn't destroy objects created with the manager.
get_surface(id: new_id<wp_alpha_modifier_surface_v1>, surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| id | new_id<wp_alpha_modifier_surface_v1> | |
| surface | object<wl_surface> |
Create a new alpha modifier surface object associated with the given wl_surface. If there is already such an object associated with the wl_surface, the already_constructed error will be raised.
error { already_constructed }
Argument | Value | Description |
|---|---|---|
| already_constructed | 0 | wl_surface already has a alpha modifier object |
wp_alpha_modifier_surface_v1
This interface allows the client to set a factor for the alpha values on a surface, which can be used to offload such operations to the compositor. The default factor is UINT32_MAX.
This object has to be destroyed before the associated wl_surface. Once the wl_surface is destroyed, all request on this object will raise the no_surface error.
destroy()
This destroys the object, and is equivalent to set_multiplier with a value of UINT32_MAX, with the same double-buffered semantics as set_multiplier.
set_multiplier(factor: uint)
Argument | Type | Description |
|---|---|---|
| factor | uint |
Sets the alpha multiplier for the surface. The alpha multiplier is double-buffered state, see wl_surface.commit for details.
This factor is applied in the compositor's blending space, as an additional step after the processing of per-pixel alpha values for the wl_surface. The exact meaning of the factor is thus undefined, unless the blending space is specified in a different extension.
This multiplier is applied even if the buffer attached to the wl_surface doesn't have an alpha channel; in that case an alpha value of one is used instead.
Zero means completely transparent, UINT32_MAX means completely opaque.
error { no_surface }
Argument | Value | Description |
|---|---|---|
| no_surface | 0 | wl_surface was destroyed |
Compositor Support
Mutter  46 | KWin  6.2 | Sway  1.9 | COSMIC  1.0.0 | Hyprland  0.42.0 | niri 0.1.8 | Weston  13 | Mir  2.18 | GameScope  3.15.14 | Jay 1.7.0 | |
|---|---|---|---|---|---|---|---|---|---|---|
| wp_alpha_modifier_v1 | x | 1 | x | 1 | 1 | x | x | x | x | 1 |
Copyright
Copyright © 2024 Xaver Hugl
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.