1<?xml version="1.0" encoding="UTF-8" standalone="no"?> 2<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <title xmlns:xlink="http://www.w3.org/1999/xlink">eglCopyBuffers - EGL Reference Pages</title> 5 <link rel="stylesheet" type="text/css" href="khronos-man.css"/> 6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> 7 </head> 8 <body> 9 <header/> 10 <div class="refentry" id="eglCopyBuffers"> 11 <div class="titlepage"/> 12 <div class="refnamediv"> 13 <h2>Name</h2> 14 <p>eglCopyBuffers — 15 copy <abbr class="acronym">EGL</abbr> surface color buffer to a native pixmap 16 </p> 17 </div> 18 <div class="refsynopsisdiv"> 19 <h2>C Specification</h2> 20 <div class="funcsynopsis"> 21 <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> 22 <tr> 23 <td> 24 <code class="funcdef">EGLBoolean <strong class="fsfunc">eglCopyBuffers</strong>(</code> 25 </td> 26 <td>EGLDisplay <var class="pdparam">display</var>, </td> 27 </tr> 28 <tr> 29 <td> </td> 30 <td>EGLSurface <var class="pdparam">surface</var>, </td> 31 </tr> 32 <tr> 33 <td> </td> 34 <td>NativePixmapType <var class="pdparam">native_pixmap</var><code>)</code>;</td> 35 </tr> 36 </table> 37 <div class="funcprototype-spacer"> </div> 38 </div> 39 </div> 40 <div class="refsect1" id="parameters"> 41 <h2>Parameters</h2> 42 <div class="variablelist"> 43 <dl class="variablelist"> 44 <dt> 45 <span class="term"> 46 <em class="parameter"> 47 <code>display</code> 48 </em> 49 </span> 50 </dt> 51 <dd> 52 <p> 53 Specifies the EGL display connection. 54 </p> 55 </dd> 56 <dt> 57 <span class="term"> 58 <em class="parameter"> 59 <code>surface</code> 60 </em> 61 </span> 62 </dt> 63 <dd> 64 <p> 65 Specifies the EGL surface whose color buffer is to be copied. 66 </p> 67 </dd> 68 <dt> 69 <span class="term"> 70 <em class="parameter"> 71 <code>native_pixmap</code> 72 </em> 73 </span> 74 </dt> 75 <dd> 76 <p> 77 Specifies the native pixmap as target of the copy. 78 </p> 79 </dd> 80 </dl> 81 </div> 82 </div> 83 <div class="refsect1" id="description"> 84 <h2>Description</h2> 85 <p> 86 <code class="function">eglCopyBuffers</code> copies the color buffer of 87 <em class="parameter"><code>surface</code></em> to <em class="parameter"><code>native_pixmap</code></em>. 88 </p> 89 <p> 90 <code class="function">eglCopyBuffers</code> performs an implicit 91 <a class="citerefentry" href="glFlush.xhtml"><span class="citerefentry"><span class="refentrytitle">glFlush</span></span></a> 92 before it returns. Subsequent 93 GL commands may be issued immediately after calling 94 <code class="function">eglCopyBuffers</code>, 95 but are not executed until copying of the color buffer is completed. 96 </p> 97 </div> 98 <div class="refsect1" id="notes"> 99 <h2>Notes</h2> 100 <p> 101 The color buffer of <em class="parameter"><code>surface</code></em> is left unchanged 102 after calling <code class="function">eglCopyBuffers</code>. 103 </p> 104 </div> 105 <div class="refsect1" id="errors"> 106 <h2>Errors</h2> 107 <p> 108 <code class="constant">EGL_FALSE</code> is returned if swapping of the 109 surface buffers fails, <code class="constant">EGL_TRUE</code> otherwise. 110 </p> 111 <p> 112 <code class="constant">EGL_BAD_DISPLAY</code> is generated if 113 <em class="parameter"><code>display</code></em> is not an EGL display connection. 114 </p> 115 <p> 116 <code class="constant">EGL_NOT_INITIALIZED</code> is generated if 117 <em class="parameter"><code>display</code></em> has not been initialized. 118 </p> 119 <p> 120 <code class="constant">EGL_BAD_SURFACE</code> is generated if 121 <em class="parameter"><code>surface</code></em> is not an EGL drawing surface. 122 </p> 123 <p> 124 <code class="constant">EGL_BAD_NATIVE_PIXMAP</code> is generated if 125 the implementation does not support native pixmaps. 126 </p> 127 <p> 128 <code class="constant">EGL_BAD_NATIVE_PIXMAP</code> may be generated if 129 <em class="parameter"><code>native_pixmap</code></em> is not a valid native pixmap. 130 </p> 131 <p> 132 <code class="constant">EGL_BAD_MATCH</code> is generated if 133 the format of <em class="parameter"><code>native_pixmap</code></em> is not compatible 134 with the color buffer of <em class="parameter"><code>surface</code></em>. 135 </p> 136 <p> 137 <code class="constant">EGL_CONTEXT_LOST</code> is generated if a power management 138 event has occurred. The application must destroy all contexts and 139 reinitialise OpenGL ES state and objects to continue rendering. 140 </p> 141 </div> 142 <div class="refsect1" id="seealso"> 143 <h2>See Also</h2> 144 <p> 145 <a class="citerefentry" href="glFlush.xhtml"><span class="citerefentry"><span class="refentrytitle">glFlush</span></span></a>, 146 <a class="citerefentry" href="eglSwapBuffers.xhtml"><span class="citerefentry"><span class="refentrytitle">eglSwapBuffers</span></span></a> 147 </p> 148 </div> 149 <p> 150 </p> 151 <div class="refsect3" id="copyright"> 152 <img src="KhronosLogo.jpg"/> 153 <p> 154 Copyright © 2003-2014 The Khronos Group Inc. 155 Permission is hereby granted, free of charge, to any person obtaining a 156 copy of this software and/or associated documentation files (the 157 "Materials"), to deal in the Materials without restriction, including 158 without limitation the rights to use, copy, modify, merge, publish, 159 distribute, sublicense, and/or sell copies of the Materials, and to 160 permit persons to whom the Materials are furnished to do so, subject to 161 the condition that this copyright notice and permission notice shall be included 162 in all copies or substantial portions of the Materials. 163 </p> 164 </div> 165 <p> 166</p> 167 </div> 168 <footer/> 169 </body> 170</html> 171
