• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglGetCurrentDisplay">
2    <info>
3         <copyright>
4             <year>2003-2018</year>
5             <holder>The Khronos Group Inc.</holder>
6         </copyright>
7    </info>
8    <refmeta>
9        <refentrytitle>eglGetCurrentDisplay</refentrytitle>
10        <manvolnum>3G</manvolnum>
11    </refmeta>
12    <refnamediv>
13        <refname>eglGetCurrentDisplay</refname>
14        <refpurpose>
15            return the display for the current <acronym>EGL</acronym> rendering context
16        </refpurpose>
17    </refnamediv>
18    <refsynopsisdiv>
19        <title>C Specification</title>
20        <funcsynopsis>
21            <funcprototype>
22                <funcdef>EGLDisplay <function>eglGetCurrentDisplay</function></funcdef>
23                <void/>
24            </funcprototype>
25        </funcsynopsis>
26    </refsynopsisdiv>
27    <refsect1 xml:id="description"><title>Description</title>
28        <para>
29            <function>eglGetCurrentDisplay</function> returns the current
30            <acronym>EGL</acronym> display connection for the current
31            <acronym>EGL</acronym> rendering context, as specified by
32            <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>.
33            If no context is current, <constant>EGL_NO_DISPLAY</constant> is returned.
34        </para>
35    </refsect1>
36    <refsect1 xml:id="errors"><title>Errors</title>
37        <para>
38            Passing <constant>EGL_NO_DISPLAY</constant> to any command
39            taking an <type>EGLDisplay</type> parameter will generate either
40            an <constant>EGL_BAD_DISPLAY</constant> error if the EGL
41            implementation validates <type>EGLDisplay</type> handles, or
42            undefined behavior as described at the end of section 3.1 of the
43            EGL 1.5 Specification. The only exception to this rule is that
44            <function>eglQueryString</function> will accept an
45            <type>EGLDisplay</type> parameter of
46            <constant>EGL_NO_DISPLAY</constant> when querying the client
47            extension string (see section 3.3 of the EGL 1.5 Specification).
48        </para>
49    </refsect1>
50    <refsect1 xml:id="seealso"><title>See Also</title>
51        <para>
52            <citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry>,
53            <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry>,
54            <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>    </para>
55    </refsect1>
56    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/>
57</refentry>
58