• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
3              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
4<refentry xml:base="" id="eglQueryAPI">
5    <refentryinfo>
6         <copyright>
7             <year>2003-2014</year>
8             <holder>The Khronos Group Inc.</holder>
9         </copyright>
10    </refentryinfo>
11    <refmeta>
12        <refentrytitle>eglQueryAPI</refentrytitle>
13        <manvolnum>3G</manvolnum>
14    </refmeta>
15    <refnamediv>
16        <refname>eglQueryAPI</refname>
17        <refpurpose>Query the current rendering API</refpurpose>
18    </refnamediv>
19    <refsynopsisdiv><title>C Specification</title>
20        <funcsynopsis>
21            <funcprototype>
22                <funcdef>EGLenum <function>eglQueryAPI</function></funcdef>
23                <void/>
24            </funcprototype>
25        </funcsynopsis>
26    </refsynopsisdiv>
27    <refsect1 id="description"><title>Description</title>
28        <para>
29            <function>eglQueryAPI</function> returns the value of the
30            current rendering API for EGL in the thread it is called
31            from. The current rendering API is set by
32            <citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry>,
33            and affects the behavior of other EGL commands.
34        </para>
35        <para>
36            The value returned will be one of the valid
37            <parameter>api</parameter> parameters to
38            <citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry>, or
39            <constant>EGL_NONE</constant>.
40        </para>
41    </refsect1>
42    <refsect1 id="notes"><title>Notes</title>
43        <para>
44            <function>eglQueryAPI</function> is supported only if the
45            EGL version is 1.2 or greater.
46        </para>
47        <para>
48            The initial value of the current rendering API is
49            <constant>EGL_OPENGL_ES_API</constant> unless OpenGL ES is
50            not supported by an implementation, in which case the
51            initial value is <constant>EGL_NONE</constant> (however,
52            <constant>EGL_NONE</constant> is not a valid
53            <parameter>api</parameter> parameter to
54            <function>eglQueryAPI</function>).
55        </para>
56        <para>
57            The current rendering API can be changed by calling
58            <citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry>.
59        </para>
60    </refsect1>
61    <refsect1 id="errors"><title>Errors</title>
62        <para>
63            None.
64        </para>
65    </refsect1>
66    <refsect1 id="seealso"><title>See Also</title>
67        <para>
68            <citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry>,
69            <citerefentry><refentrytitle>eglCreateContext</refentrytitle></citerefentry>,
70            <citerefentry><refentrytitle>eglGetCurrentContext</refentrytitle></citerefentry>,
71            <citerefentry><refentrytitle>eglGetCurrentDisplay</refentrytitle></citerefentry>,
72            <citerefentry><refentrytitle>eglGetCurrentSurface</refentrytitle></citerefentry>,
73            <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>,
74            <citerefentry><refentrytitle>eglWaitClient</refentrytitle></citerefentry>,
75            <citerefentry><refentrytitle>eglWaitNative</refentrytitle></citerefentry>
76        </para>
77    </refsect1>
78    <refsect3 id="Copyright"><title></title>
79        <!-- Content included from copyright.inc.xsl -->
80        <imageobject>
81                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
82        </imageobject>
83        <para />
84    </refsect3>
85</refentry>
86