2 * Mesa 3-D graphics library
4 * Copyright (C) 1999-2008 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.
27 * Functions for allocating/managing framebuffers and renderbuffers.
28 * Also, routines for reading/writing renderbuffer data as ubytes,
29 * ushorts, uints, etc.
43 #include "framebuffer.h"
44 #include "renderbuffer.h"
46 #include "glformats.h"
52 * Compute/set the _DepthMax field for the given framebuffer.
53 * This value depends on the Z buffer resolution.
56 compute_depth_max(struct gl_framebuffer
*fb
)
58 if (fb
->Visual
.depthBits
== 0) {
59 /* Special case. Even if we don't have a depth buffer we need
60 * good values for DepthMax for Z vertex transformation purposes
61 * and for per-fragment fog computation.
63 fb
->_DepthMax
= (1 << 16) - 1;
65 else if (fb
->Visual
.depthBits
< 32) {
66 fb
->_DepthMax
= (1 << fb
->Visual
.depthBits
) - 1;
69 /* Special case since shift values greater than or equal to the
70 * number of bits in the left hand expression's type are undefined.
72 fb
->_DepthMax
= 0xffffffff;
74 fb
->_DepthMaxF
= (GLfloat
) fb
->_DepthMax
;
76 /* Minimum resolvable depth value, for polygon offset */
77 fb
->_MRD
= (GLfloat
)1.0 / fb
->_DepthMaxF
;
81 * Create and initialize a gl_framebuffer object.
82 * This is intended for creating _window_system_ framebuffers, not generic
83 * framebuffer objects ala GL_EXT_framebuffer_object.
85 * \sa _mesa_new_framebuffer
87 struct gl_framebuffer
*
88 _mesa_create_framebuffer(const struct gl_config
*visual
)
90 struct gl_framebuffer
*fb
= CALLOC_STRUCT(gl_framebuffer
);
93 _mesa_initialize_window_framebuffer(fb
, visual
);
100 * Allocate a new gl_framebuffer object.
101 * This is the default function for ctx->Driver.NewFramebuffer().
102 * This is for allocating user-created framebuffers, not window-system
104 * \sa _mesa_create_framebuffer
106 struct gl_framebuffer
*
107 _mesa_new_framebuffer(struct gl_context
*ctx
, GLuint name
)
109 struct gl_framebuffer
*fb
;
112 fb
= CALLOC_STRUCT(gl_framebuffer
);
114 _mesa_initialize_user_framebuffer(fb
, name
);
121 * Initialize a gl_framebuffer object. Typically used to initialize
122 * window system-created framebuffers, not user-created framebuffers.
123 * \sa _mesa_initialize_user_framebuffer
126 _mesa_initialize_window_framebuffer(struct gl_framebuffer
*fb
,
127 const struct gl_config
*visual
)
132 memset(fb
, 0, sizeof(struct gl_framebuffer
));
134 mtx_init(&fb
->Mutex
, mtx_plain
);
138 /* save the visual */
139 fb
->Visual
= *visual
;
141 /* Init read/draw renderbuffer state */
142 if (visual
->doubleBufferMode
) {
143 fb
->_NumColorDrawBuffers
= 1;
144 fb
->ColorDrawBuffer
[0] = GL_BACK
;
145 fb
->_ColorDrawBufferIndexes
[0] = BUFFER_BACK_LEFT
;
146 fb
->ColorReadBuffer
= GL_BACK
;
147 fb
->_ColorReadBufferIndex
= BUFFER_BACK_LEFT
;
150 fb
->_NumColorDrawBuffers
= 1;
151 fb
->ColorDrawBuffer
[0] = GL_FRONT
;
152 fb
->_ColorDrawBufferIndexes
[0] = BUFFER_FRONT_LEFT
;
153 fb
->ColorReadBuffer
= GL_FRONT
;
154 fb
->_ColorReadBufferIndex
= BUFFER_FRONT_LEFT
;
157 fb
->Delete
= _mesa_destroy_framebuffer
;
158 fb
->_Status
= GL_FRAMEBUFFER_COMPLETE_EXT
;
159 fb
->_AllColorBuffersFixedPoint
= !visual
->floatMode
;
160 fb
->_HasSNormOrFloatColorBuffer
= visual
->floatMode
;
161 fb
->_HasAttachments
= true;
163 compute_depth_max(fb
);
168 * Initialize a user-created gl_framebuffer object.
169 * \sa _mesa_initialize_window_framebuffer
172 _mesa_initialize_user_framebuffer(struct gl_framebuffer
*fb
, GLuint name
)
177 memset(fb
, 0, sizeof(struct gl_framebuffer
));
181 fb
->_NumColorDrawBuffers
= 1;
182 fb
->ColorDrawBuffer
[0] = GL_COLOR_ATTACHMENT0_EXT
;
183 fb
->_ColorDrawBufferIndexes
[0] = BUFFER_COLOR0
;
184 fb
->ColorReadBuffer
= GL_COLOR_ATTACHMENT0_EXT
;
185 fb
->_ColorReadBufferIndex
= BUFFER_COLOR0
;
186 fb
->Delete
= _mesa_destroy_framebuffer
;
187 mtx_init(&fb
->Mutex
, mtx_plain
);
192 * Deallocate buffer and everything attached to it.
193 * Typically called via the gl_framebuffer->Delete() method.
196 _mesa_destroy_framebuffer(struct gl_framebuffer
*fb
)
199 _mesa_free_framebuffer_data(fb
);
207 * Free all the data hanging off the given gl_framebuffer, but don't free
208 * the gl_framebuffer object itself.
211 _mesa_free_framebuffer_data(struct gl_framebuffer
*fb
)
216 assert(fb
->RefCount
== 0);
218 mtx_destroy(&fb
->Mutex
);
220 for (i
= 0; i
< BUFFER_COUNT
; i
++) {
221 struct gl_renderbuffer_attachment
*att
= &fb
->Attachment
[i
];
222 if (att
->Renderbuffer
) {
223 _mesa_reference_renderbuffer(&att
->Renderbuffer
, NULL
);
226 _mesa_reference_texobj(&att
->Texture
, NULL
);
228 assert(!att
->Renderbuffer
);
229 assert(!att
->Texture
);
236 * Set *ptr to point to fb, with refcounting and locking.
237 * This is normally only called from the _mesa_reference_framebuffer() macro
238 * when there's a real pointer change.
241 _mesa_reference_framebuffer_(struct gl_framebuffer
**ptr
,
242 struct gl_framebuffer
*fb
)
245 /* unreference old renderbuffer */
246 GLboolean deleteFlag
= GL_FALSE
;
247 struct gl_framebuffer
*oldFb
= *ptr
;
249 mtx_lock(&oldFb
->Mutex
);
250 assert(oldFb
->RefCount
> 0);
252 deleteFlag
= (oldFb
->RefCount
== 0);
253 mtx_unlock(&oldFb
->Mutex
);
256 oldFb
->Delete(oldFb
);
262 mtx_lock(&fb
->Mutex
);
264 mtx_unlock(&fb
->Mutex
);
271 * Resize the given framebuffer's renderbuffers to the new width and height.
272 * This should only be used for window-system framebuffers, not
273 * user-created renderbuffers (i.e. made with GL_EXT_framebuffer_object).
274 * This will typically be called directly from a device driver.
276 * \note it's possible for ctx to be null since a window can be resized
277 * without a currently bound rendering context.
280 _mesa_resize_framebuffer(struct gl_context
*ctx
, struct gl_framebuffer
*fb
,
281 GLuint width
, GLuint height
)
285 /* XXX I think we could check if the size is not changing
289 /* Can only resize win-sys framebuffer objects */
290 assert(_mesa_is_winsys_fbo(fb
));
292 for (i
= 0; i
< BUFFER_COUNT
; i
++) {
293 struct gl_renderbuffer_attachment
*att
= &fb
->Attachment
[i
];
294 if (att
->Type
== GL_RENDERBUFFER_EXT
&& att
->Renderbuffer
) {
295 struct gl_renderbuffer
*rb
= att
->Renderbuffer
;
296 /* only resize if size is changing */
297 if (rb
->Width
!= width
|| rb
->Height
!= height
) {
298 if (rb
->AllocStorage(ctx
, rb
, rb
->InternalFormat
, width
, height
)) {
299 assert(rb
->Width
== width
);
300 assert(rb
->Height
== height
);
303 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "Resizing framebuffer");
314 /* update scissor / window bounds */
315 _mesa_update_draw_buffer_bounds(ctx
, ctx
->DrawBuffer
);
316 /* Signal new buffer state so that swrast will update its clipping
317 * info (the CLIP_BIT flag).
319 ctx
->NewState
|= _NEW_BUFFERS
;
324 * Examine all the framebuffer's renderbuffers to update the Width/Height
325 * fields of the framebuffer. If we have renderbuffers with different
326 * sizes, set the framebuffer's width and height to the min size.
327 * Note: this is only intended for user-created framebuffers, not
328 * window-system framebuffes.
331 update_framebuffer_size(struct gl_context
*ctx
, struct gl_framebuffer
*fb
)
333 GLuint minWidth
= ~0, minHeight
= ~0;
336 /* user-created framebuffers only */
337 assert(_mesa_is_user_fbo(fb
));
339 for (i
= 0; i
< BUFFER_COUNT
; i
++) {
340 struct gl_renderbuffer_attachment
*att
= &fb
->Attachment
[i
];
341 const struct gl_renderbuffer
*rb
= att
->Renderbuffer
;
343 minWidth
= MIN2(minWidth
, rb
->Width
);
344 minHeight
= MIN2(minHeight
, rb
->Height
);
348 if (minWidth
!= ~0U) {
349 fb
->Width
= minWidth
;
350 fb
->Height
= minHeight
;
361 * Given a bounding box, intersect the bounding box with the scissor of
362 * a specified vieport.
364 * \param ctx GL context.
365 * \param idx Index of the desired viewport
366 * \param bbox Bounding box for the scissored viewport. Stored as xmin,
370 _mesa_intersect_scissor_bounding_box(const struct gl_context
*ctx
,
371 unsigned idx
, int *bbox
)
373 if (ctx
->Scissor
.EnableFlags
& (1u << idx
)) {
374 if (ctx
->Scissor
.ScissorArray
[idx
].X
> bbox
[0]) {
375 bbox
[0] = ctx
->Scissor
.ScissorArray
[idx
].X
;
377 if (ctx
->Scissor
.ScissorArray
[idx
].Y
> bbox
[2]) {
378 bbox
[2] = ctx
->Scissor
.ScissorArray
[idx
].Y
;
380 if (ctx
->Scissor
.ScissorArray
[idx
].X
+ ctx
->Scissor
.ScissorArray
[idx
].Width
< bbox
[1]) {
381 bbox
[1] = ctx
->Scissor
.ScissorArray
[idx
].X
+ ctx
->Scissor
.ScissorArray
[idx
].Width
;
383 if (ctx
->Scissor
.ScissorArray
[idx
].Y
+ ctx
->Scissor
.ScissorArray
[idx
].Height
< bbox
[3]) {
384 bbox
[3] = ctx
->Scissor
.ScissorArray
[idx
].Y
+ ctx
->Scissor
.ScissorArray
[idx
].Height
;
386 /* finally, check for empty region */
387 if (bbox
[0] > bbox
[1]) {
390 if (bbox
[2] > bbox
[3]) {
397 * Calculate the inclusive bounding box for the scissor of a specific viewport
399 * \param ctx GL context.
400 * \param buffer Framebuffer to be checked against
401 * \param idx Index of the desired viewport
402 * \param bbox Bounding box for the scissored viewport. Stored as xmin,
405 * \warning This function assumes that the framebuffer dimensions are up to
406 * date (e.g., update_framebuffer_size has been recently called on \c buffer).
408 * \sa _mesa_clip_to_region
411 _mesa_scissor_bounding_box(const struct gl_context
*ctx
,
412 const struct gl_framebuffer
*buffer
,
413 unsigned idx
, int *bbox
)
417 bbox
[1] = buffer
->Width
;
418 bbox
[3] = buffer
->Height
;
420 _mesa_intersect_scissor_bounding_box(ctx
, idx
, bbox
);
422 assert(bbox
[0] <= bbox
[1]);
423 assert(bbox
[2] <= bbox
[3]);
427 * Update the context's current drawing buffer's Xmin, Xmax, Ymin, Ymax fields.
428 * These values are computed from the buffer's width and height and
429 * the scissor box, if it's enabled.
430 * \param ctx the GL context.
433 _mesa_update_draw_buffer_bounds(struct gl_context
*ctx
,
434 struct gl_framebuffer
*buffer
)
441 if (_mesa_is_user_fbo(buffer
)) {
442 /* user-created framebuffer size depends on the renderbuffers */
443 update_framebuffer_size(ctx
, buffer
);
446 /* Default to the first scissor as that's always valid */
447 _mesa_scissor_bounding_box(ctx
, buffer
, 0, bbox
);
448 buffer
->_Xmin
= bbox
[0];
449 buffer
->_Ymin
= bbox
[2];
450 buffer
->_Xmax
= bbox
[1];
451 buffer
->_Ymax
= bbox
[3];
456 * The glGet queries of the framebuffer red/green/blue size, stencil size,
457 * etc. are satisfied by the fields of ctx->DrawBuffer->Visual. These can
458 * change depending on the renderbuffer bindings. This function updates
459 * the given framebuffer's Visual from the current renderbuffer bindings.
461 * This may apply to user-created framebuffers or window system framebuffers.
463 * Also note: ctx->DrawBuffer->Visual.depthBits might not equal
464 * ctx->DrawBuffer->Attachment[BUFFER_DEPTH].Renderbuffer.DepthBits.
465 * The former one is used to convert floating point depth values into
469 _mesa_update_framebuffer_visual(struct gl_context
*ctx
,
470 struct gl_framebuffer
*fb
)
474 memset(&fb
->Visual
, 0, sizeof(fb
->Visual
));
475 fb
->Visual
.rgbMode
= GL_TRUE
; /* assume this */
477 #if 0 /* this _might_ be needed */
478 if (fb
->_Status
!= GL_FRAMEBUFFER_COMPLETE_EXT
) {
479 /* leave visual fields zero'd */
484 /* find first RGB renderbuffer */
485 for (i
= 0; i
< BUFFER_COUNT
; i
++) {
486 if (fb
->Attachment
[i
].Renderbuffer
) {
487 const struct gl_renderbuffer
*rb
= fb
->Attachment
[i
].Renderbuffer
;
488 const GLenum baseFormat
= _mesa_get_format_base_format(rb
->Format
);
489 const mesa_format fmt
= rb
->Format
;
491 /* Grab samples and sampleBuffers from any attachment point (assuming
492 * the framebuffer is complete, we'll get the same answer from all
495 fb
->Visual
.samples
= rb
->NumSamples
;
496 fb
->Visual
.sampleBuffers
= rb
->NumSamples
> 0 ? 1 : 0;
498 if (_mesa_is_legal_color_format(ctx
, baseFormat
)) {
499 fb
->Visual
.redBits
= _mesa_get_format_bits(fmt
, GL_RED_BITS
);
500 fb
->Visual
.greenBits
= _mesa_get_format_bits(fmt
, GL_GREEN_BITS
);
501 fb
->Visual
.blueBits
= _mesa_get_format_bits(fmt
, GL_BLUE_BITS
);
502 fb
->Visual
.alphaBits
= _mesa_get_format_bits(fmt
, GL_ALPHA_BITS
);
503 fb
->Visual
.rgbBits
= fb
->Visual
.redBits
504 + fb
->Visual
.greenBits
+ fb
->Visual
.blueBits
;
505 if (_mesa_get_format_color_encoding(fmt
) == GL_SRGB
)
506 fb
->Visual
.sRGBCapable
= ctx
->Extensions
.EXT_framebuffer_sRGB
;
512 fb
->Visual
.floatMode
= GL_FALSE
;
513 for (i
= 0; i
< BUFFER_COUNT
; i
++) {
514 if (fb
->Attachment
[i
].Renderbuffer
) {
515 const struct gl_renderbuffer
*rb
= fb
->Attachment
[i
].Renderbuffer
;
516 const mesa_format fmt
= rb
->Format
;
518 if (_mesa_get_format_datatype(fmt
) == GL_FLOAT
) {
519 fb
->Visual
.floatMode
= GL_TRUE
;
525 if (fb
->Attachment
[BUFFER_DEPTH
].Renderbuffer
) {
526 const struct gl_renderbuffer
*rb
=
527 fb
->Attachment
[BUFFER_DEPTH
].Renderbuffer
;
528 const mesa_format fmt
= rb
->Format
;
529 fb
->Visual
.haveDepthBuffer
= GL_TRUE
;
530 fb
->Visual
.depthBits
= _mesa_get_format_bits(fmt
, GL_DEPTH_BITS
);
533 if (fb
->Attachment
[BUFFER_STENCIL
].Renderbuffer
) {
534 const struct gl_renderbuffer
*rb
=
535 fb
->Attachment
[BUFFER_STENCIL
].Renderbuffer
;
536 const mesa_format fmt
= rb
->Format
;
537 fb
->Visual
.haveStencilBuffer
= GL_TRUE
;
538 fb
->Visual
.stencilBits
= _mesa_get_format_bits(fmt
, GL_STENCIL_BITS
);
541 if (fb
->Attachment
[BUFFER_ACCUM
].Renderbuffer
) {
542 const struct gl_renderbuffer
*rb
=
543 fb
->Attachment
[BUFFER_ACCUM
].Renderbuffer
;
544 const mesa_format fmt
= rb
->Format
;
545 fb
->Visual
.haveAccumBuffer
= GL_TRUE
;
546 fb
->Visual
.accumRedBits
= _mesa_get_format_bits(fmt
, GL_RED_BITS
);
547 fb
->Visual
.accumGreenBits
= _mesa_get_format_bits(fmt
, GL_GREEN_BITS
);
548 fb
->Visual
.accumBlueBits
= _mesa_get_format_bits(fmt
, GL_BLUE_BITS
);
549 fb
->Visual
.accumAlphaBits
= _mesa_get_format_bits(fmt
, GL_ALPHA_BITS
);
552 compute_depth_max(fb
);
557 * Example DrawBuffers scenarios:
559 * 1. glDrawBuffer(GL_FRONT_AND_BACK), fixed-func or shader writes to
560 * "gl_FragColor" or program writes to the "result.color" register:
562 * fragment color output renderbuffer
563 * --------------------- ---------------
564 * color[0] Front, Back
567 * 2. glDrawBuffers(3, [GL_FRONT, GL_AUX0, GL_AUX1]), shader writes to
568 * gl_FragData[i] or program writes to result.color[i] registers:
570 * fragment color output renderbuffer
571 * --------------------- ---------------
577 * 3. glDrawBuffers(3, [GL_FRONT, GL_AUX0, GL_AUX1]) and shader writes to
578 * gl_FragColor, or fixed function:
580 * fragment color output renderbuffer
581 * --------------------- ---------------
582 * color[0] Front, Aux0, Aux1
585 * In either case, the list of renderbuffers is stored in the
586 * framebuffer->_ColorDrawBuffers[] array and
587 * framebuffer->_NumColorDrawBuffers indicates the number of buffers.
588 * The renderer (like swrast) has to look at the current fragment shader
589 * to see if it writes to gl_FragColor vs. gl_FragData[i] to determine
590 * how to map color outputs to renderbuffers.
592 * Note that these two calls are equivalent (for fixed function fragment
594 * a) glDrawBuffer(GL_FRONT_AND_BACK); (assuming non-stereo framebuffer)
595 * b) glDrawBuffers(2, [GL_FRONT_LEFT, GL_BACK_LEFT]);
602 * Update the (derived) list of color drawing renderbuffer pointers.
603 * Later, when we're rendering we'll loop from 0 to _NumColorDrawBuffers
607 update_color_draw_buffers(struct gl_context
*ctx
, struct gl_framebuffer
*fb
)
611 /* set 0th buffer to NULL now in case _NumColorDrawBuffers is zero */
612 fb
->_ColorDrawBuffers
[0] = NULL
;
614 for (output
= 0; output
< fb
->_NumColorDrawBuffers
; output
++) {
615 GLint buf
= fb
->_ColorDrawBufferIndexes
[output
];
617 fb
->_ColorDrawBuffers
[output
] = fb
->Attachment
[buf
].Renderbuffer
;
620 fb
->_ColorDrawBuffers
[output
] = NULL
;
627 * Update the (derived) color read renderbuffer pointer.
628 * Unlike the DrawBuffer, we can only read from one (or zero) color buffers.
631 update_color_read_buffer(struct gl_context
*ctx
, struct gl_framebuffer
*fb
)
634 if (fb
->_ColorReadBufferIndex
== -1 ||
638 fb
->_ColorReadBuffer
= NULL
; /* legal! */
641 assert(fb
->_ColorReadBufferIndex
>= 0);
642 assert(fb
->_ColorReadBufferIndex
< BUFFER_COUNT
);
644 = fb
->Attachment
[fb
->_ColorReadBufferIndex
].Renderbuffer
;
650 * Update a gl_framebuffer's derived state.
652 * Specifically, update these framebuffer fields:
654 * _NumColorDrawBuffers
657 * If the framebuffer is user-created, make sure it's complete.
659 * The following functions (at least) can effect framebuffer state:
660 * glReadBuffer, glDrawBuffer, glDrawBuffersARB, glFramebufferRenderbufferEXT,
661 * glRenderbufferStorageEXT.
664 update_framebuffer(struct gl_context
*ctx
, struct gl_framebuffer
*fb
)
666 if (_mesa_is_winsys_fbo(fb
)) {
667 /* This is a window-system framebuffer */
668 /* Need to update the FB's GL_DRAW_BUFFER state to match the
669 * context state (GL_READ_BUFFER too).
671 if (fb
->ColorDrawBuffer
[0] != ctx
->Color
.DrawBuffer
[0]) {
672 _mesa_drawbuffers(ctx
, fb
, ctx
->Const
.MaxDrawBuffers
,
673 ctx
->Color
.DrawBuffer
, NULL
);
677 /* This is a user-created framebuffer.
678 * Completeness only matters for user-created framebuffers.
680 if (fb
->_Status
!= GL_FRAMEBUFFER_COMPLETE
) {
681 _mesa_test_framebuffer_completeness(ctx
, fb
);
685 /* Strictly speaking, we don't need to update the draw-state
686 * if this FB is bound as ctx->ReadBuffer (and conversely, the
687 * read-state if this FB is bound as ctx->DrawBuffer), but no
690 update_color_draw_buffers(ctx
, fb
);
691 update_color_read_buffer(ctx
, fb
);
693 compute_depth_max(fb
);
698 * Update state related to the draw/read framebuffers.
701 _mesa_update_framebuffer(struct gl_context
*ctx
,
702 struct gl_framebuffer
*readFb
,
703 struct gl_framebuffer
*drawFb
)
707 update_framebuffer(ctx
, drawFb
);
708 if (readFb
!= drawFb
)
709 update_framebuffer(ctx
, readFb
);
711 _mesa_update_clamp_vertex_color(ctx
, drawFb
);
712 _mesa_update_clamp_fragment_color(ctx
, drawFb
);
717 * Check if the renderbuffer for a read/draw operation exists.
718 * \param format a basic image format such as GL_RGB, GL_RGBA, GL_ALPHA,
719 * GL_DEPTH_COMPONENT, etc. or GL_COLOR, GL_DEPTH, GL_STENCIL.
720 * \param reading if TRUE, we're going to read from the buffer,
721 if FALSE, we're going to write to the buffer.
722 * \return GL_TRUE if buffer exists, GL_FALSE otherwise
725 renderbuffer_exists(struct gl_context
*ctx
,
726 struct gl_framebuffer
*fb
,
730 const struct gl_renderbuffer_attachment
*att
= fb
->Attachment
;
732 /* If we don't know the framebuffer status, update it now */
733 if (fb
->_Status
== 0) {
734 _mesa_test_framebuffer_completeness(ctx
, fb
);
737 if (fb
->_Status
!= GL_FRAMEBUFFER_COMPLETE_EXT
) {
748 case GL_LUMINANCE_ALPHA
:
756 case GL_RED_INTEGER_EXT
:
758 case GL_GREEN_INTEGER_EXT
:
759 case GL_BLUE_INTEGER_EXT
:
760 case GL_ALPHA_INTEGER_EXT
:
761 case GL_RGB_INTEGER_EXT
:
762 case GL_RGBA_INTEGER_EXT
:
763 case GL_BGR_INTEGER_EXT
:
764 case GL_BGRA_INTEGER_EXT
:
765 case GL_LUMINANCE_INTEGER_EXT
:
766 case GL_LUMINANCE_ALPHA_INTEGER_EXT
:
768 /* about to read from a color buffer */
769 const struct gl_renderbuffer
*readBuf
= fb
->_ColorReadBuffer
;
773 assert(_mesa_get_format_bits(readBuf
->Format
, GL_RED_BITS
) > 0 ||
774 _mesa_get_format_bits(readBuf
->Format
, GL_ALPHA_BITS
) > 0 ||
775 _mesa_get_format_bits(readBuf
->Format
, GL_TEXTURE_LUMINANCE_SIZE
) > 0 ||
776 _mesa_get_format_bits(readBuf
->Format
, GL_TEXTURE_INTENSITY_SIZE
) > 0 ||
777 _mesa_get_format_bits(readBuf
->Format
, GL_INDEX_BITS
) > 0);
780 /* about to draw to zero or more color buffers (none is OK) */
785 case GL_DEPTH_COMPONENT
:
786 if (att
[BUFFER_DEPTH
].Type
== GL_NONE
) {
791 case GL_STENCIL_INDEX
:
792 if (att
[BUFFER_STENCIL
].Type
== GL_NONE
) {
796 case GL_DEPTH_STENCIL_EXT
:
797 if (att
[BUFFER_DEPTH
].Type
== GL_NONE
||
798 att
[BUFFER_STENCIL
].Type
== GL_NONE
) {
804 "Unexpected format 0x%x in renderbuffer_exists",
815 * Check if the renderbuffer for a read operation (glReadPixels, glCopyPixels,
816 * glCopyTex[Sub]Image, etc) exists.
817 * \param format a basic image format such as GL_RGB, GL_RGBA, GL_ALPHA,
818 * GL_DEPTH_COMPONENT, etc. or GL_COLOR, GL_DEPTH, GL_STENCIL.
819 * \return GL_TRUE if buffer exists, GL_FALSE otherwise
822 _mesa_source_buffer_exists(struct gl_context
*ctx
, GLenum format
)
824 return renderbuffer_exists(ctx
, ctx
->ReadBuffer
, format
, GL_TRUE
);
829 * As above, but for drawing operations.
832 _mesa_dest_buffer_exists(struct gl_context
*ctx
, GLenum format
)
834 return renderbuffer_exists(ctx
, ctx
->DrawBuffer
, format
, GL_FALSE
);
839 * Used to answer the GL_IMPLEMENTATION_COLOR_READ_FORMAT_OES queries (using
840 * GetIntegerv, GetFramebufferParameteriv, etc)
842 * If @fb is NULL, the method returns the value for the current bound
846 _mesa_get_color_read_format(struct gl_context
*ctx
,
847 struct gl_framebuffer
*fb
,
851 _mesa_update_state(ctx
);
854 fb
= ctx
->ReadBuffer
;
856 if (!fb
|| !fb
->_ColorReadBuffer
) {
858 * From OpenGL 4.5 spec, section 18.2.2 "ReadPixels":
860 * "An INVALID_OPERATION error is generated by GetIntegerv if pname
861 * is IMPLEMENTATION_COLOR_READ_FORMAT or IMPLEMENTATION_COLOR_-
862 * READ_TYPE and any of:
863 * * the read framebuffer is not framebuffer complete.
864 * * the read framebuffer is a framebuffer object, and the selected
865 * read buffer (see section 18.2.1) has no image attached.
866 * * the selected read buffer is NONE."
868 * There is not equivalent quote for GetFramebufferParameteriv or
869 * GetNamedFramebufferParameteriv, but from section 9.2.3 "Framebuffer
872 * "Values of framebuffer-dependent state are identical to those that
873 * would be obtained were the framebuffer object bound and queried
874 * using the simple state queries in that table."
876 * Where "using the simple state queries" refer to use GetIntegerv. So
877 * we will assume that on that situation the same error should be
880 _mesa_error(ctx
, GL_INVALID_OPERATION
,
881 "%s(GL_IMPLEMENTATION_COLOR_READ_FORMAT: no GL_READ_BUFFER)",
886 const mesa_format format
= fb
->_ColorReadBuffer
->Format
;
887 const GLenum data_type
= _mesa_get_format_datatype(format
);
889 if (format
== MESA_FORMAT_B8G8R8A8_UNORM
)
891 else if (format
== MESA_FORMAT_B5G6R5_UNORM
)
893 else if (format
== MESA_FORMAT_R_UNORM8
)
897 case GL_UNSIGNED_INT
:
899 return GL_RGBA_INTEGER
;
908 * Used to answer the GL_IMPLEMENTATION_COLOR_READ_TYPE_OES queries (using
909 * GetIntegerv, GetFramebufferParameteriv, etc)
911 * If @fb is NULL, the method returns the value for the current bound
915 _mesa_get_color_read_type(struct gl_context
*ctx
,
916 struct gl_framebuffer
*fb
,
920 _mesa_update_state(ctx
);
923 fb
= ctx
->ReadBuffer
;
925 if (!fb
|| !fb
->_ColorReadBuffer
) {
927 * See comment on _mesa_get_color_read_format
929 _mesa_error(ctx
, GL_INVALID_OPERATION
,
930 "%s(GL_IMPLEMENTATION_COLOR_READ_TYPE: no GL_READ_BUFFER)",
935 const GLenum format
= fb
->_ColorReadBuffer
->Format
;
936 const GLenum data_type
= _mesa_get_format_datatype(format
);
938 if (format
== MESA_FORMAT_B5G6R5_UNORM
)
939 return GL_UNSIGNED_SHORT_5_6_5
;
942 case GL_SIGNED_NORMALIZED
:
944 case GL_UNSIGNED_INT
:
948 case GL_UNSIGNED_NORMALIZED
:
950 return GL_UNSIGNED_BYTE
;
957 * Returns the read renderbuffer for the specified format.
959 struct gl_renderbuffer
*
960 _mesa_get_read_renderbuffer_for_format(const struct gl_context
*ctx
,
963 const struct gl_framebuffer
*rfb
= ctx
->ReadBuffer
;
965 if (_mesa_is_color_format(format
)) {
966 return rfb
->Attachment
[rfb
->_ColorReadBufferIndex
].Renderbuffer
;
967 } else if (_mesa_is_depth_format(format
) ||
968 _mesa_is_depthstencil_format(format
)) {
969 return rfb
->Attachment
[BUFFER_DEPTH
].Renderbuffer
;
971 return rfb
->Attachment
[BUFFER_STENCIL
].Renderbuffer
;
977 * Print framebuffer info to stderr, for debugging.
980 _mesa_print_framebuffer(const struct gl_framebuffer
*fb
)
984 fprintf(stderr
, "Mesa Framebuffer %u at %p\n", fb
->Name
, (void *) fb
);
985 fprintf(stderr
, " Size: %u x %u Status: %s\n", fb
->Width
, fb
->Height
,
986 _mesa_enum_to_string(fb
->_Status
));
987 fprintf(stderr
, " Attachments:\n");
989 for (i
= 0; i
< BUFFER_COUNT
; i
++) {
990 const struct gl_renderbuffer_attachment
*att
= &fb
->Attachment
[i
];
991 if (att
->Type
== GL_TEXTURE
) {
992 const struct gl_texture_image
*texImage
= att
->Renderbuffer
->TexImage
;
994 " %2d: Texture %u, level %u, face %u, slice %u, complete %d\n",
995 i
, att
->Texture
->Name
, att
->TextureLevel
, att
->CubeMapFace
,
996 att
->Zoffset
, att
->Complete
);
997 fprintf(stderr
, " Size: %u x %u x %u Format %s\n",
998 texImage
->Width
, texImage
->Height
, texImage
->Depth
,
999 _mesa_get_format_name(texImage
->TexFormat
));
1001 else if (att
->Type
== GL_RENDERBUFFER
) {
1002 fprintf(stderr
, " %2d: Renderbuffer %u, complete %d\n",
1003 i
, att
->Renderbuffer
->Name
, att
->Complete
);
1004 fprintf(stderr
, " Size: %u x %u Format %s\n",
1005 att
->Renderbuffer
->Width
, att
->Renderbuffer
->Height
,
1006 _mesa_get_format_name(att
->Renderbuffer
->Format
));
1009 fprintf(stderr
, " %2d: none\n", i
);
1015 _mesa_is_front_buffer_reading(const struct gl_framebuffer
*fb
)
1017 if (!fb
|| _mesa_is_user_fbo(fb
))
1020 return fb
->_ColorReadBufferIndex
== BUFFER_FRONT_LEFT
;
1024 _mesa_is_front_buffer_drawing(const struct gl_framebuffer
*fb
)
1026 if (!fb
|| _mesa_is_user_fbo(fb
))
1029 return (fb
->_NumColorDrawBuffers
>= 1 &&
1030 fb
->_ColorDrawBufferIndexes
[0] == BUFFER_FRONT_LEFT
);
1033 static inline GLuint
1034 _mesa_geometric_nonvalidated_samples(const struct gl_framebuffer
*buffer
)
1036 return buffer
->_HasAttachments
?
1037 buffer
->Visual
.samples
:
1038 buffer
->DefaultGeometry
.NumSamples
;
1042 _mesa_is_multisample_enabled(const struct gl_context
*ctx
)
1044 /* The sample count may not be validated by the driver, but when it is set,
1045 * we know that is in a valid range and no driver should ever validate a
1046 * multisampled framebuffer to non-multisampled and vice-versa.
1048 return ctx
->Multisample
.Enabled
&&
1050 _mesa_geometric_nonvalidated_samples(ctx
->DrawBuffer
) >= 1;
1054 * Is alpha testing enabled and applicable to the currently bound
1058 _mesa_is_alpha_test_enabled(const struct gl_context
*ctx
)
1060 bool buffer0_is_integer
= ctx
->DrawBuffer
->_IntegerBuffers
& 0x1;
1061 return (ctx
->Color
.AlphaEnabled
&& !buffer0_is_integer
);
1065 * Is alpha to coverage enabled and applicable to the currently bound
1069 _mesa_is_alpha_to_coverage_enabled(const struct gl_context
*ctx
)
1071 bool buffer0_is_integer
= ctx
->DrawBuffer
->_IntegerBuffers
& 0x1;
1072 return (ctx
->Multisample
.SampleAlphaToCoverage
&&
1073 _mesa_is_multisample_enabled(ctx
) &&
1074 !buffer0_is_integer
);