forked from BSVino/docs.gl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
glFramebufferTextureLayer.xhtml
223 lines (222 loc) · 10.7 KB
/
glFramebufferTextureLayer.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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
<div class="refentry" id="glFramebufferTextureLayer">
<div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p>glFramebufferTextureLayer — attach a single layer of a texture to 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">glFramebufferTextureLayer</strong>(</code>
</td>
<td>GLenum <var class="pdparam">target</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLenum <var class="pdparam">attachment</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLuint <var class="pdparam">texture</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">level</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">layer</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 framebuffer target. <em class="parameter"><code>target</code></em> must be <code class="constant">GL_DRAW_FRAMEBUFFER</code>,
<code class="constant">GL_READ_FRAMEBUFFER</code>, or <code class="constant">GL_FRAMEBUFFER</code>. <code class="constant">GL_FRAMEBUFFER</code>
is equivalent to <code class="constant">GL_DRAW_FRAMEBUFFER</code>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>attachment</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the attachment point of the framebuffer. <em class="parameter"><code>attachment</code></em> must be
<code class="constant">GL_COLOR_ATTACHMENT</code><span class="emphasis"><em>i</em></span>, <code class="constant">GL_DEPTH_ATTACHMENT</code>,
<code class="constant">GL_STENCIL_ATTACHMENT</code> or <code class="constant">GL_DEPTH_STENCIL_ATTACHMENT</code>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>texture</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the texture object to attach to the framebuffer attachment point named by <em class="parameter"><code>attachment</code></em>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>level</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the mipmap level of <em class="parameter"><code>texture</code></em> to attach.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>layer</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the layer of <em class="parameter"><code>texture</code></em> to attach.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
<code class="function">glFramebufferTextureLayer</code> operates like <a class="citerefentry" href="glFramebufferTexture2D"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture2D</span></span></a>,
except that only a single layer of the texture level, given by <em class="parameter"><code>layer</code></em>, is attached to the attachment point.
If <em class="parameter"><code>texture</code></em> is not zero, <em class="parameter"><code>layer</code></em> must be greater than or equal to zero.
<em class="parameter"><code>texture</code></em> must either be zero or the name of an existing three-dimensional texture, or a two-dimensional
array texture.
</p>
<p>
If <em class="parameter"><code>texture</code></em> is a 3D texture, then <em class="parameter"><code>level</code></em> must be greater
than or equal to zero and less than or equal to log<sub>2</sub> of the value of
<code class="constant">GL_MAX_3D_TEXTURE_SIZE</code>. If <em class="parameter"><code>texture</code></em> is a 2D array texture,
<em class="parameter"><code>level</code></em> must be greater than or equal to zero and no larger than log<sub>2</sub>
of the value of <code class="constant">GL_MAX_TEXTURE_SIZE</code>.
</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 one of the accepted tokens.
</p>
<p>
<code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>attachment</code></em> is not one of the accepted tokens.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>texture</code></em> is not zero or the name of an existing
texture object.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>texture</code></em> is not zero and <em class="parameter"><code>layer</code></em>
is negative.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if
<em class="parameter"><code>texture</code></em> is not zero and
<em class="parameter"><code>layer</code></em> is greater than the value of
<code class="constant">GL_MAX_3D_TEXTURE_SIZE</code> minus one for a 3D
texture or greater than the value of
<code class="constant">GL_MAX_ARRAY_TEXTURE_LAYERS</code> minus one for a
2D array texture.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if zero is bound to <em class="parameter"><code>target</code></em>.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>texture</code></em> is not zero or the name of an existing
three-dimensional texture, or a two-dimensional array texture.
</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 ; ">glFramebufferTextureLayer</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="glGenFramebuffers"><span class="citerefentry"><span class="refentrytitle">glGenFramebuffers</span></span></a>,
<a class="citerefentry" href="glBindFramebuffer"><span class="citerefentry"><span class="refentrytitle">glBindFramebuffer</span></span></a>,
<a class="citerefentry" href="glGenRenderbuffers"><span class="citerefentry"><span class="refentrytitle">glGenRenderbuffers</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>,
</p>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright © 2010-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>