/
glInvalidateFramebuffer.xhtml
193 lines (192 loc) · 8.87 KB
/
glInvalidateFramebuffer.xhtml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
<div class="refentry" id="glInvalidateFramebuffer">
<div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p>glInvalidateFramebuffer — Invalidate the contents of attachments within a framebuffer</p>
</div>
<div class="refsynopsisdiv">
<h2>C Specification</h2>
<div class="funcsynopsis">
<table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
<tr>
<td>
<code class="funcdef">void <strong class="fsfunc">glInvalidateFramebuffer</strong>(</code>
</td>
<td>GLenum <var class="pdparam">target</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLsizei <var class="pdparam">numAttachments</var>, </td>
</tr>
<tr>
<td> </td>
<td>const GLenum *<var class="pdparam">attachments</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer"> </div>
</div>
</div>
<div class="refsect1" id="parameters">
<h2>Parameters</h2>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<em class="parameter">
<code>target</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the target of the invalidate operation. Must be <code class="constant">GL_FRAMEBUFFER</code>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>numAttachments</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies how many attachments are supplied in the <em class="parameter"><code>attachments</code></em> list.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>attachments</code>
</em>
</span>
</dt>
<dd>
<p>
A list of <em class="parameter"><code>numAttachments</code></em> attachments to invalidate.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
<code class="function">glInvalidateFramebuffer</code> signals to the GL
that it need not preserve all pixels of a bound framebuffer
object. <em class="parameter"><code>attachments</code></em> contains a list of
<em class="parameter"><code>numAttachments</code></em> to be invalidated. If an
attachment is specified that does not exist in the bound
framebuffer, it is ignored.
</p>
<p>
If a framebuffer object is bound, then
<em class="parameter"><code>attachments</code></em> may contain
<code class="constant">GL_COLOR_ATTACHMENTi</code>,
<code class="constant">GL_DEPTH_ATTACHMENT</code>,
<code class="constant">GL_STENCIL_ATTACHMENT</code>, and/or
<code class="constant">GL_DEPTH_STENCIL_ATTACHMENT</code>. If the
framebuffer object is not complete,
<code class="function">glInvalidateFramebuffer</code> may be ignored.
</p>
<p>
If the default framebuffer is bound, then
<em class="parameter"><code>attachments</code></em> may contain
<code class="constant">GL_COLOR</code>, identifying the color buffer;
<code class="constant">GL_DEPTH</code>, identifying the depth buffer;
and/or <code class="constant">GL_STENCIL</code>, identifying the stencil
buffer.
</p>
</div>
<div class="refsect1" id="notes">
<h2>Notes</h2>
<p>
The intention of this function is to provide a hint to the GL
implementation that there is no longer a need to preserve the
contents of particular attachments of a framebuffer object, or
the default framebuffer. It is possible, for example, to signal
the intention that depth and or stencil data is no longer needed
at the end of a scene, or that multisample color buffer data is
no longer needed after a resolve through
<a class="citerefentry" href="glBlitFramebuffer"><span class="citerefentry"><span class="refentrytitle">glBlitFramebuffer</span></span></a>.
</p>
</div>
<div class="refsect1" id="errors">
<h2>Errors</h2>
<p>
<code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not <code class="constant">GL_FRAMEBUFFER</code>.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if
<em class="parameter"><code>attachments</code></em> contains
<code class="constant">GL_COLOR_ATTACHMENTm</code> and m is greater than
or equal to the value of
<code class="constant">GL_MAX_COLOR_ATTACHMENTS</code>.
</p>
</div>
{$pipelinestall}{$examples}
<div class="refsect1" id="versions">
<h2>API Version Support</h2>
<div class="informaltable">
<table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">
<colgroup>
<col style="text-align: left; "/>
<col style="text-align: center; " class="firstvers"/>
<col style="text-align: center; "/>
<col style="text-align: center; " class="lastvers"/>
</colgroup>
<thead>
<tr>
<th style="text-align: left; border-right: 2px solid ; ">
</th>
<th style="text-align: center; border-bottom: 2px solid ; " colspan="3">
<span class="bold"><strong>OpenGL ES API Version</strong></span>
</th>
</tr>
<tr>
<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>Function Name</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>2.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.0</strong></span>
</th>
<th style="text-align: center; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.1</strong></span>
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left; border-right: 2px solid ; ">glInvalidateFramebuffer</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; ">✔</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsect1" id="seealso">
<h2>See Also</h2>
<p>
<a class="citerefentry" href="glBindFramebuffer"><span class="citerefentry"><span class="refentrytitle">glBindFramebuffer</span></span></a>,
<a class="citerefentry" href="glBlitFramebuffer"><span class="citerefentry"><span class="refentrytitle">glBlitFramebuffer</span></span></a>
<a class="citerefentry" href="glFramebufferRenderbuffer"><span class="citerefentry"><span class="refentrytitle">glFramebufferRenderbuffer</span></span></a>,
<a class="citerefentry" href="glFramebufferTexture2D"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture2D</span></span></a>,
<a class="citerefentry" href="glFramebufferTextureLayer"><span class="citerefentry"><span class="refentrytitle">glFramebufferTextureLayer</span></span></a>,
<a class="citerefentry" href="glInvalidateSubFramebuffer"><span class="citerefentry"><span class="refentrytitle">glInvalidateSubFramebuffer</span></span></a>
</p>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright © 2014 Khronos Group.
This material may be distributed subject to the terms and conditions set forth in
the Open Publication License, v 1.0, 8 June 1999.
<a class="link" href="https://opencontent.org/openpub/" target="_top">https://opencontent.org/openpub/</a>.
</p>
</div>
</div>