Differential D1231 Diff 30273 src/client/protocols/remote-access.xml

Changeset View

Standalone View

View Options

src/client/protocols/remote-access.xml

  • This file was added.
1​<?xml version="1.0" encoding="UTF-8"?>
2​<protocol name="remote_access">
3​ <copyright><![CDATA[
4​ Copyright (C) 2016 Oleg Chernovskiy
5​
6​ This program is free software: you can redistribute it and/or modify
7​ it under the terms of the GNU Lesser General Public License as published by
8​ the Free Software Foundation, either version 2.1 of the License, or
9​ (at your option) any later version.
10​
11​ This program is distributed in the hope that it will be useful,
12​ but WITHOUT ANY WARRANTY; without even the implied warranty of
13​ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14​ GNU Lesser General Public License for more details.
15​
16​ You should have received a copy of the GNU Lesser General Public License
17​ along with this program. If not, see <http://www.gnu.org/licenses/>.
18​ ]]></copyright>
19​ <interface name="org_kde_kwin_remote_access_manager" version="1">
20​ <description summary="Protocol for managing rendered GBM buffers passing"/>
graesslinUnsubmitted
Done

I noticed that standard Wayland protocols also have a destructor request for the manager interface. I'd suggest to also add it (it makes sense as then the server can destroy the resource).

graesslin: I noticed that standard Wayland protocols also have a destructor request for the manager…
KanediasAuthorUnsubmitted
Not Done

Added destructor and release callback.

Kanedias: Added destructor and release callback.
21​ <event name="buffer_ready" since="1">
22​ <description summary="Signals about buffer ready to be consumed by clients"/>
23​ <arg name="id" type="int" summary="unique id of created buffer (you can use server-side fd number)"/>
24​ <arg name="output" type="object" interface="wl_output" summary="screen that this buffer belongs to"/>
davidedmundsonUnsubmitted
Not Done

Assuming we do output merging in the client we want an extra arg with the wl_output here.

We don't need want it in the request, as each output will get a different buffer and therefore a different ID.

davidedmundson: Assuming we do output merging in the client we want an extra arg with the wl_output here. We…
KanediasAuthorUnsubmitted
Not Done

Gotcha, will do

Kanedias: Gotcha, will do
25​ </event>
26​ <request name="get_buffer" since="1">
27​ <description summary="Answer on buffer_ready event, retrieves new buffer from server"/>
28​ <arg name="buffer" type="new_id" interface="org_kde_kwin_remote_buffer"/>
29​ <arg name="internal_buffer_id" type="int" summary="The internal buffer id of the buffer to create"/>
30​ </request>
31​ <request name="release" type="destructor">
32​ <description summary="release org_kde_kwin_remote_access_manager interface"/>
33​ </request>
34​ </interface>
graesslinUnsubmitted
Done

so the idea here would be that if in future we want to support other buffers (e.g. shared mem) we just add a new event?

graesslin: so the idea here would be that if in future we want to support other buffers (e.g. shared mem)…
KanediasAuthorUnsubmitted
Not Done

Yes, with appropriate "since" clause

Kanedias: Yes, with appropriate "since" clause
35​ <interface name="org_kde_kwin_remote_buffer" version="1">
36​ <description summary="This interface allows finer control of remote buffer lifecycle"/>
37​ <event name="gbm_handle" since="1">
38​ <description summary="This is sent after binding to remote access manager" />
39​ <arg name="fd" type="fd"/>
40​ <arg name="width" type="uint"/>
41​ <arg name="height" type="uint"/>
42​ <arg name="stride" type="uint"/>
graesslinUnsubmitted
Done

Just for thought: in other interfaces the destructor is mostly called "release"

graesslin: Just for thought: in other interfaces the destructor is mostly called "release"
KanediasAuthorUnsubmitted
Not Done

Renamed

Kanedias: Renamed
43​ <arg name="format" type="uint"/>
44​ </event>
45​ <request name="release" type="destructor" since="1">
46​ <description summary="This request comes once client no longer needs this buffer."/>
47​ </request>
48​ </interface>
49​</protocol>