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