man/waffle.7.xml

   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">
   4
   5 <!--
   6   Copyright Intel 2012 - 2014
   7
   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 -->
  11
  12 <refentry
  13     id="waffle"
  14     xmlns:xi="http://www.w3.org/2001/XInclude">
  15
  16   <!-- See http://www.docbook.org/tdg/en/html/refentry.html. -->
  17
  18   <refmeta>
  19     <refentrytitle>waffle</refentrytitle>
  20     <manvolnum>7</manvolnum>
  21   </refmeta>
  22
  23   <refnamediv>
  24     <refname>waffle</refname>
  25     <refpurpose>a library for selecting an OpenGL API and window system at runtime</refpurpose>
  26   </refnamediv>
  27
  28   <refentryinfo>
  29     <title>Waffle Manual</title>
  30     <productname>waffle</productname>
  31     <xi:include href="common/author-lina.versace.xml"/>
  32     <xi:include href="common/copyright.xml"/>
  33     <xi:include href="common/legalnotice.xml"/>
  34   </refentryinfo>
  35
  36   <refsynopsisdiv>
  37     <synopsis>
  38 #include &lt;waffle.h&gt;
  39
  40 Link with -lwaffle-1.
  41     </synopsis>
  42   </refsynopsisdiv>
  43
  44   <refsect1>
  45     <title>Description</title>
  46
  47     <para>
  48       Waffle is a cross-platform library that allows one to defer selection of an OpenGL API and of window system until
  49       runtime. For example, on Linux, Waffle enables an application to select X11/EGL with an OpenGL 3.3 core profile,
  50       Wayland with OpenGL ES2, and other window system / API combinations.
  51     </para>
  52
  53     <para>
  54       Waffle's immediate goal is to enable
  55       <ulink url="http://piglit.freedesktop.org">Piglit</ulink>,
  56       <ulink url="http://mesa3d.org">Mesa</ulink>'s OpenGL test suite,
  57       to test multiple OpenGL flavors in a cross-platform way, and to allow each Piglit test to choose its OpenGL API
  58       and window system at runtime. A future goal is to enable the ability to record,
  59       with another tool such as <ulink url="http://github.com/apitrace/apitrace#readme">APITrace</ulink>,
  60       an application's OpenGL calls on one operating system or window system, and then replay that trace on a
  61       different system.
  62     </para>
  63
  64     <para>
  65       <ulink url="https://waffle.freedesktop.org">waffle</ulink>'s website.
  66     </para>
  67
  68   </refsect1>
  69
  70   <refsect1>
  71     <title>Examples</title>
  72
  73     <para>
  74       Your distribution should have installed
  75       example source code that demonstrates how to use waffle at
  76       <filename>/usr/share/doc/waffle-${version}/examples</filename>.
  77       You can also find
  78       <ulink url="https://gitlab.freedesktop.org/mesa/waffle/tree/master/examples">examples</ulink>
  79       in Waffle's source repository.
  80     </para>
  81
  82   </refsect1>
  83
  84   <xi:include href="common/issues.xml"/>
  85
  86   <refsect1>
  87     <title>See Also</title>
  88
  89     <para>
  90       <simplelist>
  91         <member>Website: https://waffle.freedesktop.org/</member>
  92         <member>Source: https://gitlab.freedesktop.org/mesa/waffle</member>
  93       </simplelist>
  94     </para>
  95
  96     <para>
  97       <simplelist>
  98         <member><citerefentry><refentrytitle>waffle_feature_test_macros</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
  99       </simplelist>
 100     </para>
 101
 102     <para>
 103       <simplelist>
 104         <member><citerefentry><refentrytitle>waffle_attrib_list</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
 105         <member><citerefentry><refentrytitle>waffle_config</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
 106         <member><citerefentry><refentrytitle>waffle_context</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
 107         <member><citerefentry><refentrytitle>waffle_display</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
 108         <member><citerefentry><refentrytitle>waffle_dl</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
 109         <member><citerefentry><refentrytitle>waffle_enum</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
 110         <member><citerefentry><refentrytitle>waffle_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
 111         <member><citerefentry><refentrytitle>waffle_gbm</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
 112         <member><citerefentry><refentrytitle>waffle_get_proc_address</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
 113         <member><citerefentry><refentrytitle>waffle_glx</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
 114         <member><citerefentry><refentrytitle>waffle_init</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
 115         <member><citerefentry><refentrytitle>waffle_is_extension_in_string</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
 116         <member><citerefentry><refentrytitle>waffle_make_current</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
 117         <member><citerefentry><refentrytitle>waffle_native</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
 118         <member><citerefentry><refentrytitle>waffle_wayland</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
 119         <member><citerefentry><refentrytitle>waffle_window</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member>
 120         <member><citerefentry><refentrytitle>waffle_x11_egl</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
 121         <member><citerefentry><refentrytitle>wflinfo</refentrytitle><manvolnum>1</manvolnum></citerefentry>,</member>
 122       </simplelist>
 123     </para>
 124   </refsect1>
 125
 126 </refentry>
 127
 128 <!--
 129 vim:tw=120 et ts=2 sw=2:
 130 -->