• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglQueryString">
2    <info>
3         <copyright>
4             <year>2003-2014</year>
5             <holder>The Khronos Group Inc.</holder>
6         </copyright>
7    </info>
8    <refmeta>
9        <refentrytitle>eglQueryString</refentrytitle>
10        <manvolnum>3G</manvolnum>
11    </refmeta>
12    <refnamediv>
13        <refname>eglQueryString</refname>
14        <refpurpose>
15            return a string describing an <acronym>EGL</acronym> display connection
16        </refpurpose>
17    </refnamediv>
18    <refsynopsisdiv>
19        <title>C Specification</title>
20        <funcsynopsis>
21            <funcprototype>
22                <funcdef>char const * <function>eglQueryString</function></funcdef>
23                <paramdef>EGLDisplay <parameter>display</parameter></paramdef>
24                <paramdef>EGLint <parameter>name</parameter></paramdef>
25            </funcprototype>
26        </funcsynopsis>
27    </refsynopsisdiv>
28    <refsect1 xml:id="parameters"><title>Parameters</title>
29        <variablelist>
30            <varlistentry>
31                <term><parameter>display</parameter></term>
32                <listitem>
33                    <para>
34                        Specifies the EGL display connection.
35                    </para>
36                </listitem>
37            </varlistentry>
38            <varlistentry>
39                <term><parameter>name</parameter></term>
40                <listitem>
41                    <para>
42                        Specifies a symbolic constant, one of
43                        <constant>EGL_CLIENT_APIS</constant>,
44                        <constant>EGL_VENDOR</constant>,
45                        <constant>EGL_VERSION</constant>, or
46                        <constant>EGL_EXTENSIONS</constant>.
47                    </para>
48                </listitem>
49            </varlistentry>
50        </variablelist>
51    </refsect1>
52    <refsect1 xml:id="description"><title>Description</title>
53        <para>
54            <function>eglQueryString</function> returns a pointer to a
55            static string describing an EGL display connection.
56            <parameter>name</parameter> can be one of the following:
57        </para>
58        <variablelist>
59            <varlistentry>
60                <term><constant>EGL_CLIENT_APIS</constant></term>
61                <listitem><para>
62                    Returns a string describing which client rendering
63                    APIs are supported. The string contains a
64                    space-separate list of API names. The list must
65                    include at least one of <code>OpenGL</code>,
66                    <code>OpenGL_ES</code>, or <code>OpenVG</code>.
67                    These strings correspond respectively to values
68                    <constant>EGL_OPENGL_API</constant>,
69                    <constant>EGL_OPENGL_ES_API</constant>, and
70                    <constant>EGL_OPENVG_API</constant> of the
71                    <citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry>,
72                    <parameter>api</parameter> argument.
73                </para></listitem>
74            </varlistentry>
75            <varlistentry>
76                <term><constant>EGL_VENDOR</constant></term>
77                <listitem><para>
78                    Returns the company responsible for this EGL implementation. This
79                    name does not change from release to release.
80                </para></listitem>
81            </varlistentry>
82            <varlistentry>
83                <term><constant>EGL_VERSION</constant></term>
84                <listitem><para>
85                    Returns a version or release number.
86                    The <constant>EGL_VERSION</constant> string is laid out as
87                    follows:</para>
88                <para>
89                    <replaceable>major_version</replaceable>.<replaceable>minor_version</replaceable>
90                    space
91                    <replaceable>vendor_specific_info</replaceable>
92                </para></listitem>
93            </varlistentry>
94            <varlistentry>
95                <term><constant>EGL_EXTENSIONS</constant></term>
96                <listitem><para>
97                    Returns a space separated list of supported extensions to EGL.
98                </para></listitem>
99            </varlistentry>
100        </variablelist>
101    </refsect1>
102    <refsect1 xml:id="notes"><title>Notes</title>
103        <para>
104            <constant>EGL_CLIENT_APIS</constant> is supported only if
105            the EGL version is 1.2 or greater.
106        </para>
107    </refsect1>
108    <refsect1 xml:id="errors"><title>Errors</title>
109        <para>
110            <constant>NULL</constant> is returned on failure.
111        </para>
112        <para>
113            <constant>EGL_BAD_DISPLAY</constant> is generated if
114            <parameter>display</parameter> is not an EGL display connection.
115        </para>
116        <para>
117            <constant>EGL_NOT_INITIALIZED</constant> is generated if
118            <parameter>display</parameter> has not been initialized.
119        </para>
120        <para>
121            <constant>EGL_BAD_PARAMETER</constant> is generated if
122            <parameter>name</parameter> is not an accepted value.
123        </para>
124    </refsect1>
125    <refsect1 xml:id="seealso"><title>See Also</title>
126        <para>
127            <citerefentry><refentrytitle>eglBindAPI</refentrytitle></citerefentry>,
128            <citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry>,
129            <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry>
130        </para>
131    </refsect1>
132    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/>
133</refentry>
134