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