• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglQueryAPI">
2    <info>
3         <copyright>
4             <year>2003-2014</year>
5             <holder>The Khronos Group Inc.</holder>
6         </copyright>
7    </info>
8    <refmeta>
9        <refentrytitle>eglQueryAPI</refentrytitle>
10        <manvolnum>3G</manvolnum>
11    </refmeta>
12    <refnamediv>
13        <refname>eglQueryAPI</refname>
14        <refpurpose>Query the current rendering API</refpurpose>
15    </refnamediv>
16    <refsynopsisdiv><title>C Specification</title>
17        <funcsynopsis>
18            <funcprototype>
19                <funcdef>EGLenum <function>eglQueryAPI</function></funcdef>
20                <void/>
21            </funcprototype>
22        </funcsynopsis>
23    </refsynopsisdiv>
24    <refsect1 xml:id="description"><title>Description</title>
25        <para>
26            <function>eglQueryAPI</function> returns the value of the
27            current rendering API for EGL in the thread it is called
28            from. The current rendering API is set by
29            <citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry>,
30            and affects the behavior of other EGL commands.
31        </para>
32        <para>
33            The value returned will be one of the valid
34            <parameter>api</parameter> parameters to
35            <citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry>, or
36            <constant>EGL_NONE</constant>.
37        </para>
38    </refsect1>
39    <refsect1 xml:id="notes"><title>Notes</title>
40        <para>
41            <function>eglQueryAPI</function> is supported only if the
42            EGL version is 1.2 or greater.
43        </para>
44        <para>
45            The initial value of the current rendering API is
46            <constant>EGL_OPENGL_ES_API</constant> unless OpenGL ES is
47            not supported by an implementation, in which case the
48            initial value is <constant>EGL_NONE</constant> (however,
49            <constant>EGL_NONE</constant> is not a valid
50            <parameter>api</parameter> parameter to
51            <function>eglQueryAPI</function>).
52        </para>
53        <para>
54            The current rendering API can be changed by calling
55            <citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry>.
56        </para>
57    </refsect1>
58    <refsect1 xml:id="errors"><title>Errors</title>
59        <para>
60            None.
61        </para>
62    </refsect1>
63    <refsect1 xml:id="seealso"><title>See Also</title>
64        <para>
65            <citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry>,
66            <citerefentry><refentrytitle>eglCreateContext</refentrytitle></citerefentry>,
67            <citerefentry><refentrytitle>eglGetCurrentContext</refentrytitle></citerefentry>,
68            <citerefentry><refentrytitle>eglGetCurrentDisplay</refentrytitle></citerefentry>,
69            <citerefentry><refentrytitle>eglGetCurrentSurface</refentrytitle></citerefentry>,
70            <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>,
71            <citerefentry><refentrytitle>eglWaitClient</refentrytitle></citerefentry>,
72            <citerefentry><refentrytitle>eglWaitNative</refentrytitle></citerefentry>
73        </para>
74    </refsect1>
75    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/>
76</refentry>
77