README: fix spelling typo
[mesa-waffle.git] / man / waffle_wayland.3.xml
blob2af1b2f0a576121ba0fec99cb8624294866a5ca3
1 <?xml version='1.0'?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5 <!--
6   Copyright Intel 2012
8   This manual page is licensed under the Creative Commons Attribution-ShareAlike 3.0 United States License (CC BY-SA 3.0
9   US). To view a copy of this license, visit http://creativecommons.org.license/by-sa/3.0/us.
10 -->
12 <refentry
13     id="waffle_wayland"
14     xmlns:xi="http://www.w3.org/2001/XInclude">
16   <!-- See http://www.docbook.org/tdg/en/html/refentry.html. -->
18   <refmeta>
19     <refentrytitle>waffle_wayland</refentrytitle>
20     <manvolnum>3</manvolnum>
21   </refmeta>
23   <refnamediv>
24     <refname>waffle_wayland</refname>
25     <refname>waffle_wayland_display</refname>
26     <refname>waffle_wayland_config</refname>
27     <refname>waffle_wayland_context</refname>
28     <refname>waffle_wayland_window</refname>
29     <refpurpose>Containers for underlying native Wayland objects</refpurpose>
30   </refnamediv>
32   <refentryinfo>
33     <title>Waffle Manual</title>
34     <productname>waffle</productname>
35     <xi:include href="common/author-chad.versace.xml"/>
36     <xi:include href="common/copyright.xml"/>
37     <xi:include href="common/legalnotice.xml"/>
38   </refentryinfo>
40   <refsynopsisdiv>
42     <synopsis language="C">
43 #include &lt;waffle_wayland.h&gt;
45 struct waffle_wayland_display {
46     struct wl_display *wl_display;
47     struct wl_compositor *wl_compositor;
48     struct wl_shell *wl_shell;
49     EGLDisplay egl_display;
52 struct waffle_wayland_config {
53     struct waffle_wayland_display display;
54     EGLConfig egl_config;
57 struct waffle_wayland_context {
58     struct waffle_wayland_display display;
59     EGLContext egl_context;
62 struct waffle_wayland_window {
63     struct waffle_wayland_display display;
64     struct wl_surface *wl_surface;
65     struct wl_shell_surface *wl_shell_surface;
66     struct wl_egl_window *wl_window;
67     EGLSurface egl_surface;
69     </synopsis>
70   </refsynopsisdiv>
72   <xi:include href="common/issues.xml"/>
74   <refsect1>
75     <title>See Also</title>
76     <para>
77       <citerefentry><refentrytitle>waffle</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
78       <citerefentry><refentrytitle>waffle_native</refentrytitle><manvolnum>3</manvolnum></citerefentry>
79     </para>
80   </refsect1>
82 </refentry>
84 <!--
85 vim:tw=120 et ts=2 sw=2:
86 -->