File: waffle_get_proc_address.3.xml

package info (click to toggle)
waffle 1.6.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 3,092 kB
  • sloc: ansic: 19,173; xml: 2,906; cpp: 489; objc: 465; sh: 100; makefile: 20
file content (146 lines) | stat: -rw-r--r-- 4,577 bytes parent folder | download | duplicates (2)
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  "file:///usr/share/xml/docbook/schema/dtd/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_get_proc_address"
    xmlns:xi="http://www.w3.org/2001/XInclude">

  <!-- See http://www.docbook.org/tdg/en/html/refentry.html. -->

  <refmeta>
    <refentrytitle>waffle_get_proc_address</refentrytitle>
    <manvolnum>3</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>waffle_get_proc_address</refname>
    <refpurpose>Query address of OpenGL functions</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>

    <funcsynopsis language="C">

      <funcsynopsisinfo>
#include &lt;waffle.h&gt;
      </funcsynopsisinfo>

      <funcprototype>
        <funcdef>void* <function>waffle_get_proc_address</function></funcdef>
        <paramdef>const char *<parameter>name</parameter></paramdef>
      </funcprototype>

    </funcsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <variablelist>
      <varlistentry>
        <term><function>waffle_get_proc_address()</function></term>
        <listitem>
          <para>
            On GLX, this redirects to
            <citerefentry><refentrytitle><function>glXGetProcAddress</function></refentrytitle><manvolnum>3</manvolnum></citerefentry>.

            On EGL, this redirects to
            <citerefentry><refentrytitle><function>eglGetProcAddress</function></refentrytitle><manvolnum>3</manvolnum></citerefentry>.

            On CGL, this function returns <constant>NULL</constant>

            because there exists no <function>CGLGetProcAdress()</function>.

            On WGL, this redirects to
            <citerefentry><refentrytitle><function>wglGetProcAddress</function></refentrytitle><manvolnum>3</manvolnum></citerefentry>.
          </para>

          <para>
            Some aspects of this function's behavior are platform-specific and non-intuitive.

            For example,

            <itemizedlist>
              <listitem>
                <para>
                  If the queried function is not available,

                  <function>waffle_get_proc_address()</function> may return a non-null pointer.
                </para>
              </listitem>

              <listitem>
                <para>
                  If the queried function is statically exposed by the OpenGL library of a given API,

                  then <function>waffle_get_proc_address()</function> may return a <constant>NULL</constant>.
                </para>
              </listitem>

              <listitem>
                <para>
                  Under Windows (WGL) a current context must be available before executing the function.

                  Otherwise <function>waffle_get_proc_address()</function> may return a <constant>NULL</constant>.
                </para>
              </listitem>
            </itemizedlist>
          </para>

          <para>
            For details on this function's behavior,

            see the specification for the relevant platform:

            the <ulink url="http://www.opengl.org/registry/doc/glx1.4.pdf">GLX 1.4 Specification</ulink>

            the <ulink url="http://www.khronos.org/registry/egl/specs/eglspec.1.4.20110406.pdf">EGL 1.4 Specification</ulink>

            or the <ulink url="http://msdn.microsoft.com/en-gb/library/windows/desktop/dd374386(v=vs.85).aspx">MSDN article</ulink>.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Errors</title>

    <xi:include href="common/error-codes.xml"/>

    <para>
      No errors are specific to any functions listed in this manual page.
    </para>
  </refsect1>

  <xi:include href="common/issues.xml"/>

  <refsect1>
    <title>See Also</title>
    <para>
      <citerefentry><refentrytitle>waffle</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>waffle_dl_sym</refentrytitle><manvolnum>3</manvolnum></citerefentry>
    </para>
  </refsect1>

</refentry>

<!--
vim:tw=120 et ts=2 sw=2:
-->