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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
|
<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="glFramebufferTexture">
<info>
<copyright>
<year>2010-2014</year>
<holder>Khronos Group</holder>
</copyright>
</info>
<refmeta>
<refentrytitle>glFramebufferTexture</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glFramebufferTexture</refname>
<refpurpose>attach a level of a texture object as a logical buffer of a framebuffer object</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glFramebufferTexture</function></funcdef>
<paramdef>GLenum <parameter>target</parameter></paramdef>
<paramdef>GLenum <parameter>attachment</parameter></paramdef>
<paramdef>GLuint <parameter>texture</parameter></paramdef>
<paramdef>GLint <parameter>level</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>void <function>glFramebufferTexture1D</function></funcdef>
<paramdef>GLenum <parameter>target</parameter></paramdef>
<paramdef>GLenum <parameter>attachment</parameter></paramdef>
<paramdef>GLenum <parameter>textarget</parameter></paramdef>
<paramdef>GLuint <parameter>texture</parameter></paramdef>
<paramdef>GLint <parameter>level</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>void <function>glFramebufferTexture2D</function></funcdef>
<paramdef>GLenum <parameter>target</parameter></paramdef>
<paramdef>GLenum <parameter>attachment</parameter></paramdef>
<paramdef>GLenum <parameter>textarget</parameter></paramdef>
<paramdef>GLuint <parameter>texture</parameter></paramdef>
<paramdef>GLint <parameter>level</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>void <function>glFramebufferTexture3D</function></funcdef>
<paramdef>GLenum <parameter>target</parameter></paramdef>
<paramdef>GLenum <parameter>attachment</parameter></paramdef>
<paramdef>GLenum <parameter>textarget</parameter></paramdef>
<paramdef>GLuint <parameter>texture</parameter></paramdef>
<paramdef>GLint <parameter>level</parameter></paramdef>
<paramdef>GLint <parameter>layer</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>void <function>glNamedFramebufferTexture</function></funcdef>
<paramdef>GLuint <parameter>framebuffer</parameter></paramdef>
<paramdef>GLenum <parameter>attachment</parameter></paramdef>
<paramdef>GLuint <parameter>texture</parameter></paramdef>
<paramdef>GLint <parameter>level</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 xml:id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>target</parameter></term>
<listitem>
<para>
Specifies the target to which the framebuffer is bound
for all commands <emphasis>except</emphasis>
<function>glNamedFramebufferTexture</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>framebuffer</parameter></term>
<listitem>
<para>
Specifies the name of the framebuffer object for
<function>glNamedFramebufferTexture</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>attachment</parameter></term>
<listitem>
<para>
Specifies the attachment point of the framebuffer.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>textarget</parameter></term>
<listitem>
<para>
For <function>glFramebufferTexture1D</function>,
<function>glFramebufferTexture2D</function> and
<function>glFramebufferTexture3D</function>, specifies
what type of texture is expected in the
<parameter>texture</parameter> parameter, or for cube
map textures, which face is to be attached.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>texture</parameter></term>
<listitem>
<para>
Specifies the name of an existing texture object to
attach.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>level</parameter></term>
<listitem>
<para>
Specifies the mipmap level of the texture object to
attach.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 xml:id="description"><title>Description</title>
<para>
These commands attach a selected mipmap level or image of a
texture object as one of the logical buffers of the specified
framebuffer object. Textures cannot be attached to the default
draw and read framebuffer, so they are not valid targets of
these commands.
</para>
<para>
For all commands <emphasis>except</emphasis>
<function>glNamedFramebufferTexture</function>, the framebuffer
object is that bound to <parameter>target</parameter>, which
must be <constant>GL_DRAW_FRAMEBUFFER</constant>,
<constant>GL_READ_FRAMEBUFFER</constant>, or
<constant>GL_FRAMEBUFFER</constant>.
<constant>GL_FRAMEBUFFER</constant> is equivalent to
<constant>GL_DRAW_FRAMEBUFFER</constant>.
</para>
<para>
For <function>glNamedFramebufferTexture</function>,
<parameter>framebuffer</parameter> is the name of the
framebuffer object.
</para>
<para>
<parameter>attachment</parameter> specifies the logical
attachment of the framebuffer and must be
<constant>GL_COLOR_ATTACHMENT</constant><emphasis>i</emphasis>,
<constant>GL_DEPTH_ATTACHMENT</constant>,
<constant>GL_STENCIL_ATTACHMENT</constant> or
<constant>GL_DEPTH_STENCIL_ATTACHMENT</constant>.
<emphasis>i</emphasis> in
<constant>GL_COLOR_ATTACHMENT</constant><emphasis>i</emphasis>
may range from zero to the value of
<constant>GL_MAX_COLOR_ATTACHMENTS</constant> minus one.
Attaching a level of a texture to
<constant>GL_DEPTH_STENCIL_ATTACHMENT</constant> is equivalent
to attaching that level to both the
<constant>GL_DEPTH_ATTACHMENT</constant>
<emphasis>and</emphasis> the
<constant>GL_STENCIL_ATTACHMENT</constant> attachment points
simultaneously.
</para>
<para>
For <function>glFramebufferTexture1D</function>,
<function>glFramebufferTexture2D</function> and
<function>glFramebufferTexture3D</function>,
<parameter>textarget</parameter> specifies what type of texture
is named by <parameter>texture</parameter>, and for cube map
textures, specifies the face that is to be attached. If
<parameter>texture</parameter> is not zero, it must be the name
of an existing texture object with effective target
<parameter>textarget</parameter> unless it is a cube map
texture, in which case <parameter>textarget</parameter> must be
<constant>GL_TEXTURE_CUBE_MAP_POSITIVE_X</constant>
<constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_X</constant>,
<constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Y</constant>,
<constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</constant>,
<constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Z</constant>, or
<constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</constant>.
</para>
<para>
If <parameter>texture</parameter> is non-zero, the specified
<parameter>level</parameter> of the texture object named
<parameter>texture</parameter> is attached to the framebfufer
attachment point named by <parameter>attachment</parameter>. For
<function>glFramebufferTexture1D</function>,
<function>glFramebufferTexture2D</function>, and
<function>glFramebufferTexture3D</function>,
<parameter>texture</parameter> must be zero or the name of an
existing texture with an effective target of
<parameter>textarget</parameter>, or
<parameter>texture</parameter> must be the name of an existing
cube-map texture and <parameter>textarget</parameter> must be
one of <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_X</constant>,
<constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Y</constant>,
<constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Z</constant>,
<constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_X</constant>,
<constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</constant>, or
<constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</constant>.
</para>
<para>
If <parameter>textarget</parameter> is
<constant>GL_TEXTURE_RECTANGLE</constant>,
<constant>GL_TEXTURE_2D_MULTISAMPLE</constant>, or
<constant>GL_TEXTURE_2D_MULTISAMPLE_ARRAY</constant>, then
<parameter>level</parameter> must be zero.
</para>
<para>
If <parameter>textarget</parameter> is
<constant>GL_TEXTURE_3D</constant>, then
<parameter>level</parameter> must be greater than or equal to
zero and less than or equal to $log_2$ of the value of
<constant>GL_MAX_3D_TEXTURE_SIZE</constant>.
</para>
<para>
If <parameter>textarget</parameter> is one of
<constant>GL_TEXTURE_CUBE_MAP_POSITIVE_X</constant>,
<constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Y</constant>,
<constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Z</constant>,
<constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_X</constant>,
<constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</constant>, or
<constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</constant>, then
<parameter>level</parameter> must be greater than or equal to
zero and less than or equal to $log_2$ of the value of
<constant>GL_MAX_CUBE_MAP_TEXTURE_SIZE</constant>.
</para>
<para>
For all other values of <parameter>textarget</parameter>,
<parameter>level</parameter> must be greater than or equal to
zero and less than or equal to $log_2$ of the value of
<constant>GL_MAX_TEXTURE_SIZE</constant>.
</para>
<para>
<parameter>layer</parameter> specifies the layer of a
2-dimensional image within a 3-dimensional texture.
</para>
<para>
For <function>glFramebufferTexture1D</function>, if
<parameter>texture</parameter> is not zero, then
<parameter>textarget</parameter> must be
<constant>GL_TEXTURE_1D</constant>. For
<function>glFramebufferTexture2D</function>, if
<parameter>texture</parameter> is not zero,
<parameter>textarget</parameter> must be one of
<constant>GL_TEXTURE_2D</constant>,
<constant>GL_TEXTURE_RECTANGLE</constant>,
<constant>GL_TEXTURE_CUBE_MAP_POSITIVE_X</constant>,
<constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Y</constant>,
<constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Z</constant>,
<constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_X</constant>,
<constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</constant>,
<constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</constant>, or
<constant>GL_TEXTURE_2D_MULTISAMPLE</constant>. For
<function>glFramebufferTexture3D</function>, if
<parameter>texture</parameter> is not zero, then
<parameter>textarget</parameter> must be
<constant>GL_TEXTURE_3D</constant>.
</para>
<para>
For <function>glFramebufferTexture</function> and
<function>glNamedFramebufferTexture</function>, if
<parameter>texture</parameter> is the name of a
three-dimensional, cube map array, cube map, one- or
two-dimensional array, or two-dimensional multisample array
texture, the specified texture level is an array of images, and
the framebuffer attachment is considered to be
<emphasis>layered</emphasis>.
</para>
</refsect1>
<refsect1 xml:id="errors"><title>Errors</title>
<para>
<constant>GL_INVALID_ENUM</constant> is generated by all
commands accepting a <parameter>target</parameter> parameter if
it is not one of the accepted framebuffer targets.
</para>
<para>
<constant>GL_INVALID_OPERATION</constant> is generated by all
commands accepting a <parameter>target</parameter> parameter if
zero is bound to that target.
</para>
<para>
<constant>GL_INVALID_OPERATION</constant> is generated by
<function>glNamedFramebufferTexture</function> if
<parameter>framebuffer</parameter> is not the name of an
existing framebuffer object.
</para>
<para>
<constant>GL_INVALID_ENUM</constant> is generated if
<parameter>attachment</parameter> is not one of the accepted
attachment points.
</para>
<para>
<constant>GL_INVALID_VALUE</constant> is generated if
<parameter>texture</parameter> is not zero or the name of an
existing texture object.
</para>
<para>
<constant>GL_INVALID_VALUE</constant> is generated if
<parameter>texture</parameter> is not zero and
<parameter>level</parameter> is not a supported texture level
for <parameter>texture</parameter>.
</para>
<para>
<constant>GL_INVALID_VALUE</constant> is generated by
<function>glFramebufferTexture3D</function> if
<parameter>texture</parameter> is not zero and
<parameter>layer</parameter> is larger than the value of
<constant>GL_MAX_3D_TEXTURE_SIZE</constant> minus one.
</para>
<para>
<constant>GL_INVALID_OPERATION</constant> is generated by all
commands accepting a <parameter>textarget</parameter> parameter
if <parameter>texture</parameter> is not zero, and
<parameter>textarget</parameter> and the effective target of
<parameter>texture</parameter> are not compatible.
</para>
<para>
<constant>GL_INVALID_OPERATION</constant> is generated by
if <parameter>texture</parameter> is a buffer texture.
</para>
</refsect1>
<refsect1 xml:id="versions"><title>Version Support</title>
<informaltable>
<tgroup cols="13" align="left">
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apifunchead.xml" xpointer="xpointer(/*/*)"/>
<tbody>
<row>
<entry><function>glFramebufferTexture</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='32']/*)"/>
</row>
<row>
<entry><function>glFramebufferTexture1D</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='30']/*)"/>
</row>
<row>
<entry><function>glFramebufferTexture2D</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='30']/*)"/>
</row>
<row>
<entry><function>glFramebufferTexture3D</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='30']/*)"/>
</row>
<row>
<entry><function>glNamedFramebufferTexture</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='45']/*)"/>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 xml:id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glGenFramebuffers</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glBindFramebuffer</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glFramebufferTexture</refentrytitle></citerefentry>,
<!-- FIX: link to glFramebufferTexture --> <function>glFramebufferTexture1D</function>,
<!-- FIX: link to glFramebufferTexture --> <function>glFramebufferTexture2D</function>,
<!-- FIX: link to glFramebufferTexture --> <function>glFramebufferTexture3D</function>
</para>
</refsect1>
<refsect1 xml:id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="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.
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
</para>
</refsect1>
</refentry>
|
