• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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">eglReleaseTexImage - 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="eglReleaseTexImage">
11      <div class="titlepage"/>
12      <div class="refnamediv">
13        <h2>Name</h2>
14        <p>eglReleaseTexImage —
15            Releases a color buffer that is being used as a texture
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">eglReleaseTexImage</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>EGLint <var class="pdparam">buffer</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>Specifies the EGL display connection.</p>
53            </dd>
54            <dt>
55              <span class="term">
56                <em class="parameter">
57                  <code>surface</code>
58                </em>
59              </span>
60            </dt>
61            <dd>
62              <p>
63                        Specifies the EGL surface.
64                    </p>
65            </dd>
66            <dt>
67              <span class="term">
68                <em class="parameter">
69                  <code>buffer</code>
70                </em>
71              </span>
72            </dt>
73            <dd>
74              <p>Specifies the texture image data.</p>
75            </dd>
76          </dl>
77        </div>
78      </div>
79      <div class="refsect1" id="description">
80        <h2>Description</h2>
81        <p>
82            The specified color buffer is released back to the surface. The surface is made
83            available for reading and writing when it no longer has any color buffers bound as
84            textures.
85        </p>
86      </div>
87      <div class="refsect1" id="notes">
88        <h2>Notes</h2>
89        <p>
90            If the specified color buffer is no longer bound to a texture (e.g., because the
91            texture object was deleted) then eglReleaseTexImage has no effect. No error is
92            generated.
93        </p>
94        <p>
95            The contents of the color buffer are undefined when it is first released. In particular,
96            there is no guarantee that the texture image is still present. However, the contents of
97            other color buffers are unaffected by this call. Also, the contents of the depth and stencil buffers
98            are not affected by <a class="citerefentry" href="eglBindTexImage.xhtml"><span class="citerefentry"><span class="refentrytitle">eglBindTexImage</span></span></a>
99            and <code class="function">eglReleaseTexImage</code>.
100        </p>
101        <p>
102            After a color buffer is released from a texture (either explicitly by calling
103            <code class="function">eglReleaseTexImage</code> or implicitly by calling a routine such as
104            <a class="citerefentry" href="glTexImage2D.xhtml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>),
105            all texture images that were defined by the color buffer become <code class="constant">NULL</code>
106            (it is as if <a class="citerefentry" href="glTexImage.xhtml"><span class="citerefentry"><span class="refentrytitle">glTexImage</span></span></a> was called with an image of zero width).
107        </p>
108      </div>
109      <div class="refsect1" id="errors">
110        <h2>Errors</h2>
111        <p>
112            <code class="constant">EGL_BAD_MATCH</code> is generated if the
113            surface attribute <code class="constant">EGL_TEXTURE_FORMAT</code> is
114            set to <code class="constant">EGL_NO_TEXTURE</code>.
115        </p>
116        <p>
117            <code class="constant">EGL_BAD_MATCH</code> is generated if
118            <em class="parameter"><code>buffer</code></em> is not a valid buffer
119            (currently only <code class="constant">EGL_BACK_BUFFER</code> may be
120            specified).
121        </p>
122        <p>
123            <code class="constant">EGL_BAD_SURFACE</code> is generated if
124            <em class="parameter"><code>surface</code></em> is not an EGL surface, or is
125            not a bound pbuffer surface.
126        </p>
127      </div>
128      <div class="refsect1" id="seealso">
129        <h2>See Also</h2>
130        <p>
131            <a class="citerefentry" href="eglBindTexImage.xhtml"><span class="citerefentry"><span class="refentrytitle">eglBindTexImage</span></span></a>
132        </p>
133      </div>
134      <p>
135    </p>
136      <div class="refsect3" id="copyright">
137        <img src="KhronosLogo.jpg"/>
138        <p>
139            Copyright © 2003-2014 The Khronos Group Inc.
140            Permission is hereby granted, free of charge, to any person obtaining a
141            copy of this software and/or associated documentation files (the
142            "Materials"), to deal in the Materials without restriction, including
143            without limitation the rights to use, copy, modify, merge, publish,
144            distribute, sublicense, and/or sell copies of the Materials, and to
145            permit persons to whom the Materials are furnished to do so, subject to
146            the condition that this copyright notice and permission notice shall be included
147            in all copies or substantial portions of the Materials.
148        </p>
149      </div>
150      <p>
151</p>
152    </div>
153    <footer/>
154  </body>
155</html>
156