'\" t
.\"     Title: waffle
.\"    Author: Chad Versace <chad.versace@linux.intel.com>
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/25/2021
.\"    Manual: Waffle Manual
.\"    Source: waffle
.\"  Language: English
.\"
.TH "WAFFLE" "7" "03/25/2021" "waffle" "Waffle Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
waffle \- a library for selecting an OpenGL API and window system at runtime
.SH "SYNOPSIS"
.sp
.nf
#include <waffle\&.h>

Link with \-lwaffle\-1\&.
    
.fi
.SH "DESCRIPTION"
.PP
Waffle is a cross\-platform library that allows one to defer selection of an OpenGL 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\&.
.PP
Waffle\*(Aqs immediate goal is to enable
\m[blue]\fBPiglit\fR\m[]\&\s-2\u[1]\d\s+2,
\m[blue]\fBMesa\fR\m[]\&\s-2\u[2]\d\s+2\*(Aqs OpenGL test suite, to test multiple OpenGL flavors in a cross\-platform way, and to allow each Piglit test to choose its OpenGL API and window system at runtime\&. A future goal is to enable the ability to record, with another tool such as
\m[blue]\fBAPITrace\fR\m[]\&\s-2\u[3]\d\s+2, an application\*(Aqs OpenGL calls on one operating system or window system, and then replay that trace on a different system\&.
.PP
\m[blue]\fBwaffle\fR\m[]\&\s-2\u[4]\d\s+2\*(Aqs website\&.
.SH "EXAMPLES"
.PP
Your distribution should have installed example source code that demonstrates how to use waffle at
/usr/share/doc/waffle\-${version}/examples\&. You can also find
\m[blue]\fBexamples\fR\m[]\&\s-2\u[5]\d\s+2
in Waffle\*(Aqs source repository\&.
.SH "ISSUES"
.PP
Please report bugs or and feature requests to
\m[blue]\fB\%https://gitlab.freedesktop.org/mesa/waffle/issues\fR\m[]\&.
.SH "SEE ALSO"
.PP
.RS 4
Website: http://www\&.waffle\-gl\&.org
.RE
.RS 4
Source: https://gitlab\&.freedesktop\&.org/mesa/waffle
.RE
.PP
.RS 4
\fBwaffle_feature_test_macros\fR(7)
.RE
.PP
.RS 4
\fBwaffle_attrib_list\fR(3),
.RE
.RS 4
\fBwaffle_config\fR(3),
.RE
.RS 4
\fBwaffle_context\fR(3),
.RE
.RS 4
\fBwaffle_display\fR(3),
.RE
.RS 4
\fBwaffle_dl\fR(3),
.RE
.RS 4
\fBwaffle_enum\fR(3),
.RE
.RS 4
\fBwaffle_error\fR(3),
.RE
.RS 4
\fBwaffle_gbm\fR(3),
.RE
.RS 4
\fBwaffle_get_proc_address\fR(3),
.RE
.RS 4
\fBwaffle_glx\fR(3),
.RE
.RS 4
\fBwaffle_init\fR(3),
.RE
.RS 4
\fBwaffle_is_extension_in_string\fR(3),
.RE
.RS 4
\fBwaffle_make_current\fR(3),
.RE
.RS 4
\fBwaffle_native\fR(3),
.RE
.RS 4
\fBwaffle_wayland\fR(3),
.RE
.RS 4
\fBwaffle_window\fR(3),
.RE
.RS 4
\fBwaffle_x11_egl\fR(3)
.RE
.RS 4
\fBwflinfo\fR(1),
.RE
.SH "AUTHOR"
.PP
\fBChad Versace\fR <\&chad\&.versace@linux\&.intel\&.com\&>
.RS 4
Maintainer
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2013 Intel
.br
.PP
This manual page is licensed under the Creative Commons Attribution\-ShareAlike 3\&.0 United States License (CC BY\-SA 3\&.0)\&. To view a copy of this license, visit
\m[blue]\fB\%http://creativecommons.org.license/by-sa/3.0/us\fR\m[]\&.
.sp
.SH "NOTES"
.IP " 1." 4
Piglit
.RS 4
\%http://piglit.freedesktop.org
.RE
.IP " 2." 4
Mesa
.RS 4
\%http://mesa3d.org
.RE
.IP " 3." 4
APITrace
.RS 4
\%http://github.com/apitrace/apitrace#readme
.RE
.IP " 4." 4
waffle
.RS 4
\%http://www.waffle-gl.org
.RE
.IP " 5." 4
examples
.RS 4
\%https://gitlab.freedesktop.org/mesa/waffle/tree/master/examples
.RE