'\" t
.\"     Title: waffle_dl
.\"    Author: Chad Versace <chad.versace@linux.intel.com>
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 05/03/2021
.\"    Manual: Waffle Manual
.\"    Source: waffle
.\"  Language: English
.\"
.TH "WAFFLE_DL" "3" "05/03/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_dl, waffle_dl_can_open, waffle_dl_sym \- platform\-independent interface to dynamic libraries
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include <waffle\&.h>
.fi
.ft
.HP \w'bool\ waffle_dl_can_open('u
.BI "bool waffle_dl_can_open(int32_t\ " "dl" ");"
.HP \w'void*\ waffle_dl_sym('u
.BI "void* waffle_dl_sym(int32_t\ " "dl" ", const\ char*\ " "symbol" ");"
.SH "DESCRIPTION"
.PP
The waffle_dl functions provide a platform\-independent interface for dynamic OpenGL libraries\&. For each function, the parameter
\fIdl\fR
must be one of:
.RS 4
\fBWAFFLE_DL_OPENGL\fR
.RE
.RS 4
\fBWAFFLE_DL_OPENGL_ES1\fR
.RE
.RS 4
\fBWAFFLE_DL_OPENGL_ES2\fR
.RE
.RS 4
\fBWAFFLE_DL_OPENGL_ES3\fR
.RE
.PP
For example, on Linux, the
\fBWAFFLE_DL_*\fR
enums map to
libGL\&.so\&.1,
libGLESv1_CM\&.so\&.1,
libGLESv2\&.so\&.2, and
libGLESv2\&.so\&.2, respectively\&.
.PP
\fBwaffle_dl_can_open()\fR
.RS 4
Test if a dynamic library can be opened\&.
.RE
.PP
\fBwaffle_dl_sym()\fR
.RS 4
Get a
\fIsymbol\fR
from a dynamic library\&.
.RE
.SH "RETURN VALUE"
.PP
Functions whose return type is
\fBbool\fR
return true on success and false on failure\&. Functions whose return type is a pointer return
\fBNULL\fR
on failure\&. Use
\fBwaffle_error_get_info\fR(3)
to get information about any errors\&.
.SH "ERRORS"
.PP
If waffle fails to find the requested library on the system, then
\fBWAFFLE_ERROR_UNSUPPORTED_ON_PLATFORM\fR
is emitted\&.
.PP
See
\fBwaffle_error\fR(3)
for the complete list of waffle\*(Aqs error codes\&.
.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
\fBwaffle\fR(7),
\fBwaffle_get_proc_address\fR(3)
.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