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
|
<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/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"
xmlns:xi="http://www.w3.org/2001/XInclude">
<!-- See http://www.docbook.org/tdg/en/html/refentry.html. -->
<refmeta>
<refentrytitle>waffle</refentrytitle>
<manvolnum>7</manvolnum>
</refmeta>
<refnamediv>
<refname>waffle</refname>
<refpurpose>a library for selecting GL API and window system at runtime</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>
<synopsis>
#include <waffle.h>
Link with -lwaffle-1.
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Waffle is a cross-platform library that allows one to defer selection of GL API and of window system until
runtime. For example, on Linux, Waffle enables an application to select X11/EGL with an OpenGL 3.3 core profile,
Wayland with OpenGL ES2, and other window system / API combinations.
</para>
<para>
Waffle's immediate goal is to enable
<ulink url="http://cgit.freedesktop.org/piglit/tree/README">Piglit</ulink>,
<ulink url="http://mesa3d.org">Mesa</ulink>'s OpenGL test suite,
to test multiple GL flavors in a cross-platform way, and to allow each Piglit test to choose its GL API and window
system at runtime. A future goal is to enable the ability to record,
with another tool such as <ulink url="http://github.com/apitrace/apitrace#readme">APITrace</ulink>,
an application's GL calls on one operating system or window system, and then replay that trace on a different
system.
</para>
<para>
<ulink url="http://people.freedesktop.org/~chadversary/waffle">waffle</ulink>'s website.
</para>
</refsect1>
<refsect1>
<title>Examples</title>
<para>
Your distribution should have installed
example source code that demonstrates how to use waffle at
<filename>/usr/share/doc/waffle-${version}/examples</filename>.
You can also find example code on
<ulink url="http://people.freedesktop.org/~chadversary/waffle">waffle</ulink>'s website.
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<simplelist>
<member>Website: http://people.freedesktop.org/~chadversary/waffle</member>
<member>Source: git://people.freedesktop.org/~chadversary/waffle.git</member>
</simplelist>
</para>
<para>
<simplelist>
<member><citerefentry><refentrytitle>waffle_feature_test_macros</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
</simplelist>
</para>
<para>
<simplelist>
<member><citerefentry><refentrytitle>waffle_attrib_list</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
<member><citerefentry><refentrytitle>waffle_config</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
<member><citerefentry><refentrytitle>waffle_context</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
<member><citerefentry><refentrytitle>waffle_display</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
<member><citerefentry><refentrytitle>waffle_dl</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
<member><citerefentry><refentrytitle>waffle_enum</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
<member><citerefentry><refentrytitle>waffle_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
<member><citerefentry><refentrytitle>waffle_gbm</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
<member><citerefentry><refentrytitle>waffle_get_proc_address</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
<member><citerefentry><refentrytitle>waffle_glx</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
<member><citerefentry><refentrytitle>waffle_init</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
<member><citerefentry><refentrytitle>waffle_is_extension_in_string</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
<member><citerefentry><refentrytitle>waffle_make_current</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
<member><citerefentry><refentrytitle>waffle_native</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
<member><citerefentry><refentrytitle>waffle_wayland</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
<member><citerefentry><refentrytitle>waffle_window</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
<member><citerefentry><refentrytitle>waffle_x11_egl</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>wflinfo</refentrytitle><manvolnum>1</manvolnum></citerefentry>,</member>
</simplelist>
</para>
</refsect1>
</refentry>
<!--
vim:tw=120 et ts=2 sw=2:
-->
|
