src/protocols/contrast.xml

0001 <?xml version="1.0" encoding="UTF-8"?>
0002 <protocol name="contrast">
0003   <copyright><![CDATA[
0004     SPDX-FileCopyrightText: 2015 Martin Gräßlin
0005     SPDX-FileCopyrightText: 2015 Marco Martin
0006
0007     SPDX-License-Identifier: LGPL-2.1-or-later
0008   ]]></copyright>
0009   <interface name="org_kde_kwin_contrast_manager" version="2">
0010       <request name="create">
0011           <arg name="id" type="new_id" interface="org_kde_kwin_contrast"/>
0012           <arg name="surface" type="object" interface="wl_surface"/>
0013       </request>
0014       <request name="unset">
0015           <arg name="surface" type="object" interface="wl_surface"/>
0016       </request>
0017   </interface>
0018   <interface name="org_kde_kwin_contrast" version="2">
0019       <request name="commit">
0020       </request>
0021       <request name="set_region">
0022         <arg name="region" type="object" interface="wl_region" allow-null="true"/>
0023       </request>
0024       <request name="set_contrast">
0025         <arg name="contrast" type="fixed"/>
0026       </request>
0027       <request name="set_intensity">
0028         <arg name="intensity" type="fixed"/>
0029       </request>
0030       <request name="set_saturation">
0031         <arg name="saturation" type="fixed"/>
0032       </request>
0033       <request name="release" type="destructor">
0034         <description summary="release the contrast object"/>
0035       </request>
0036
0037       <request name="set_frost" since="2">
0038         <description summary="opt into frost effect w/ given colour">
0039           enables 'frost' variant of contrast effect.
0040
0041           'frost' is an enhanced version of the contrast effect that
0042           uses different colour arithmetic to get backgrounds simultaneously
0043           higher in contrast and (apparent) transparency.
0044
0045           r, g, b, a are channels from 0-255, indicating a colour to use in contrast calculation.
0046           should be based off of the "main" background colour of the surface.
0047         </description>
0048
0049         <arg name="red" type="int" />
0050         <arg name="green" type="int" />
0051         <arg name="blue" type="int" />
0052         <arg name="alpha" type="int" />
0053       </request>
0054       <request name="unset_frost" since="2">
0055         <description summary="opts out of frost effect" />
0056       </request>
0057   </interface>
0058 </protocol>