diff options
Diffstat (limited to 'contrib/SDL-3.2.8/wayland-protocols/alpha-modifier-v1.xml')
| -rw-r--r-- | contrib/SDL-3.2.8/wayland-protocols/alpha-modifier-v1.xml | 103 |
1 files changed, 103 insertions, 0 deletions
diff --git a/contrib/SDL-3.2.8/wayland-protocols/alpha-modifier-v1.xml b/contrib/SDL-3.2.8/wayland-protocols/alpha-modifier-v1.xml new file mode 100644 index 0000000..932fa6f --- /dev/null +++ b/contrib/SDL-3.2.8/wayland-protocols/alpha-modifier-v1.xml | |||
| @@ -0,0 +1,103 @@ | |||
| 1 | <?xml version="1.0" encoding="UTF-8"?> | ||
| 2 | <protocol name="alpha_modifier_v1"> | ||
| 3 | <copyright> | ||
| 4 | Copyright © 2024 Xaver Hugl | ||
| 5 | |||
| 6 | Permission is hereby granted, free of charge, to any person obtaining a | ||
| 7 | copy of this software and associated documentation files (the "Software"), | ||
| 8 | to deal in the Software without restriction, including without limitation | ||
| 9 | the rights to use, copy, modify, merge, publish, distribute, sublicense, | ||
| 10 | and/or sell copies of the Software, and to permit persons to whom the | ||
| 11 | Software is furnished to do so, subject to the following conditions: | ||
| 12 | |||
| 13 | The above copyright notice and this permission notice (including the next | ||
| 14 | paragraph) shall be included in all copies or substantial portions of the | ||
| 15 | Software. | ||
| 16 | |||
| 17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| 18 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| 19 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL | ||
| 20 | THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| 21 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | ||
| 22 | FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER | ||
| 23 | DEALINGS IN THE SOFTWARE. | ||
| 24 | </copyright> | ||
| 25 | |||
| 26 | <interface name="wp_alpha_modifier_v1" version="1"> | ||
| 27 | <description summary="surface alpha modifier manager"> | ||
| 28 | This interface allows a client to set a factor for the alpha values on a | ||
| 29 | surface, which can be used to offload such operations to the compositor, | ||
| 30 | which can in turn for example offload them to KMS. | ||
| 31 | |||
| 32 | Warning! The protocol described in this file is currently in the testing | ||
| 33 | phase. Backward compatible changes may be added together with the | ||
| 34 | corresponding interface version bump. Backward incompatible changes can | ||
| 35 | only be done by creating a new major version of the extension. | ||
| 36 | </description> | ||
| 37 | |||
| 38 | <request name="destroy" type="destructor"> | ||
| 39 | <description summary="destroy the alpha modifier manager object"> | ||
| 40 | Destroy the alpha modifier manager. This doesn't destroy objects | ||
| 41 | created with the manager. | ||
| 42 | </description> | ||
| 43 | </request> | ||
| 44 | |||
| 45 | <enum name="error"> | ||
| 46 | <entry name="already_constructed" value="0" | ||
| 47 | summary="wl_surface already has a alpha modifier object"/> | ||
| 48 | </enum> | ||
| 49 | |||
| 50 | <request name="get_surface"> | ||
| 51 | <description summary="create a new toplevel decoration object"> | ||
| 52 | Create a new alpha modifier surface object associated with the | ||
| 53 | given wl_surface. If there is already such an object associated with | ||
| 54 | the wl_surface, the already_constructed error will be raised. | ||
| 55 | </description> | ||
| 56 | <arg name="id" type="new_id" interface="wp_alpha_modifier_surface_v1"/> | ||
| 57 | <arg name="surface" type="object" interface="wl_surface"/> | ||
| 58 | </request> | ||
| 59 | </interface> | ||
| 60 | |||
| 61 | <interface name="wp_alpha_modifier_surface_v1" version="1"> | ||
| 62 | <description summary="alpha modifier object for a surface"> | ||
| 63 | This interface allows the client to set a factor for the alpha values on | ||
| 64 | a surface, which can be used to offload such operations to the compositor. | ||
| 65 | The default factor is UINT32_MAX. | ||
| 66 | |||
| 67 | This object has to be destroyed before the associated wl_surface. Once the | ||
| 68 | wl_surface is destroyed, all request on this object will raise the | ||
| 69 | no_surface error. | ||
| 70 | </description> | ||
| 71 | |||
| 72 | <enum name="error"> | ||
| 73 | <entry name="no_surface" value="0" summary="wl_surface was destroyed"/> | ||
| 74 | </enum> | ||
| 75 | |||
| 76 | <request name="destroy" type="destructor"> | ||
| 77 | <description summary="destroy the alpha modifier object"> | ||
| 78 | This destroys the object, and is equivalent to set_multiplier with | ||
| 79 | a value of UINT32_MAX, with the same double-buffered semantics as | ||
| 80 | set_multiplier. | ||
| 81 | </description> | ||
| 82 | </request> | ||
| 83 | |||
| 84 | <request name="set_multiplier"> | ||
| 85 | <description summary="specify the alpha multiplier"> | ||
| 86 | Sets the alpha multiplier for the surface. The alpha multiplier is | ||
| 87 | double-buffered state, see wl_surface.commit for details. | ||
| 88 | |||
| 89 | This factor is applied in the compositor's blending space, as an | ||
| 90 | additional step after the processing of per-pixel alpha values for the | ||
| 91 | wl_surface. The exact meaning of the factor is thus undefined, unless | ||
| 92 | the blending space is specified in a different extension. | ||
| 93 | |||
| 94 | This multiplier is applied even if the buffer attached to the | ||
| 95 | wl_surface doesn't have an alpha channel; in that case an alpha value | ||
| 96 | of one is used instead. | ||
| 97 | |||
| 98 | Zero means completely transparent, UINT32_MAX means completely opaque. | ||
| 99 | </description> | ||
| 100 | <arg name="factor" type="uint"/> | ||
| 101 | </request> | ||
| 102 | </interface> | ||
| 103 | </protocol> | ||
