mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2025-11-25 06:59:46 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Auto-generate Protocol/Interfaces section instead

Browse source 
Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
This commit is contained in:
Tiago Vignatti 2012-10-08 18:39:58 +03:00 • committed by Kristian Høgsberg
parent d3fe28384c
commit 7fe381861b
3 changed files with 66 additions and 128 deletions
Download patch file Download diff file Expand all files Collapse all files

126
doc/Wayland/en_US/Protocol.xml
View file

@ -163,131 +163,7 @@
</variablelist>
</para>
</section>
<section id="sect-Protocol-Interfaces">
<title>Interfaces</title>
<para>
The protocol includes several interfaces which are used for
interacting with the server. Each interface provides requests,
events, and errors (which are really just special events) as described
above. Specific compositor implementations may have their own
interfaces provided as extensions, but there are several which are
always expected to be present.
</para>
<para>
Core interfaces:
<variablelist>
<varlistentry>
<term>wl_display</term>
<listitem>
<para>
provides global functionality like object binding and
fatal error events
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>wl_callback</term>
<listitem>
<para>
callback interface for done events
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>wl_compositor</term>
<listitem>
<para>
core compositor interface, allows surface creation
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>wl_shm</term>
<listitem>
<para>
buffer management interface with buffer creation and format
handling
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>wl_buffer</term>
<listitem>
<para>
buffer handling interface for indicating damage and object
destruction, also provides buffer release events from the
server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>wl_data_offer</term>
<listitem>
<para>
for accepting and receiving specific mime types
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>wl_data_source</term>
<listitem>
<para>
for offering specific mime types
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>wl_data_device</term>
<listitem>
<para>
lets clients manage drag &amp; drop, provides pointer enter/leave events and motion
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>wl_data_device_manager</term>
<listitem>
<para>
for managing data sources and devices
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>wl_shell</term>
<listitem>
<para>
shell surface handling
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>wl_shell_surface</term>
<listitem>
<para>
shell surface handling and desktop-like events (e.g. set a
surface to fullscreen, display a popup, etc.)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>wl_seat</term>
<listitem>
<para>
cursor setting, motion, button, and key events, etc.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>wl_output</term>
<listitem>
<para>
events describing an attached output (subpixel orientation,
current mode &amp; geometry, etc.) </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>
<xi:include href="ProtocolInterfaces.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<section id="sect-Protocol-Connect-Time">
<title>Connect Time</title>
<para>