File: waffle_init.3.xml

package info (click to toggle)
waffle 1.6.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 3,092 kB
  • sloc: ansic: 19,173; xml: 2,906; cpp: 489; objc: 465; sh: 100; makefile: 20
file content (264 lines) | stat: -rw-r--r-- 8,367 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  "file:///usr/share/xml/docbook/schema/dtd/4.2/docbookx.dtd">

<!--
  Copyright Intel 2012

  This manual page is licensed under the Creative Commons Attribution-ShareAlike 3.0 United States License (CC BY-SA 3.0
  US). To view a copy of this license, visit http://creativecommons.org.license/by-sa/3.0/us.
-->

<refentry
    id="waffle_init"
    xmlns:xi="http://www.w3.org/2001/XInclude">

  <!-- See http://www.docbook.org/tdg/en/html/refentry.html. -->

  <refmeta>
    <refentrytitle>waffle_init</refentrytitle>
    <manvolnum>3</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>waffle_init</refname>
    <refpurpose>Initialize waffle's per-process global state</refpurpose>
  </refnamediv>

  <refentryinfo>
    <title>Waffle Manual</title>
    <productname>waffle</productname>
    <xi:include href="common/author-chad.versace.xml"/>
    <xi:include href="common/copyright.xml"/>
    <xi:include href="common/legalnotice.xml"/>
  </refentryinfo>

  <refsynopsisdiv>
    <funcsynopsis>
      <funcsynopsisinfo><![CDATA[#include <waffle.h>]]></funcsynopsisinfo>
      <funcprototype>
        <funcdef>bool <function>waffle_init</function></funcdef>
        <paramdef>const int32_t <parameter>attrib_list</parameter>[]</paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para>
      <function>waffle_init()</function> initializes the per-process global state of the waffle library with the
      attributes specified in <parameter>attrib_list</parameter>.  The set of attributes is documented below.
      <parameter>attrib_list</parameter> consists of a zero-terminated sequence of name/value pairs.
    </para>

    <para>
      Most waffle functions emit an error if called when waffle is unitialized.  The small set of functions that can be
      successfully called before initialization are explicitly documented as such.
    </para>

    <para>
      If a call to <function>waffle_init()</function> fails, no global state is initialized and the caller may safely
      attempt to call <function>waffle_init()</function> again.  If waffle has already been initialized by a successful
      call to <function>waffle_init()</function> one has to call <function>waffle_teardown()</function> to clear the
      global state. Otherwise calling <function>waffle_init()</function> again emits the error
      <errorcode>WAFFLE_ERROR_ALREADY_INITIALIZED</errorcode>.
    </para>

  </refsect1>

  <refsect1>
    <title>Attributes</title>

    <variablelist>

      <varlistentry>
        <term><constant>WAFFLE_PLATFORM</constant></term>
        <listitem>
          <para>
            This attribute is required. Possible values are:

            <variablelist>

              <varlistentry>
                <term><constant>WAFFLE_PLATFORM_ANDROID</constant></term>
                <listitem>
                  <para>
                    [Android] Use EGL on Android.
                  </para>
                </listitem>
              </varlistentry>

              <varlistentry>
                <term><constant>WAFFLE_PLATFORM_GBM</constant></term>
                <listitem>
                  <para>
                    [Linux] Use EGL with GBM, the "Generic Buffer Manager" provided by libgbm. This platform is
                    capable of OpenGL rendering without a display manager.
                  </para>
                </listitem>
              </varlistentry>

              <varlistentry>
                <term><constant>WAFFLE_PLATFORM_CGL</constant></term>
                <listitem>
                  <para>
                    [MacOS] Use CGL to create the
                    <citerefentry><refentrytitle><function>waffle_config</function></refentrytitle><manvolnum>3</manvolnum></citerefentry>
                    and
                    <citerefentry><refentrytitle><function>waffle_context</function></refentrytitle><manvolnum>3</manvolnum></citerefentry>.
                    Use Cocoa to create the
                    <citerefentry><refentrytitle><function>waffle_window</function></refentrytitle><manvolnum>3</manvolnum></citerefentry>.
                  </para>
                </listitem>
              </varlistentry>

              <varlistentry>
                <term><constant>WAFFLE_PLATFORM_GLX</constant></term>
                <listitem>
                  <para>
                    [Linux only, MacOS not yet supported]
                  </para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term><constant>WAFFLE_PLATFORM_NACL</constant></term>
                <listitem>
                  <para>
                    [Linux only, other systems not yet supported]
                  </para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term><constant>WAFFLE_PLATFORM_SURFACELESS_EGL</constant></term>
                <listitem>
                  <para>
                    [Linux] Use EGL's "surfaceless" platform,
                    <ulink url="https://www.khronos.org/registry/egl/extensions/MESA/EGL_MESA_platform_surfaceless.txt">EGL_MESA_platform_surfaceless</ulink>.
                  </para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term><constant>WAFFLE_PLATFORM_WAYLAND</constant></term>
                <listitem>
                  <para>
                    [Linux] Use EGL with the Wayland display server.
                  </para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term><constant>WAFFLE_PLATFORM_WGL</constant></term>
                <listitem>
                  <para>
                    [Windows] Use WGL on Windows.
                  </para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term><constant>WAFFLE_PLATFORM_X11_EGL</constant></term>
                <listitem>
                  <para>
                    [Linux] Use EGL with the X11 display server.
                  </para>
                </listitem>
              </varlistentry>

            </variablelist>
          </para>
        </listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

  <refsect1>
    <title>Return Value</title>
    <xi:include href="common/return-value.xml"/>
  </refsect1>

  <refsect1>
    <title>Errors</title>

    <xi:include href="common/error-codes.xml"/>

    <para>
      Listed are the errors specific to <function>waffle_init()</function>.
    </para>

    <variablelist>

      <varlistentry>
        <term><errorcode>WAFFLE_ERROR_ALREADY_INITIALIZED</errorcode></term>
        <listitem>
          <para>
            Waffle has already been initialized with a successful call to <function>waffle_init()</function>.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><errorcode>WAFFLE_ERROR_BAD_ATTRIBUTE</errorcode></term>
        <listitem>
          <para>
            An item in <parameter>attrib_list</parameter> is unrecognized or has an invalid value, or a required
            attribute is missing.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><errorcode>WAFFLE_ERROR_BUILT_WITHOUT_SUPPORT</errorcode></term>
        <listitem>
          <para>
            Waffle was built without support for the requested attribute.
          </para>
        </listitem>
      </varlistentry>

    </variablelist>

  </refsect1>

  <refsect1>
    <title>Example</title>

    <para>
      Initialize waffle for X11/EGL.
    </para>

    <programlisting>
<![CDATA[
#include <waffle.h>

static const int32_t init_attrib_list[] = {
    WAFFLE_PLATFORM, WAFFLE_PLATFORM_X11_EGL,
    0,
};

int
main()
{
    bool ok = waffle_init(init_attrib_list);
    if (ok)
        return EXIT_SUCCESS;
    else
        return EXIT_FAILURE;
}
]]>
    </programlisting>
  </refsect1>

  <xi:include href="common/issues.xml"/>

  <refsect1>
    <title>See Also</title>
    <para>
      <citerefentry><refentrytitle>waffle</refentrytitle><manvolnum>7</manvolnum></citerefentry>
    </para>
  </refsect1>

</refentry>

<!--
vim:tw=120 et ts=2 sw=2:
-->