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