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