src/protocols/remote-access.xml

0001 <?xml version="1.0" encoding="UTF-8"?>
0002 <protocol name="remote_access">
0003   <copyright><![CDATA[
0004     SPDX-FileCopyrightText: 2016 Oleg Chernovskiy
0005
0006     SPDX-License-Identifier: LGPL-2.1-or-later
0007   ]]></copyright>
0008     <interface name="org_kde_kwin_remote_access_manager" version="1">
0009         <description summary="Protocol for managing rendered GBM buffers passing"/>
0010         <event name="buffer_ready" since="1">
0011             <description summary="Signals about buffer ready to be consumed by clients"/>
0012             <arg name="id" type="int" summary="unique id of created buffer (you can use server-side fd number)"/>
0013             <arg name="output" type="object" interface="wl_output" summary="screen that this buffer belongs to"/>
0014         </event>
0015         <request name="get_buffer" since="1">
0016             <description summary="Answer on buffer_ready event, retrieves new buffer from server"/>
0017             <arg name="buffer" type="new_id" interface="org_kde_kwin_remote_buffer"/>
0018             <arg name="internal_buffer_id" type="int" summary="The internal buffer id of the buffer to create"/>
0019         </request>
0020         <request name="release" type="destructor">
0021             <description summary="release org_kde_kwin_remote_access_manager interface"/>
0022         </request>
0023     </interface>
0024     <interface name="org_kde_kwin_remote_buffer" version="1">
0025         <description summary="This interface allows finer control of remote buffer lifecycle"/>
0026         <event name="gbm_handle" since="1">
0027             <description summary="This is sent after binding to remote access manager" />
0028             <arg name="fd" type="fd"/>
0029             <arg name="width" type="uint"/>
0030             <arg name="height" type="uint"/>
0031             <arg name="stride" type="uint"/>
0032             <arg name="format" type="uint"/>
0033         </event>
0034         <request name="release" type="destructor" since="1">
0035           <description summary="This request comes once client no longer needs this buffer."/>
0036         </request>
0037     </interface>
0038 </protocol>