blob: 0541f20eeb817a6f5fb5a7ac881285afd695d497 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglCopyBuffers">
<info>
<copyright>
<year>2003-2014</year>
<holder>The Khronos Group Inc.</holder>
</copyright>
</info>
<refmeta>
<refentrytitle>eglCopyBuffers</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>eglCopyBuffers</refname>
<refpurpose>
copy <acronym>EGL</acronym> surface color buffer to a native pixmap
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>EGLBoolean <function>eglCopyBuffers</function></funcdef>
<paramdef>EGLDisplay <parameter>display</parameter></paramdef>
<paramdef>EGLSurface <parameter>surface</parameter></paramdef>
<paramdef>NativePixmapType <parameter>native_pixmap</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 xml:id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>display</parameter></term>
<listitem>
<para>
Specifies the EGL display connection.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>surface</parameter></term>
<listitem>
<para>
Specifies the EGL surface whose color buffer is to be copied.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>native_pixmap</parameter></term>
<listitem>
<para>
Specifies the native pixmap as target of the copy.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 xml:id="description"><title>Description</title>
<para>
<function>eglCopyBuffers</function> copies the color buffer of
<parameter>surface</parameter> to <parameter>native_pixmap</parameter>.
</para>
<para>
<function>eglCopyBuffers</function> performs an implicit
<citerefentry><refentrytitle>glFlush</refentrytitle></citerefentry>
before it returns. Subsequent
GL commands may be issued immediately after calling
<function>eglCopyBuffers</function>,
but are not executed until copying of the color buffer is completed.
</para>
</refsect1>
<refsect1 xml:id="notes"><title>Notes</title>
<para>
The color buffer of <parameter>surface</parameter> is left unchanged
after calling <function>eglCopyBuffers</function>.
</para>
</refsect1>
<refsect1 xml:id="errors"><title>Errors</title>
<para>
<constant>EGL_FALSE</constant> is returned if swapping of the
surface buffers fails, <constant>EGL_TRUE</constant> otherwise.
</para>
<para>
<constant>EGL_BAD_DISPLAY</constant> is generated if
<parameter>display</parameter> is not an EGL display connection.
</para>
<para>
<constant>EGL_NOT_INITIALIZED</constant> is generated if
<parameter>display</parameter> has not been initialized.
</para>
<para>
<constant>EGL_BAD_SURFACE</constant> is generated if
<parameter>surface</parameter> is not an EGL drawing surface.
</para>
<para>
<constant>EGL_BAD_NATIVE_PIXMAP</constant> is generated if
the implementation does not support native pixmaps.
</para>
<para>
<constant>EGL_BAD_NATIVE_PIXMAP</constant> may be generated if
<parameter>native_pixmap</parameter> is not a valid native pixmap.
</para>
<para>
<constant>EGL_BAD_MATCH</constant> is generated if
the format of <parameter>native_pixmap</parameter> is not compatible
with the color buffer of <parameter>surface</parameter>.
</para>
<para>
<constant>EGL_CONTEXT_LOST</constant> is generated if a power management
event has occurred. The application must destroy all contexts and
reinitialise OpenGL ES state and objects to continue rendering.
</para>
</refsect1>
<refsect1 xml:id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glFlush</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>eglSwapBuffers</refentrytitle></citerefentry>
</para>
</refsect1>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/>
</refentry>
|
