Return to eglCopyBuffers.xml CVS log

Up to [Development] / projects / ogl-sample / main / doc / gles / xml

OpenGL ES 1.0 and EGL 1.0 reference manual and man pages (written by
Claude Knaus, based on OpenGL SI man pages).

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.2//EN" "DTD/docbook/docbookx.dtd">

<!--
  License Applicability. Except to the extent portions of this file are
  made subject to an alternative license as permitted in the SGI Free
  Software License B, Version 1.1 (the "License"), the contents of this
  file are subject only to the provisions of the License. You may not use
  this file except in compliance with the License. You may obtain a copy
  of the License at Silicon Graphics, Inc., attn: Legal Services, 1600
  Amphitheatre Parkway, Mountain View, CA 94043-1351, or at:

  http://oss.sgi.com/projects/FreeB

  Note that, as provided in the License, the Software is distributed on an
  "AS IS" basis, with ALL EXPRESS AND IMPLIED WARRANTIES AND CONDITIONS
  DISCLAIMED, INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTIES AND
  CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY, FITNESS FOR A
  PARTICULAR PURPOSE, AND NON-INFRINGEMENT.

  Original Code. The Original Code is: OpenGL ES Reference Manual,
  Version 1.0, released September 2003, developed by Silicon Graphics,
  Inc.  The Original Code is Copyright (c) 2003 Silicon Graphics, Inc.
  Copyright in any portions created by third parties is as indicated
  elsewhere herein.  All Rights Reserved.
-->

<refentry id="eglCopyBuffers">

  <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>
    <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>
    <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>
    <title>Notes</title>

    <para>
      The color buffer of <parameter>surface</parameter> is left unchanged
      after calling <function>eglCopyBuffers</function>.
    </para>
  </refsect1>

  <refsect1>
    <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>
  </refsect1>

  <refsect1>
    <title>See Also</title>

    <para>
      <citerefentry><refentrytitle>glFlush</refentrytitle></citerefentry>,
      <citerefentry><refentrytitle>eglSwapBuffers</refentrytitle></citerefentry>
    </para>
  </refsect1>

</refentry>