'\" t
.\"     Title: waffle_get_proc_address
.\"    Author: Chad Versace <chad.versace@linux.intel.com>
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 10/21/2023
.\"    Manual: Waffle Manual
.\"    Source: waffle
.\"  Language: English
.\"
.TH "WAFFLE_GET_PROC_ADDR" "3" "10/21/2023" "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_get_proc_address \- Query address of OpenGL functions
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include <waffle\&.h>
      
.fi
.ft
.HP \w'void*\ waffle_get_proc_address('u
.BI "void* waffle_get_proc_address(const\ char\ *" "name" ");"
.SH "DESCRIPTION"
.PP
\fBwaffle_get_proc_address()\fR
.RS 4
On GLX, this redirects to
\fBglXGetProcAddress\fR(3)\&. On EGL, this redirects to
\fBeglGetProcAddress\fR(3)\&. On CGL, this function returns
\fBNULL\fR
because there exists no
\fBCGLGetProcAdress()\fR\&. On WGL, this redirects to
\fBwglGetProcAddress\fR(3)\&.
.sp
Some aspects of this function\*(Aqs behavior are platform\-specific and non\-intuitive\&. For example,
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
If the queried function is not available,
\fBwaffle_get_proc_address()\fR
may return a non\-null pointer\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
If the queried function is statically exposed by the OpenGL library of a given API, then
\fBwaffle_get_proc_address()\fR
may return a
\fBNULL\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Under Windows (WGL) a current context must be available before executing the function\&. Otherwise
\fBwaffle_get_proc_address()\fR
may return a
\fBNULL\fR\&.
.RE
.sp
For details on this function\*(Aqs behavior, see the specification for the relevant platform: the
\m[blue]\fBGLX 1\&.4 Specification\fR\m[]\&\s-2\u[1]\d\s+2
the
\m[blue]\fBEGL 1\&.4 Specification\fR\m[]\&\s-2\u[2]\d\s+2
or the
\m[blue]\fBMSDN article\fR\m[]\&\s-2\u[3]\d\s+2\&.
.RE
.SH "ERRORS"
.PP
See
\fBwaffle_error\fR(3)
for the complete list of waffle\*(Aqs error codes\&.
.PP
No errors are specific to any functions listed in this manual page\&.
.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_dl_sym\fR(3)
.SH "AUTHOR"
.PP
\fBChad Versace\fR <\&chad\&.versace@linux\&.intel\&.com\&>
.RS 4
Former 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
GLX 1.4 Specification
.RS 4
\%http://www.opengl.org/registry/doc/glx1.4.pdf
.RE
.IP " 2." 4
EGL 1.4 Specification
.RS 4
\%http://www.khronos.org/registry/egl/specs/eglspec.1.4.20110406.pdf
.RE
.IP " 3." 4
MSDN article
.RS 4
\%http://msdn.microsoft.com/en-gb/library/windows/desktop/dd374386(v=vs.85).aspx
.RE