• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglGetCurrentSurface">
2    <info>
3         <copyright>
4             <year>2003-2014</year>
5             <holder>The Khronos Group Inc.</holder>
6         </copyright>
7    </info>
8    <refmeta>
9        <refentrytitle>eglGetCurrentSurface</refentrytitle>
10        <manvolnum>3G</manvolnum>
11    </refmeta>
12    <refnamediv>
13        <refname>eglGetCurrentSurface</refname>
14        <refpurpose>
15            return the read or draw surface 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>EGLSurface <function>eglGetCurrentSurface</function></funcdef>
23                <paramdef>EGLint <parameter>readdraw</parameter></paramdef>
24            </funcprototype>
25        </funcsynopsis>
26    </refsynopsisdiv>
27    <refsect1 xml:id="parameters"><title>Parameters</title>
28        <variablelist>
29            <varlistentry>
30                <term><parameter>readdraw</parameter></term>
31                <listitem>
32                    <para>
33                        Specifies whether to return the read surface
34                        (<constant>EGL_READ</constant>) or the draw surface
35                        (<constant>EGL_DRAW</constant>).
36                    </para>
37                </listitem>
38            </varlistentry>
39        </variablelist>
40    </refsect1>
41    <refsect1 xml:id="description"><title>Description</title>
42        <para>
43            <function>eglGetCurrentSurface</function> returns the read or draw
44            surface attached to the current
45            <acronym>EGL</acronym> rendering context, as specified by
46            <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>.
47            If no context is current, <constant>EGL_NO_SURFACE</constant> is returned.
48        </para>
49    </refsect1>
50    <refsect1 xml:id="seealso"><title>See Also</title>
51        <para>
52            <citerefentry><refentrytitle>eglCreatePbufferSurface</refentrytitle></citerefentry>,
53            <citerefentry><refentrytitle>eglCreatePixmapSurface</refentrytitle></citerefentry>,
54            <citerefentry><refentrytitle>eglCreateWindowSurface</refentrytitle></citerefentry>,
55            <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>    </para>
56    </refsect1>
57    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/>
58</refentry>
59