• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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="eglReleaseTexImage">
5    <refentryinfo>
6         <copyright>
7             <year>2003-2014</year>
8             <holder>The Khronos Group Inc.</holder>
9         </copyright>
10    </refentryinfo>
11    <refmeta>
12        <refentrytitle>eglReleaseTexImage</refentrytitle>
13        <manvolnum>3G</manvolnum>
14    </refmeta>
15    <refnamediv>
16        <refname>eglReleaseTexImage</refname>
17        <refpurpose>
18            Releases a color buffer that is being used as a texture
19        </refpurpose>
20    </refnamediv>
21    <refsynopsisdiv>
22        <title>C Specification</title>
23        <funcsynopsis>
24            <funcprototype>
25                <funcdef>EGLBoolean <function>eglReleaseTexImage</function></funcdef>
26                <paramdef>EGLDisplay <parameter>display</parameter></paramdef>
27                <paramdef>EGLSurface <parameter>surface</parameter></paramdef>
28                <paramdef>EGLint <parameter>buffer</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><para>Specifies the EGL display connection.</para></listitem>
37            </varlistentry>
38            <varlistentry>
39                <term><parameter>surface</parameter></term>
40                <listitem>
41                    <para>
42                        Specifies the EGL surface.
43                    </para>
44                </listitem>
45            </varlistentry>
46            <varlistentry>
47                <term><parameter>buffer</parameter></term>
48                <listitem><para>Specifies the texture image data.</para></listitem>
49            </varlistentry>
50        </variablelist>
51    </refsect1>
52    <refsect1 id="description"><title>Description</title>
53        <para>
54            The specified color buffer is released back to the surface. The surface is made
55            available for reading and writing when it no longer has any color buffers bound as
56            textures.
57        </para>
58    </refsect1>
59    <refsect1 id="notes"><title>Notes</title>
60        <para>
61            If the specified color buffer is no longer bound to a texture (e.g., because the
62            texture object was deleted) then eglReleaseTexImage has no effect. No error is
63            generated.
64        </para>
65        <para>
66            The contents of the color buffer are undefined when it is first released. In particular,
67            there is no guarantee that the texture image is still present. However, the contents of
68            other color buffers are unaffected by this call. Also, the contents of the depth and stencil buffers
69            are not affected by <citerefentry><refentrytitle>eglBindTexImage</refentrytitle></citerefentry>
70            and <function>eglReleaseTexImage</function>.
71        </para>
72        <para>
73            After a color buffer is released from a texture (either explicitly by calling
74            <function>eglReleaseTexImage</function> or implicitly by calling a routine such as
75            <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>),
76            all texture images that were defined by the color buffer become <constant>NULL</constant>
77            (it is as if <citerefentry><refentrytitle>glTexImage</refentrytitle></citerefentry> was called with an image of zero width).
78        </para>
79    </refsect1>
80    <refsect1 id="errors"><title>Errors</title>
81        <para>
82            <constant>EGL_BAD_MATCH</constant> is generated if the
83            surface attribute <constant>EGL_TEXTURE_FORMAT</constant> is
84            set to <constant>EGL_NO_TEXTURE</constant>.
85        </para>
86        <para>
87            <constant>EGL_BAD_MATCH</constant> is generated if
88            <parameter>buffer</parameter> is not a valid buffer
89            (currently only <constant>EGL_BACK_BUFFER</constant> may be
90            specified).
91        </para>
92        <para>
93            <constant>EGL_BAD_SURFACE</constant> is generated if
94            <parameter>surface</parameter> is not an EGL surface, or is
95            not a bound pbuffer surface.
96        </para>
97    </refsect1>
98    <refsect1 id="seealso"><title>See Also</title>
99        <para>
100            <citerefentry><refentrytitle>eglBindTexImage</refentrytitle></citerefentry>
101        </para>
102    </refsect1>
103    <refsect3 id="Copyright"><title></title>
104        <!-- Content included from copyright.inc.xsl -->
105        <imageobject>
106                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
107        </imageobject>
108        <para />
109    </refsect3>
110</refentry>
111