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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>glBlitFramebuffer - OpenGL 4 Reference Pages</title>
<link rel="stylesheet" type="text/css" href="opengl-man.css"/>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"/>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
MathML: {
extensions: ["content-mathml.js"]
},
tex2jax: {
inlineMath: [['$','$'], ['\\(','\\)']]
}
});
</script>
<script type="text/javascript" src="https://c328740.ssl.cf1.rackcdn.com/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"/>
</head>
<body>
<header/>
<div class="refentry" id="glBlitFramebuffer">
<div class="titlepage"/>
<div class="refnamediv">
<h2>Name</h2>
<p>glBlitFramebuffer, glBlitNamedFramebuffer — copy a block of pixels from one framebuffer object to another</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">glBlitFramebuffer</strong>(</code>
</td>
<td>GLint <var class="pdparam">srcX0</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">srcY0</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">srcX1</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">srcY1</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">dstX0</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">dstY0</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">dstX1</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">dstY1</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLbitfield <var class="pdparam">mask</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLenum <var class="pdparam">filter</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer"> </div>
<table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
<tr>
<td>
<code class="funcdef">void <strong class="fsfunc">glBlitNamedFramebuffer</strong>(</code>
</td>
<td>GLuint <var class="pdparam">readFramebuffer</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLuint <var class="pdparam">drawFramebuffer</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">srcX0</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">srcY0</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">srcX1</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">srcY1</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">dstX0</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">dstY0</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">dstX1</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">dstY1</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLbitfield <var class="pdparam">mask</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLenum <var class="pdparam">filter</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>readFramebuffer</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the name of the source framebuffer object
for <code class="function">glBlitNamedFramebuffer</code>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>drawFramebuffer</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the name of the destination framebuffer object
for <code class="function">glBlitNamedFramebuffer</code>.
</p>
</dd>
<dt>
<span class="term"><em class="parameter"><code>srcX0</code></em>, </span>
<span class="term"><em class="parameter"><code>srcY0</code></em>, </span>
<span class="term"><em class="parameter"><code>srcX1</code></em>, </span>
<span class="term">
<em class="parameter">
<code>srcY1</code>
</em>
</span>
</dt>
<dd>
<p>
Specify the bounds of the source rectangle within the read buffer of the read framebuffer.
</p>
</dd>
<dt>
<span class="term"><em class="parameter"><code>dstX0</code></em>, </span>
<span class="term"><em class="parameter"><code>dstY0</code></em>, </span>
<span class="term"><em class="parameter"><code>dstX1</code></em>, </span>
<span class="term">
<em class="parameter">
<code>dstY1</code>
</em>
</span>
</dt>
<dd>
<p>
Specify the bounds of the destination rectangle within the write buffer of the write framebuffer.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>mask</code>
</em>
</span>
</dt>
<dd>
<p>
The bitwise OR of the flags indicating which buffers are to be copied. The allowed flags are
<code class="constant">GL_COLOR_BUFFER_BIT</code>, <code class="constant">GL_DEPTH_BUFFER_BIT</code> and <code class="constant">GL_STENCIL_BUFFER_BIT</code>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>filter</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the interpolation to be applied if the image is stretched. Must be <code class="constant">GL_NEAREST</code> or <code class="constant">GL_LINEAR</code>.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
<code class="function">glBlitFramebuffer</code> and
<code class="function">glBlitNamedFramebuffer</code> transfer a rectangle
of pixel values from one region of a read framebuffer to another
region of a draw framebuffer.
</p>
<p>
For <code class="function">glBlitFramebuffer</code>, the read and draw
framebuffers are those bound to the
<code class="constant">GL_READ_FRAMEBUFFER</code> and
<code class="constant">GL_DRAW_FRAMEBUFFER</code> targets respectively.
</p>
<p>
For <code class="function">glBlitNamedFramebuffer</code>,
<em class="parameter"><code>readFramebuffer</code></em> and
<em class="parameter"><code>drawFramebuffer</code></em> are the names of the read
read and draw framebuffer objects respectively. If
<em class="parameter"><code>readFramebuffer</code></em> or
<em class="parameter"><code>drawFramebuffer</code></em> is zero, then the default
read or draw framebuffer respectively is used.
</p>
<p>
<em class="parameter"><code>mask</code></em> is the bitwise OR of a number of
values indicating which buffers are to be copied. The values are
<code class="constant">GL_COLOR_BUFFER_BIT</code>,
<code class="constant">GL_DEPTH_BUFFER_BIT</code>, and
<code class="constant">GL_STENCIL_BUFFER_BIT</code>. The pixels
corresponding to these buffers are copied from the source
rectangle bounded by the locations
(<em class="parameter"><code>srcX0</code></em>, <em class="parameter"><code>srcY0</code></em>) and
(<em class="parameter"><code>srcX1</code></em>, <em class="parameter"><code>srcY1</code></em>) to
the destination rectangle bounded by the locations
(<em class="parameter"><code>dstX0</code></em>, <em class="parameter"><code>dstY0</code></em>) and
(<em class="parameter"><code>dstX1</code></em>, <em class="parameter"><code>dstY1</code></em>).
The lower bounds of the rectangle are inclusive, while the upper
bounds are exclusive.
</p>
<p>
The actual region taken from the read framebuffer is limited to
the intersection of the source buffers being transferred, which
may include the color buffer selected by the read buffer, the
depth buffer, and/or the stencil buffer depending on mask. The
actual region written to the draw framebuffer is limited to the
intersection of the destination buffers being written, which may
include multiple draw buffers, the depth buffer, and/or the
stencil buffer depending on mask. Whether or not the source or
destination regions are altered due to these limits, the scaling
and offset applied to pixels being transferred is performed as
though no such limits were present.
</p>
<p>
If the sizes of the source and destination rectangles are not
equal, <em class="parameter"><code>filter</code></em> specifies the interpolation
method that will be applied to resize the source image , and
must be <code class="constant">GL_NEAREST</code> or
<code class="constant">GL_LINEAR</code>. <code class="constant">GL_LINEAR</code>
is only a valid interpolation method for the color buffer. If
<em class="parameter"><code>filter</code></em> is not
<code class="constant">GL_NEAREST</code> and <em class="parameter"><code>mask</code></em>
includes <code class="constant">GL_DEPTH_BUFFER_BIT</code> or
<code class="constant">GL_STENCIL_BUFFER_BIT</code>, no data is
transferred and a <code class="constant">GL_INVALID_OPERATION</code>
error is generated.
</p>
<p>
If <em class="parameter"><code>filter</code></em> is
<code class="constant">GL_LINEAR</code> and the source rectangle would
require sampling outside the bounds of the source framebuffer,
values are read as if the <code class="constant">GL_CLAMP_TO_EDGE</code>
texture wrapping mode were applied.
</p>
<p>
When the color buffer is transferred, values are taken from the
read buffer of the specified read framebuffer and written to
each of the draw buffers of the specified draw framebuffer.
</p>
<p>
If the source and destination rectangles overlap or are the same, and the read and draw buffers are the same, the result of the operation
is undefined.
</p>
</div>
<div class="refsect1" id="errors">
<h2>Errors</h2>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated by
<code class="function">BlitNamedFramebuffer</code> if
<em class="parameter"><code>readFramebuffer</code></em> or
<em class="parameter"><code>drawFramebuffer</code></em> is not zero or the name
of an existing framebuffer object.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if
<em class="parameter"><code>mask</code></em> contains any of the
<code class="constant">GL_DEPTH_BUFFER_BIT</code> or
<code class="constant">GL_STENCIL_BUFFER_BIT</code> and
<em class="parameter"><code>filter</code></em> is not
<code class="constant">GL_NEAREST</code>.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if
<em class="parameter"><code>mask</code></em> contains
<code class="constant">GL_COLOR_BUFFER_BIT</code> and any of the
following conditions hold:
</p>
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
<p>
The read buffer contains fixed-point or
floating-point values and any draw buffer contains
neither fixed-point nor floating-point values.
</p>
</li>
<li class="listitem">
<p>
The read buffer contains unsigned integer values and
any draw buffer does not contain unsigned integer
values.
</p>
</li>
<li class="listitem">
<p>
The read buffer contains signed integer values and
any draw buffer does not contain signed integer
values.
</p>
</li>
</ul>
</div>
<p>
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if
<em class="parameter"><code>mask</code></em> contains
<code class="constant">GL_DEPTH_BUFFER_BIT</code> or
<code class="constant">GL_STENCIL_BUFFER_BIT</code> and the source and
destination depth and stencil formats do not match.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if
<em class="parameter"><code>filter</code></em> is <code class="constant">GL_LINEAR</code>
and the read buffer contains integer data.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if the
effective value of <code class="constant">GL_SAMPLES</code> for the read
and draw framebuffers is not identical.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if the
value of <code class="constant">GL_SAMPLE_BUFFERS</code> for both read
and draw buffers is greater than zero and the dimensions of the
source and destination rectangles is not identical.
</p>
<p>
<code class="constant">GL_INVALID_FRAMEBUFFER_OPERATION</code> is
generated if the specified read and draw framebuffers are not
framebuffer complete.
</p>
</div>
<div class="refsect1" id="versions">
<h2>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; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<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="12">
<span class="bold"><strong>OpenGL Version</strong></span>
</th>
</tr>
<tr>
<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>Function / Feature 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>2.1</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-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.2</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.3</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.2</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.3</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.4</strong></span>
</th>
<th style="text-align: center; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.5</strong></span>
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="function">glBlitFramebuffer</code>
</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
<td style="text-align: center; border-bottom: 2px solid ; ">✔</td>
</tr>
<tr>
<td style="text-align: left; border-right: 2px solid ; ">
<code class="function">glBlitNamedFramebuffer</code>
</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; border-right: 2px solid ; ">-</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; border-right: 2px solid ; ">-</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; border-right: 2px solid ; ">-</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="glReadPixels.xhtml"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a>
<a class="citerefentry" href="glCheckFramebufferStatus.xhtml"><span class="citerefentry"><span class="refentrytitle">glCheckFramebufferStatus</span></span></a>,
<a class="citerefentry" href="glGenFramebuffers.xhtml"><span class="citerefentry"><span class="refentrytitle">glGenFramebuffers</span></span></a>
<a class="citerefentry" href="glBindFramebuffer.xhtml"><span class="citerefentry"><span class="refentrytitle">glBindFramebuffer</span></span></a>
<a class="citerefentry" href="glDeleteFramebuffers.xhtml"><span class="citerefentry"><span class="refentrytitle">glDeleteFramebuffers</span></span></a>
</p>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright <span class="trademark"/>© 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="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
</p>
</div>
</div>
<footer/>
</body>
</html>
|
