2 * Mesa 3-D graphics library
4 * Copyright (C) 1999-2007 Brian Paul All Rights Reserved.
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included
14 * in all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22 * OTHER DEALINGS IN THE SOFTWARE.
28 * glReadBuffer, DrawBuffer functions.
45 * Return bitmask of BUFFER_BIT_* flags indicating which color buffers are
46 * available to the rendering context (for drawing or reading).
47 * This depends on the type of framebuffer. For window system framebuffers
48 * we look at the framebuffer's visual. But for user-create framebuffers we
49 * look at the number of supported color attachments.
50 * \param fb the framebuffer to draw to, or read from
51 * \return bitmask of BUFFER_BIT_* flags
54 supported_buffer_bitmask(const struct gl_context
*ctx
,
55 const struct gl_framebuffer
*fb
)
57 GLbitfield mask
= 0x0;
59 if (_mesa_is_user_fbo(fb
)) {
60 /* A user-created renderbuffer */
62 for (i
= 0; i
< ctx
->Const
.MaxColorAttachments
; i
++) {
63 mask
|= (BUFFER_BIT_COLOR0
<< i
);
67 /* A window system framebuffer */
69 mask
= BUFFER_BIT_FRONT_LEFT
; /* always have this */
70 if (fb
->Visual
.stereoMode
) {
71 mask
|= BUFFER_BIT_FRONT_RIGHT
;
72 if (fb
->Visual
.doubleBufferMode
) {
73 mask
|= BUFFER_BIT_BACK_LEFT
| BUFFER_BIT_BACK_RIGHT
;
76 else if (fb
->Visual
.doubleBufferMode
) {
77 mask
|= BUFFER_BIT_BACK_LEFT
;
80 for (i
= 0; i
< fb
->Visual
.numAuxBuffers
; i
++) {
81 mask
|= (BUFFER_BIT_AUX0
<< i
);
90 * Helper routine used by glDrawBuffer and glDrawBuffersARB.
91 * Given a GLenum naming one or more color buffers (such as
92 * GL_FRONT_AND_BACK), return the corresponding bitmask of BUFFER_BIT_* flags.
95 draw_buffer_enum_to_bitmask(const struct gl_context
*ctx
, GLenum buffer
)
101 return BUFFER_BIT_FRONT_LEFT
| BUFFER_BIT_FRONT_RIGHT
;
103 if (_mesa_is_gles(ctx
)) {
104 /* Page 181 (page 192 of the PDF) in section 4.2.1 of the OpenGL
105 * ES 3.0.1 specification says:
107 * "When draw buffer zero is BACK, color values are written
108 * into the sole buffer for single-buffered contexts, or into
109 * the back buffer for double-buffered contexts."
111 * Since there is no stereo rendering in ES 3.0, only return the
112 * LEFT bits. This also satisfies the "n must be 1" requirement.
114 * We also do this for GLES 1 and 2 because those APIs have no
115 * concept of selecting the front and back buffer anyway and it's
116 * convenient to be able to maintain the magic behaviour of
117 * GL_BACK in that case.
119 if (ctx
->DrawBuffer
->Visual
.doubleBufferMode
)
120 return BUFFER_BIT_BACK_LEFT
;
121 return BUFFER_BIT_FRONT_LEFT
;
123 return BUFFER_BIT_BACK_LEFT
| BUFFER_BIT_BACK_RIGHT
;
125 return BUFFER_BIT_FRONT_RIGHT
| BUFFER_BIT_BACK_RIGHT
;
127 return BUFFER_BIT_FRONT_RIGHT
;
129 return BUFFER_BIT_BACK_RIGHT
;
131 return BUFFER_BIT_BACK_LEFT
;
132 case GL_FRONT_AND_BACK
:
133 return BUFFER_BIT_FRONT_LEFT
| BUFFER_BIT_BACK_LEFT
134 | BUFFER_BIT_FRONT_RIGHT
| BUFFER_BIT_BACK_RIGHT
;
136 return BUFFER_BIT_FRONT_LEFT
| BUFFER_BIT_BACK_LEFT
;
138 return BUFFER_BIT_FRONT_LEFT
;
140 return BUFFER_BIT_AUX0
;
144 return 1 << BUFFER_COUNT
; /* invalid, but not BAD_MASK */
145 case GL_COLOR_ATTACHMENT0_EXT
:
146 return BUFFER_BIT_COLOR0
;
147 case GL_COLOR_ATTACHMENT1_EXT
:
148 return BUFFER_BIT_COLOR1
;
149 case GL_COLOR_ATTACHMENT2_EXT
:
150 return BUFFER_BIT_COLOR2
;
151 case GL_COLOR_ATTACHMENT3_EXT
:
152 return BUFFER_BIT_COLOR3
;
153 case GL_COLOR_ATTACHMENT4_EXT
:
154 return BUFFER_BIT_COLOR4
;
155 case GL_COLOR_ATTACHMENT5_EXT
:
156 return BUFFER_BIT_COLOR5
;
157 case GL_COLOR_ATTACHMENT6_EXT
:
158 return BUFFER_BIT_COLOR6
;
159 case GL_COLOR_ATTACHMENT7_EXT
:
160 return BUFFER_BIT_COLOR7
;
169 * Helper routine used by glReadBuffer.
170 * Given a GLenum naming a color buffer, return the index of the corresponding
171 * renderbuffer (a BUFFER_* value).
172 * return -1 for an invalid buffer.
175 read_buffer_enum_to_index(GLenum buffer
)
179 return BUFFER_FRONT_LEFT
;
181 return BUFFER_BACK_LEFT
;
183 return BUFFER_FRONT_RIGHT
;
185 return BUFFER_FRONT_RIGHT
;
187 return BUFFER_BACK_RIGHT
;
189 return BUFFER_BACK_LEFT
;
191 return BUFFER_FRONT_LEFT
;
193 return BUFFER_FRONT_LEFT
;
199 return BUFFER_COUNT
; /* invalid, but not -1 */
200 case GL_COLOR_ATTACHMENT0_EXT
:
201 return BUFFER_COLOR0
;
202 case GL_COLOR_ATTACHMENT1_EXT
:
203 return BUFFER_COLOR1
;
204 case GL_COLOR_ATTACHMENT2_EXT
:
205 return BUFFER_COLOR2
;
206 case GL_COLOR_ATTACHMENT3_EXT
:
207 return BUFFER_COLOR3
;
208 case GL_COLOR_ATTACHMENT4_EXT
:
209 return BUFFER_COLOR4
;
210 case GL_COLOR_ATTACHMENT5_EXT
:
211 return BUFFER_COLOR5
;
212 case GL_COLOR_ATTACHMENT6_EXT
:
213 return BUFFER_COLOR6
;
214 case GL_COLOR_ATTACHMENT7_EXT
:
215 return BUFFER_COLOR7
;
224 * Called by glDrawBuffer().
225 * Specify which renderbuffer(s) to draw into for the first color output.
226 * <buffer> can name zero, one, two or four renderbuffers!
227 * \sa _mesa_DrawBuffers
229 * \param buffer buffer token such as GL_LEFT or GL_FRONT_AND_BACK, etc.
231 * Note that the behaviour of this function depends on whether the
232 * current ctx->DrawBuffer is a window-system framebuffer or a user-created
233 * framebuffer object.
234 * In the former case, we update the per-context ctx->Color.DrawBuffer
235 * state var _and_ the FB's ColorDrawBuffer state.
236 * In the later case, we update the FB's ColorDrawBuffer state only.
238 * Furthermore, upon a MakeCurrent() or BindFramebuffer() call, if the
239 * new FB is a window system FB, we need to re-update the FB's
240 * ColorDrawBuffer state to match the context. This is handled in
241 * _mesa_update_framebuffer().
243 * See the GL_EXT_framebuffer_object spec for more info.
246 _mesa_DrawBuffer(GLenum buffer
)
249 GET_CURRENT_CONTEXT(ctx
);
251 FLUSH_VERTICES(ctx
, 0);
253 if (MESA_VERBOSE
& VERBOSE_API
) {
254 _mesa_debug(ctx
, "glDrawBuffer %s\n", _mesa_lookup_enum_by_nr(buffer
));
257 if (buffer
== GL_NONE
) {
261 const GLbitfield supportedMask
262 = supported_buffer_bitmask(ctx
, ctx
->DrawBuffer
);
263 destMask
= draw_buffer_enum_to_bitmask(ctx
, buffer
);
264 if (destMask
== BAD_MASK
) {
265 /* totally bogus buffer */
266 _mesa_error(ctx
, GL_INVALID_ENUM
,
267 "glDrawBuffer(buffer=0x%x)", buffer
);
270 destMask
&= supportedMask
;
271 if (destMask
== 0x0) {
272 /* none of the named color buffers exist! */
273 _mesa_error(ctx
, GL_INVALID_OPERATION
,
274 "glDrawBuffer(buffer=0x%x)", buffer
);
279 /* if we get here, there's no error so set new state */
280 _mesa_drawbuffers(ctx
, 1, &buffer
, &destMask
);
283 * Call device driver function.
285 if (ctx
->Driver
.DrawBuffers
)
286 ctx
->Driver
.DrawBuffers(ctx
, 1, &buffer
);
287 else if (ctx
->Driver
.DrawBuffer
)
288 ctx
->Driver
.DrawBuffer(ctx
, buffer
);
293 * Called by glDrawBuffersARB; specifies the destination color renderbuffers
294 * for N fragment program color outputs.
295 * \sa _mesa_DrawBuffer
296 * \param n number of outputs
297 * \param buffers array [n] of renderbuffer names. Unlike glDrawBuffer, the
298 * names cannot specify more than one buffer. For example,
299 * GL_FRONT_AND_BACK is illegal.
302 _mesa_DrawBuffers(GLsizei n
, const GLenum
*buffers
)
305 GLbitfield usedBufferMask
, supportedMask
;
306 GLbitfield destMask
[MAX_DRAW_BUFFERS
];
307 GET_CURRENT_CONTEXT(ctx
);
309 FLUSH_VERTICES(ctx
, 0);
311 /* Turns out n==0 is a valid input that should not produce an error.
312 * The remaining code below correctly handles the n==0 case.
314 * From the OpenGL 3.0 specification, page 258:
315 * "An INVALID_VALUE error is generated if n is greater than
318 if (n
< 0 || n
> (GLsizei
) ctx
->Const
.MaxDrawBuffers
) {
319 _mesa_error(ctx
, GL_INVALID_VALUE
, "glDrawBuffersARB(n)");
323 supportedMask
= supported_buffer_bitmask(ctx
, ctx
->DrawBuffer
);
324 usedBufferMask
= 0x0;
326 /* From the ES 3.0 specification, page 180:
327 * "If the GL is bound to the default framebuffer, then n must be 1
328 * and the constant must be BACK or NONE."
329 * (same restriction applies with GL_EXT_draw_buffers specification)
331 if (ctx
->API
== API_OPENGLES2
&& _mesa_is_winsys_fbo(ctx
->DrawBuffer
) &&
332 (n
!= 1 || (buffers
[0] != GL_NONE
&& buffers
[0] != GL_BACK
))) {
333 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glDrawBuffers(buffer)");
337 /* complicated error checking... */
338 for (output
= 0; output
< n
; output
++) {
339 if (buffers
[output
] == GL_NONE
) {
340 destMask
[output
] = 0x0;
343 /* Page 259 (page 275 of the PDF) in section 4.2.1 of the OpenGL 3.0
344 * spec (20080923) says:
346 * "If the GL is bound to a framebuffer object and DrawBuffers is
347 * supplied with [...] COLOR_ATTACHMENTm where m is greater than
348 * or equal to the value of MAX_COLOR_ATTACHMENTS, then the error
349 * INVALID_OPERATION results."
351 if (_mesa_is_user_fbo(ctx
->DrawBuffer
) && buffers
[output
] >=
352 GL_COLOR_ATTACHMENT0
+ ctx
->Const
.MaxDrawBuffers
) {
353 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glDrawBuffersARB(buffer)");
357 destMask
[output
] = draw_buffer_enum_to_bitmask(ctx
, buffers
[output
]);
359 /* From the OpenGL 3.0 specification, page 258:
360 * "Each buffer listed in bufs must be one of the values from tables
361 * 4.5 or 4.6. Otherwise, an INVALID_ENUM error is generated.
363 if (destMask
[output
] == BAD_MASK
) {
364 _mesa_error(ctx
, GL_INVALID_ENUM
, "glDrawBuffersARB(buffer)");
368 /* From the OpenGL 4.0 specification, page 256:
369 * "For both the default framebuffer and framebuffer objects, the
370 * constants FRONT, BACK, LEFT, RIGHT, and FRONT_AND_BACK are not
371 * valid in the bufs array passed to DrawBuffers, and will result in
372 * the error INVALID_ENUM. This restriction is because these
373 * constants may themselves refer to multiple buffers, as shown in
375 * Previous versions of the OpenGL specification say INVALID_OPERATION,
376 * but the Khronos conformance tests expect INVALID_ENUM.
378 if (_mesa_bitcount(destMask
[output
]) > 1) {
379 _mesa_error(ctx
, GL_INVALID_ENUM
, "glDrawBuffersARB(buffer)");
383 /* From the OpenGL 3.0 specification, page 259:
384 * "If the GL is bound to the default framebuffer and DrawBuffers is
385 * supplied with a constant (other than NONE) that does not indicate
386 * any of the color buffers allocated to the GL context by the window
387 * system, the error INVALID_OPERATION will be generated.
389 * If the GL is bound to a framebuffer object and DrawBuffers is
390 * supplied with a constant from table 4.6 [...] then the error
391 * INVALID_OPERATION results."
393 destMask
[output
] &= supportedMask
;
394 if (destMask
[output
] == 0) {
395 _mesa_error(ctx
, GL_INVALID_OPERATION
,
396 "glDrawBuffersARB(unsupported buffer)");
400 /* ES 3.0 is even more restrictive. From the ES 3.0 spec, page 180:
401 * "If the GL is bound to a framebuffer object, the ith buffer listed
402 * in bufs must be COLOR_ATTACHMENTi or NONE. [...] INVALID_OPERATION."
403 * (same restriction applies with GL_EXT_draw_buffers specification)
405 if (ctx
->API
== API_OPENGLES2
&& _mesa_is_user_fbo(ctx
->DrawBuffer
) &&
406 buffers
[output
] != GL_NONE
&&
407 buffers
[output
] != GL_COLOR_ATTACHMENT0
+ output
) {
408 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glDrawBuffers(buffer)");
412 /* From the OpenGL 3.0 specification, page 258:
413 * "Except for NONE, a buffer may not appear more than once in the
414 * array pointed to by bufs. Specifying a buffer more then once will
415 * result in the error INVALID_OPERATION."
417 if (destMask
[output
] & usedBufferMask
) {
418 _mesa_error(ctx
, GL_INVALID_OPERATION
,
419 "glDrawBuffersARB(duplicated buffer)");
424 usedBufferMask
|= destMask
[output
];
428 /* OK, if we get here, there were no errors so set the new state */
429 _mesa_drawbuffers(ctx
, n
, buffers
, destMask
);
432 * Call device driver function. Note that n can be equal to 0,
433 * in which case we don't want to reference buffers[0], which
436 if (ctx
->Driver
.DrawBuffers
)
437 ctx
->Driver
.DrawBuffers(ctx
, n
, buffers
);
438 else if (ctx
->Driver
.DrawBuffer
)
439 ctx
->Driver
.DrawBuffer(ctx
, n
> 0 ? buffers
[0] : GL_NONE
);
444 * Performs necessary state updates when _mesa_drawbuffers makes an
448 updated_drawbuffers(struct gl_context
*ctx
)
450 FLUSH_VERTICES(ctx
, _NEW_BUFFERS
);
452 if (ctx
->API
== API_OPENGL_COMPAT
&& !ctx
->Extensions
.ARB_ES2_compatibility
) {
453 struct gl_framebuffer
*fb
= ctx
->DrawBuffer
;
455 /* Flag the FBO as requiring validation. */
456 if (_mesa_is_user_fbo(fb
)) {
464 * Helper function to set the GL_DRAW_BUFFER state in the context and
465 * current FBO. Called via glDrawBuffer(), glDrawBuffersARB()
467 * All error checking will have been done prior to calling this function
468 * so nothing should go wrong at this point.
470 * \param ctx current context
471 * \param n number of color outputs to set
472 * \param buffers array[n] of colorbuffer names, like GL_LEFT.
473 * \param destMask array[n] of BUFFER_BIT_* bitmasks which correspond to the
474 * colorbuffer names. (i.e. GL_FRONT_AND_BACK =>
475 * BUFFER_BIT_FRONT_LEFT | BUFFER_BIT_BACK_LEFT).
478 _mesa_drawbuffers(struct gl_context
*ctx
, GLuint n
, const GLenum
*buffers
,
479 const GLbitfield
*destMask
)
481 struct gl_framebuffer
*fb
= ctx
->DrawBuffer
;
482 GLbitfield mask
[MAX_DRAW_BUFFERS
];
486 /* compute destMask values now */
487 const GLbitfield supportedMask
= supported_buffer_bitmask(ctx
, fb
);
489 for (output
= 0; output
< n
; output
++) {
490 mask
[output
] = draw_buffer_enum_to_bitmask(ctx
, buffers
[output
]);
491 ASSERT(mask
[output
] != BAD_MASK
);
492 mask
[output
] &= supportedMask
;
498 * destMask[0] may have up to four bits set
499 * (ex: glDrawBuffer(GL_FRONT_AND_BACK)).
500 * Otherwise, destMask[x] can only have one bit set.
502 if (n
> 0 && _mesa_bitcount(destMask
[0]) > 1) {
503 GLuint count
= 0, destMask0
= destMask
[0];
505 GLint bufIndex
= ffs(destMask0
) - 1;
506 if (fb
->_ColorDrawBufferIndexes
[count
] != bufIndex
) {
507 updated_drawbuffers(ctx
);
508 fb
->_ColorDrawBufferIndexes
[count
] = bufIndex
;
511 destMask0
&= ~(1 << bufIndex
);
513 fb
->ColorDrawBuffer
[0] = buffers
[0];
514 fb
->_NumColorDrawBuffers
= count
;
518 for (buf
= 0; buf
< n
; buf
++ ) {
520 GLint bufIndex
= ffs(destMask
[buf
]) - 1;
521 /* only one bit should be set in the destMask[buf] field */
522 ASSERT(_mesa_bitcount(destMask
[buf
]) == 1);
523 if (fb
->_ColorDrawBufferIndexes
[buf
] != bufIndex
) {
524 updated_drawbuffers(ctx
);
525 fb
->_ColorDrawBufferIndexes
[buf
] = bufIndex
;
530 if (fb
->_ColorDrawBufferIndexes
[buf
] != -1) {
531 updated_drawbuffers(ctx
);
532 fb
->_ColorDrawBufferIndexes
[buf
] = -1;
535 fb
->ColorDrawBuffer
[buf
] = buffers
[buf
];
537 fb
->_NumColorDrawBuffers
= count
;
540 /* set remaining outputs to -1 (GL_NONE) */
541 for (buf
= fb
->_NumColorDrawBuffers
; buf
< ctx
->Const
.MaxDrawBuffers
; buf
++) {
542 if (fb
->_ColorDrawBufferIndexes
[buf
] != -1) {
543 updated_drawbuffers(ctx
);
544 fb
->_ColorDrawBufferIndexes
[buf
] = -1;
547 for (buf
= n
; buf
< ctx
->Const
.MaxDrawBuffers
; buf
++) {
548 fb
->ColorDrawBuffer
[buf
] = GL_NONE
;
551 if (_mesa_is_winsys_fbo(fb
)) {
552 /* also set context drawbuffer state */
553 for (buf
= 0; buf
< ctx
->Const
.MaxDrawBuffers
; buf
++) {
554 if (ctx
->Color
.DrawBuffer
[buf
] != fb
->ColorDrawBuffer
[buf
]) {
555 updated_drawbuffers(ctx
);
556 ctx
->Color
.DrawBuffer
[buf
] = fb
->ColorDrawBuffer
[buf
];
564 * Update the current drawbuffer's _ColorDrawBufferIndex[] list, etc.
565 * from the context's Color.DrawBuffer[] state.
566 * Use when changing contexts.
569 _mesa_update_draw_buffers(struct gl_context
*ctx
)
571 /* should be a window system FBO */
572 assert(_mesa_is_winsys_fbo(ctx
->DrawBuffer
));
574 _mesa_drawbuffers(ctx
, ctx
->Const
.MaxDrawBuffers
,
575 ctx
->Color
.DrawBuffer
, NULL
);
580 * Like \sa _mesa_drawbuffers(), this is a helper function for setting
581 * GL_READ_BUFFER state in the context and current FBO.
582 * \param ctx the rendering context
583 * \param buffer GL_FRONT, GL_BACK, GL_COLOR_ATTACHMENT0, etc.
584 * \param bufferIndex the numerical index corresponding to 'buffer'
587 _mesa_readbuffer(struct gl_context
*ctx
, GLenum buffer
, GLint bufferIndex
)
589 struct gl_framebuffer
*fb
= ctx
->ReadBuffer
;
591 if (_mesa_is_winsys_fbo(fb
)) {
592 /* Only update the per-context READ_BUFFER state if we're bound to
593 * a window-system framebuffer.
595 ctx
->Pixel
.ReadBuffer
= buffer
;
598 fb
->ColorReadBuffer
= buffer
;
599 fb
->_ColorReadBufferIndex
= bufferIndex
;
601 ctx
->NewState
|= _NEW_BUFFERS
;
607 * Called by glReadBuffer to set the source renderbuffer for reading pixels.
608 * \param mode color buffer such as GL_FRONT, GL_BACK, etc.
611 _mesa_ReadBuffer(GLenum buffer
)
613 struct gl_framebuffer
*fb
;
614 GLbitfield supportedMask
;
616 GET_CURRENT_CONTEXT(ctx
);
618 FLUSH_VERTICES(ctx
, 0);
620 if (MESA_VERBOSE
& VERBOSE_API
)
621 _mesa_debug(ctx
, "glReadBuffer %s\n", _mesa_lookup_enum_by_nr(buffer
));
623 fb
= ctx
->ReadBuffer
;
625 if (MESA_VERBOSE
& VERBOSE_API
)
626 _mesa_debug(ctx
, "glReadBuffer %s\n", _mesa_lookup_enum_by_nr(buffer
));
628 if (buffer
== GL_NONE
) {
629 /* This is legal--it means that no buffer should be bound for reading. */
633 /* general case / window-system framebuffer */
634 srcBuffer
= read_buffer_enum_to_index(buffer
);
635 if (srcBuffer
== -1) {
636 _mesa_error(ctx
, GL_INVALID_ENUM
,
637 "glReadBuffer(buffer=0x%x)", buffer
);
640 supportedMask
= supported_buffer_bitmask(ctx
, fb
);
641 if (((1 << srcBuffer
) & supportedMask
) == 0) {
642 _mesa_error(ctx
, GL_INVALID_OPERATION
,
643 "glReadBuffer(buffer=0x%x)", buffer
);
648 /* OK, all error checking has been completed now */
650 _mesa_readbuffer(ctx
, buffer
, srcBuffer
);
653 * Call device driver function.
655 if (ctx
->Driver
.ReadBuffer
)
656 (*ctx
->Driver
.ReadBuffer
)(ctx
, buffer
);