blob: d061d22d9b82e0679d88cb432ebfefaa68ba51a4 [file] [log] [blame]
Brian Paule4b23562005-05-04 20:11:35 +00001/*
2 * Mesa 3-D graphics library
Brian Paul57223382006-04-06 04:09:03 +00003 * Version: 6.5.1
Brian Paule4b23562005-05-04 20:11:35 +00004 *
Brian Paul7275d4d2006-03-20 15:25:18 +00005 * Copyright (C) 1999-2006 Brian Paul All Rights Reserved.
Brian Paule4b23562005-05-04 20:11:35 +00006 *
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
21 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 */
24
25
26/**
27 * Functions for allocating/managing framebuffers and renderbuffers.
28 * Also, routines for reading/writing renderbuffer data as ubytes,
29 * ushorts, uints, etc.
30 */
31
32
33#include "glheader.h"
34#include "imports.h"
35#include "context.h"
Brian Paul84716042005-11-16 04:05:54 +000036#include "depthstencil.h"
Brian Paule4b23562005-05-04 20:11:35 +000037#include "mtypes.h"
38#include "fbobject.h"
39#include "framebuffer.h"
40#include "renderbuffer.h"
41
42
43
44/**
45 * Compute/set the _DepthMax field for the given framebuffer.
46 * This value depends on the Z buffer resolution.
47 */
48static void
49compute_depth_max(struct gl_framebuffer *fb)
50{
51 if (fb->Visual.depthBits == 0) {
52 /* Special case. Even if we don't have a depth buffer we need
53 * good values for DepthMax for Z vertex transformation purposes
54 * and for per-fragment fog computation.
55 */
56 fb->_DepthMax = (1 << 16) - 1;
57 }
58 else if (fb->Visual.depthBits < 32) {
59 fb->_DepthMax = (1 << fb->Visual.depthBits) - 1;
60 }
61 else {
62 /* Special case since shift values greater than or equal to the
63 * number of bits in the left hand expression's type are undefined.
64 */
65 fb->_DepthMax = 0xffffffff;
66 }
67 fb->_DepthMaxF = (GLfloat) fb->_DepthMax;
68 fb->_MRD = 1.0; /* Minimum resolvable depth value, for polygon offset */
69}
70
71
72/**
Brian Paulea4fe662006-03-26 05:22:17 +000073 * Set the framebuffer's _DepthBuffer field, taking care of
74 * reference counts, etc.
75 */
76static void
77set_depth_renderbuffer(struct gl_framebuffer *fb,
78 struct gl_renderbuffer *rb)
79{
80 if (fb->_DepthBuffer) {
Brian Paul2eb88c172006-05-20 15:06:35 +000081 _mesa_dereference_renderbuffer(&fb->_DepthBuffer);
Brian Paulea4fe662006-03-26 05:22:17 +000082 }
83 fb->_DepthBuffer = rb;
84 if (rb) {
85 rb->RefCount++;
86 }
87}
88
89
90/**
91 * Set the framebuffer's _StencilBuffer field, taking care of
92 * reference counts, etc.
93 */
94static void
95set_stencil_renderbuffer(struct gl_framebuffer *fb,
96 struct gl_renderbuffer *rb)
97{
98 if (fb->_StencilBuffer) {
Brian Paul2eb88c172006-05-20 15:06:35 +000099 _mesa_dereference_renderbuffer(&fb->_StencilBuffer);
Brian Paulea4fe662006-03-26 05:22:17 +0000100 }
101 fb->_StencilBuffer = rb;
102 if (rb) {
103 rb->RefCount++;
104 }
105}
106
107
108/**
Brian Paule4b23562005-05-04 20:11:35 +0000109 * Create and initialize a gl_framebuffer object.
110 * This is intended for creating _window_system_ framebuffers, not generic
111 * framebuffer objects ala GL_EXT_framebuffer_object.
112 *
113 * \sa _mesa_new_framebuffer
114 */
115struct gl_framebuffer *
116_mesa_create_framebuffer(const GLvisual *visual)
117{
118 struct gl_framebuffer *fb = CALLOC_STRUCT(gl_framebuffer);
119 assert(visual);
120 if (fb) {
121 _mesa_initialize_framebuffer(fb, visual);
122 }
123 return fb;
124}
125
126
127/**
128 * Allocate a new gl_framebuffer object.
129 * This is the default function for ctx->Driver.NewFramebuffer().
130 * This is for allocating user-created framebuffers, not window-system
131 * framebuffers!
132 * \sa _mesa_create_framebuffer
133 */
134struct gl_framebuffer *
135_mesa_new_framebuffer(GLcontext *ctx, GLuint name)
136{
137 struct gl_framebuffer *fb;
Brian Paul28b014e2006-04-05 03:05:17 +0000138 (void) ctx;
Brian Paule4b23562005-05-04 20:11:35 +0000139 assert(name != 0);
140 fb = CALLOC_STRUCT(gl_framebuffer);
141 if (fb) {
142 fb->Name = name;
143 fb->RefCount = 1;
Brian Paule4b23562005-05-04 20:11:35 +0000144 fb->ColorDrawBuffer[0] = GL_COLOR_ATTACHMENT0_EXT;
145 fb->_ColorDrawBufferMask[0] = BUFFER_BIT_COLOR0;
146 fb->ColorReadBuffer = GL_COLOR_ATTACHMENT0_EXT;
Brian Paul048b13d2005-09-23 03:22:20 +0000147 fb->_ColorReadBufferIndex = BUFFER_COLOR0;
Brian Paule4b23562005-05-04 20:11:35 +0000148 fb->Delete = _mesa_destroy_framebuffer;
149 }
150 return fb;
151}
152
153
154/**
Brian Paulf084f602005-09-13 23:37:50 +0000155 * Initialize a gl_framebuffer object. Typically used to initialize
156 * window system-created framebuffers, not user-created framebuffers.
Brian Paule4b23562005-05-04 20:11:35 +0000157 * \sa _mesa_create_framebuffer
158 */
159void
160_mesa_initialize_framebuffer(struct gl_framebuffer *fb, const GLvisual *visual)
161{
162 assert(fb);
163 assert(visual);
164
165 _mesa_bzero(fb, sizeof(struct gl_framebuffer));
166
Brian Paulea4fe662006-03-26 05:22:17 +0000167 _glthread_INIT_MUTEX(fb->Mutex);
168
Briane6a93812007-02-26 11:37:37 -0700169 fb->RefCount = 1;
170
Brian Paule4b23562005-05-04 20:11:35 +0000171 /* save the visual */
172 fb->Visual = *visual;
173
174 /* Init glRead/DrawBuffer state */
175 if (visual->doubleBufferMode) {
176 fb->ColorDrawBuffer[0] = GL_BACK;
177 fb->_ColorDrawBufferMask[0] = BUFFER_BIT_BACK_LEFT;
178 fb->ColorReadBuffer = GL_BACK;
Brian Paul048b13d2005-09-23 03:22:20 +0000179 fb->_ColorReadBufferIndex = BUFFER_BACK_LEFT;
Brian Paule4b23562005-05-04 20:11:35 +0000180 }
181 else {
182 fb->ColorDrawBuffer[0] = GL_FRONT;
183 fb->_ColorDrawBufferMask[0] = BUFFER_BIT_FRONT_LEFT;
184 fb->ColorReadBuffer = GL_FRONT;
Brian Paul048b13d2005-09-23 03:22:20 +0000185 fb->_ColorReadBufferIndex = BUFFER_FRONT_LEFT;
Brian Paule4b23562005-05-04 20:11:35 +0000186 }
187
188 fb->Delete = _mesa_destroy_framebuffer;
Brian Pauld95000d2005-09-28 15:46:46 +0000189 fb->_Status = GL_FRAMEBUFFER_COMPLETE_EXT;
Brian Paule4b23562005-05-04 20:11:35 +0000190
191 compute_depth_max(fb);
192}
193
194
195/**
Brian Paule4b23562005-05-04 20:11:35 +0000196 * Deallocate buffer and everything attached to it.
Brian Paulf084f602005-09-13 23:37:50 +0000197 * Typically called via the gl_framebuffer->Delete() method.
Brian Paule4b23562005-05-04 20:11:35 +0000198 */
199void
Brian Paulf084f602005-09-13 23:37:50 +0000200_mesa_destroy_framebuffer(struct gl_framebuffer *fb)
Brian Paule4b23562005-05-04 20:11:35 +0000201{
Brian Paulf084f602005-09-13 23:37:50 +0000202 if (fb) {
203 _mesa_free_framebuffer_data(fb);
Brian Paul84716042005-11-16 04:05:54 +0000204 _mesa_free(fb);
Brian Paule4b23562005-05-04 20:11:35 +0000205 }
206}
207
208
209/**
210 * Free all the data hanging off the given gl_framebuffer, but don't free
211 * the gl_framebuffer object itself.
212 */
213void
214_mesa_free_framebuffer_data(struct gl_framebuffer *fb)
215{
216 GLuint i;
217
218 assert(fb);
219
Briane6a93812007-02-26 11:37:37 -0700220 _glthread_DESTROY_MUTEX(fb->Mutex);
221
Brian Paule4b23562005-05-04 20:11:35 +0000222 for (i = 0; i < BUFFER_COUNT; i++) {
223 struct gl_renderbuffer_attachment *att = &fb->Attachment[i];
Brian Paul753af3a2006-03-25 17:57:52 +0000224 if (att->Renderbuffer) {
Brian Paule4b23562005-05-04 20:11:35 +0000225 struct gl_renderbuffer *rb = att->Renderbuffer;
Brian Paul2eb88c172006-05-20 15:06:35 +0000226 /* remove framebuffer's reference to renderbuffer */
227 _mesa_dereference_renderbuffer(&rb);
228 if (rb && rb->Name == 0) {
229 /* delete window system renderbuffer */
230 _mesa_dereference_renderbuffer(&rb);
Brian Paule4b23562005-05-04 20:11:35 +0000231 }
232 }
233 att->Type = GL_NONE;
234 att->Renderbuffer = NULL;
235 }
Brian Paul84716042005-11-16 04:05:54 +0000236
Brian Paulea4fe662006-03-26 05:22:17 +0000237 /* unbind depth/stencil to decr ref counts */
238 set_depth_renderbuffer(fb, NULL);
239 set_stencil_renderbuffer(fb, NULL);
Brian Paule4b23562005-05-04 20:11:35 +0000240}
241
242
243/**
Brian Paul2eb88c172006-05-20 15:06:35 +0000244 * Decrement the reference count on a framebuffer and delete it when
245 * the refcount hits zero.
246 * Note: we pass the address of a pointer and set it to NULL if we delete it.
247 */
248void
249_mesa_dereference_framebuffer(struct gl_framebuffer **fb)
250{
251 GLboolean deleteFlag = GL_FALSE;
252
253 _glthread_LOCK_MUTEX((*fb)->Mutex);
254 {
255 ASSERT((*fb)->RefCount > 0);
256 (*fb)->RefCount--;
257 deleteFlag = ((*fb)->RefCount == 0);
258 }
259 _glthread_UNLOCK_MUTEX((*fb)->Mutex);
260
261 if (deleteFlag) {
262 (*fb)->Delete(*fb);
263 *fb = NULL;
264 }
265}
266
267
268
269
270/**
Brian Paule4b23562005-05-04 20:11:35 +0000271 * 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).
Brian Paul84716042005-11-16 04:05:54 +0000274 * This will typically be called via ctx->Driver.ResizeBuffers() or directly
275 * from a device driver.
276 *
277 * \note it's possible for ctx to be null since a window can be resized
278 * without a currently bound rendering context.
Brian Paule4b23562005-05-04 20:11:35 +0000279 */
280void
281_mesa_resize_framebuffer(GLcontext *ctx, struct gl_framebuffer *fb,
282 GLuint width, GLuint height)
283{
284 GLuint i;
285
Brian Paulea4fe662006-03-26 05:22:17 +0000286 /* XXX I think we could check if the size is not changing
287 * and return early.
288 */
289
Brian Paule4b23562005-05-04 20:11:35 +0000290 /* For window system framebuffers, Name is zero */
291 assert(fb->Name == 0);
292
293 for (i = 0; i < BUFFER_COUNT; i++) {
294 struct gl_renderbuffer_attachment *att = &fb->Attachment[i];
295 if (att->Type == GL_RENDERBUFFER_EXT && att->Renderbuffer) {
296 struct gl_renderbuffer *rb = att->Renderbuffer;
297 /* only resize if size is changing */
298 if (rb->Width != width || rb->Height != height) {
Brian Paulea4fe662006-03-26 05:22:17 +0000299 /* could just as well pass rb->_ActualFormat here */
Brian Paule4b23562005-05-04 20:11:35 +0000300 if (rb->AllocStorage(ctx, rb, rb->InternalFormat, width, height)) {
Brian Paulea4fe662006-03-26 05:22:17 +0000301 ASSERT(rb->Width == width);
302 ASSERT(rb->Height == height);
Brian Paule4b23562005-05-04 20:11:35 +0000303 }
304 else {
305 _mesa_error(ctx, GL_OUT_OF_MEMORY, "Resizing framebuffer");
Brian Paulea4fe662006-03-26 05:22:17 +0000306 /* no return */
Brian Paule4b23562005-05-04 20:11:35 +0000307 }
308 }
309 }
310 }
311
Brian Paulea4fe662006-03-26 05:22:17 +0000312 if (fb->_DepthBuffer) {
313 struct gl_renderbuffer *rb = fb->_DepthBuffer;
314 if (rb->Width != width || rb->Height != height) {
315 if (!rb->AllocStorage(ctx, rb, rb->InternalFormat, width, height)) {
316 _mesa_error(ctx, GL_OUT_OF_MEMORY, "Resizing framebuffer");
317 }
318 }
319 }
320
321 if (fb->_StencilBuffer) {
322 struct gl_renderbuffer *rb = fb->_StencilBuffer;
323 if (rb->Width != width || rb->Height != height) {
324 if (!rb->AllocStorage(ctx, rb, rb->InternalFormat, width, height)) {
325 _mesa_error(ctx, GL_OUT_OF_MEMORY, "Resizing framebuffer");
326 }
327 }
328 }
329
Brian Paule4b23562005-05-04 20:11:35 +0000330 fb->Width = width;
331 fb->Height = height;
Brian Paul52f686c2005-10-21 21:39:10 +0000332
Brian Paul041d6482006-10-16 17:26:30 +0000333 if (ctx) {
334 /* update scissor / window bounds */
Alan Hourihanefeb0ff12006-06-21 10:58:04 +0000335 _mesa_update_draw_buffer_bounds(ctx);
Brian Paul041d6482006-10-16 17:26:30 +0000336 /* Signal new buffer state so that swrast will update its clipping
337 * info (the CLIP_BIT flag).
338 */
339 ctx->NewState |= _NEW_BUFFERS;
340 }
Brian Paule4b23562005-05-04 20:11:35 +0000341}
342
343
344/**
345 * Examine all the framebuffer's renderbuffers to update the Width/Height
346 * fields of the framebuffer. If we have renderbuffers with different
347 * sizes, set the framebuffer's width and height to zero.
348 * Note: this is only intended for user-created framebuffers, not
349 * window-system framebuffes.
350 */
351static void
352update_framebuffer_size(struct gl_framebuffer *fb)
353{
354 GLboolean haveSize = GL_FALSE;
355 GLuint i;
356
357 /* user-created framebuffers only */
358 assert(fb->Name);
359
360 for (i = 0; i < BUFFER_COUNT; i++) {
361 struct gl_renderbuffer_attachment *att = &fb->Attachment[i];
362 const struct gl_renderbuffer *rb = att->Renderbuffer;
363 if (rb) {
364 if (haveSize) {
365 if (rb->Width != fb->Width && rb->Height != fb->Height) {
366 /* size mismatch! */
367 fb->Width = 0;
368 fb->Height = 0;
369 return;
370 }
371 }
372 else {
373 fb->Width = rb->Width;
374 fb->Height = rb->Height;
375 haveSize = GL_TRUE;
376 }
377 }
378 }
379}
380
381
382/**
383 * Update the context's current drawing buffer's Xmin, Xmax, Ymin, Ymax fields.
384 * These values are computed from the buffer's width and height and
385 * the scissor box, if it's enabled.
386 * \param ctx the GL context.
387 */
388void
389_mesa_update_draw_buffer_bounds(GLcontext *ctx)
390{
391 struct gl_framebuffer *buffer = ctx->DrawBuffer;
392
Alan Hourihane161de102006-06-19 09:27:04 +0000393 if (!buffer)
394 return;
395
Brian Paule4b23562005-05-04 20:11:35 +0000396 if (buffer->Name) {
397 /* user-created framebuffer size depends on the renderbuffers */
398 update_framebuffer_size(buffer);
399 }
400
401 buffer->_Xmin = 0;
402 buffer->_Ymin = 0;
403 buffer->_Xmax = buffer->Width;
404 buffer->_Ymax = buffer->Height;
405
406 if (ctx->Scissor.Enabled) {
407 if (ctx->Scissor.X > buffer->_Xmin) {
408 buffer->_Xmin = ctx->Scissor.X;
409 }
410 if (ctx->Scissor.Y > buffer->_Ymin) {
411 buffer->_Ymin = ctx->Scissor.Y;
412 }
413 if (ctx->Scissor.X + ctx->Scissor.Width < buffer->_Xmax) {
414 buffer->_Xmax = ctx->Scissor.X + ctx->Scissor.Width;
415 }
416 if (ctx->Scissor.Y + ctx->Scissor.Height < buffer->_Ymax) {
417 buffer->_Ymax = ctx->Scissor.Y + ctx->Scissor.Height;
418 }
419 /* finally, check for empty region */
420 if (buffer->_Xmin > buffer->_Xmax) {
421 buffer->_Xmin = buffer->_Xmax;
422 }
423 if (buffer->_Ymin > buffer->_Ymax) {
424 buffer->_Ymin = buffer->_Ymax;
425 }
426 }
427
428 ASSERT(buffer->_Xmin <= buffer->_Xmax);
429 ASSERT(buffer->_Ymin <= buffer->_Ymax);
430}
431
432
433/**
434 * The glGet queries of the framebuffer red/green/blue size, stencil size,
435 * etc. are satisfied by the fields of ctx->DrawBuffer->Visual. These can
Brian Paulf084f602005-09-13 23:37:50 +0000436 * change depending on the renderbuffer bindings. This function updates
Brian Paule4b23562005-05-04 20:11:35 +0000437 * the given framebuffer's Visual from the current renderbuffer bindings.
Brian Paul02aa5fb2006-09-11 15:04:23 +0000438 *
439 * This may apply to user-created framebuffers or window system framebuffers.
Brian Pauleb063cf2005-10-04 14:48:24 +0000440 *
441 * Also note: ctx->DrawBuffer->Visual.depthBits might not equal
442 * ctx->DrawBuffer->Attachment[BUFFER_DEPTH].Renderbuffer.DepthBits.
443 * The former one is used to convert floating point depth values into
444 * integer Z values.
Brian Paule4b23562005-05-04 20:11:35 +0000445 */
446void
447_mesa_update_framebuffer_visual(struct gl_framebuffer *fb)
448{
Brian Paul474f28e2005-10-08 14:41:17 +0000449 GLuint i;
450
Brian Paule4b23562005-05-04 20:11:35 +0000451 _mesa_bzero(&fb->Visual, sizeof(fb->Visual));
Brian Paul474f28e2005-10-08 14:41:17 +0000452 fb->Visual.rgbMode = GL_TRUE; /* assume this */
Brian Paule4b23562005-05-04 20:11:35 +0000453
Brian Paul34b3b402006-04-20 00:45:08 +0000454#if 0 /* this _might_ be needed */
455 if (fb->_Status != GL_FRAMEBUFFER_COMPLETE_EXT) {
456 /* leave visual fields zero'd */
457 return;
458 }
459#endif
460
Brian Paul474f28e2005-10-08 14:41:17 +0000461 /* find first RGB or CI renderbuffer */
462 for (i = 0; i < BUFFER_COUNT; i++) {
463 if (fb->Attachment[i].Renderbuffer) {
464 const struct gl_renderbuffer *rb = fb->Attachment[i].Renderbuffer;
465 if (rb->_BaseFormat == GL_RGBA || rb->_BaseFormat == GL_RGB) {
466 fb->Visual.redBits = rb->RedBits;
467 fb->Visual.greenBits = rb->GreenBits;
468 fb->Visual.blueBits = rb->BlueBits;
469 fb->Visual.alphaBits = rb->AlphaBits;
470 fb->Visual.rgbBits = fb->Visual.redBits
471 + fb->Visual.greenBits + fb->Visual.blueBits;
472 fb->Visual.floatMode = GL_FALSE;
473 break;
474 }
475 else if (rb->_BaseFormat == GL_COLOR_INDEX) {
476 fb->Visual.indexBits = rb->IndexBits;
477 fb->Visual.rgbMode = GL_FALSE;
478 break;
479 }
480 }
Brian Paule4b23562005-05-04 20:11:35 +0000481 }
482
483 if (fb->Attachment[BUFFER_DEPTH].Renderbuffer) {
484 fb->Visual.haveDepthBuffer = GL_TRUE;
485 fb->Visual.depthBits
Brian Paul676d0ac2005-09-22 05:19:57 +0000486 = fb->Attachment[BUFFER_DEPTH].Renderbuffer->DepthBits;
Brian Paule4b23562005-05-04 20:11:35 +0000487 }
488
489 if (fb->Attachment[BUFFER_STENCIL].Renderbuffer) {
490 fb->Visual.haveStencilBuffer = GL_TRUE;
491 fb->Visual.stencilBits
Brian Paul676d0ac2005-09-22 05:19:57 +0000492 = fb->Attachment[BUFFER_STENCIL].Renderbuffer->StencilBits;
Brian Paule4b23562005-05-04 20:11:35 +0000493 }
494
Brian Paul02aa5fb2006-09-11 15:04:23 +0000495 if (fb->Attachment[BUFFER_ACCUM].Renderbuffer) {
496 fb->Visual.haveAccumBuffer = GL_TRUE;
497 fb->Visual.accumRedBits
498 = fb->Attachment[BUFFER_DEPTH].Renderbuffer->RedBits;
499 fb->Visual.accumGreenBits
500 = fb->Attachment[BUFFER_DEPTH].Renderbuffer->GreenBits;
501 fb->Visual.accumBlueBits
502 = fb->Attachment[BUFFER_DEPTH].Renderbuffer->BlueBits;
503 fb->Visual.accumAlphaBits
504 = fb->Attachment[BUFFER_DEPTH].Renderbuffer->AlphaBits;
505 }
506
Brian Paule4b23562005-05-04 20:11:35 +0000507 compute_depth_max(fb);
508}
509
510
511/**
Brian Paulea4fe662006-03-26 05:22:17 +0000512 * Update the framebuffer's _DepthBuffer field using the renderbuffer
513 * found at the given attachment index.
514 *
515 * If that attachment points to a combined GL_DEPTH_STENCIL renderbuffer,
516 * create and install a depth wrapper/adaptor.
517 *
518 * \param fb the framebuffer whose _DepthBuffer field to update
519 * \param attIndex indicates the renderbuffer to possibly wrap
Brian Paul84716042005-11-16 04:05:54 +0000520 */
Brian Paulea4fe662006-03-26 05:22:17 +0000521void
522_mesa_update_depth_buffer(GLcontext *ctx,
523 struct gl_framebuffer *fb,
524 GLuint attIndex)
Brian Paul84716042005-11-16 04:05:54 +0000525{
Brian Paulea4fe662006-03-26 05:22:17 +0000526 struct gl_renderbuffer *depthRb;
527
528 /* only one possiblity for now */
529 ASSERT(attIndex == BUFFER_DEPTH);
530
531 depthRb = fb->Attachment[attIndex].Renderbuffer;
532
533 if (depthRb && depthRb->_ActualFormat == GL_DEPTH24_STENCIL8_EXT) {
534 /* The attached depth buffer is a GL_DEPTH_STENCIL renderbuffer */
Brian Paul57223382006-04-06 04:09:03 +0000535 if (!fb->_DepthBuffer
536 || fb->_DepthBuffer->Wrapped != depthRb
537 || fb->_DepthBuffer->_BaseFormat != GL_DEPTH_COMPONENT) {
Brian Paulea4fe662006-03-26 05:22:17 +0000538 /* need to update wrapper */
539 struct gl_renderbuffer *wrapper
540 = _mesa_new_z24_renderbuffer_wrapper(ctx, depthRb);
541 set_depth_renderbuffer(fb, wrapper);
542 ASSERT(fb->_DepthBuffer->Wrapped == depthRb);
Brian Paul84716042005-11-16 04:05:54 +0000543 }
544 }
Brian Paulea4fe662006-03-26 05:22:17 +0000545 else {
546 /* depthRb may be null */
547 set_depth_renderbuffer(fb, depthRb);
548 }
Brian Paul84716042005-11-16 04:05:54 +0000549}
550
Brian Paulea4fe662006-03-26 05:22:17 +0000551
Brian Paul84716042005-11-16 04:05:54 +0000552/**
Brian Paulea4fe662006-03-26 05:22:17 +0000553 * Update the framebuffer's _StencilBuffer field using the renderbuffer
554 * found at the given attachment index.
555 *
556 * If that attachment points to a combined GL_DEPTH_STENCIL renderbuffer,
557 * create and install a stencil wrapper/adaptor.
558 *
559 * \param fb the framebuffer whose _StencilBuffer field to update
560 * \param attIndex indicates the renderbuffer to possibly wrap
Brian Paul84716042005-11-16 04:05:54 +0000561 */
Brian Paulea4fe662006-03-26 05:22:17 +0000562void
563_mesa_update_stencil_buffer(GLcontext *ctx,
564 struct gl_framebuffer *fb,
565 GLuint attIndex)
Brian Paul84716042005-11-16 04:05:54 +0000566{
Brian Paulea4fe662006-03-26 05:22:17 +0000567 struct gl_renderbuffer *stencilRb;
568
569 ASSERT(attIndex == BUFFER_DEPTH ||
570 attIndex == BUFFER_STENCIL);
571
572 stencilRb = fb->Attachment[attIndex].Renderbuffer;
573
574 if (stencilRb && stencilRb->_ActualFormat == GL_DEPTH24_STENCIL8_EXT) {
575 /* The attached stencil buffer is a GL_DEPTH_STENCIL renderbuffer */
Brian Paul57223382006-04-06 04:09:03 +0000576 if (!fb->_StencilBuffer
577 || fb->_StencilBuffer->Wrapped != stencilRb
578 || fb->_StencilBuffer->_BaseFormat != GL_STENCIL_INDEX) {
Brian Paulea4fe662006-03-26 05:22:17 +0000579 /* need to update wrapper */
580 struct gl_renderbuffer *wrapper
581 = _mesa_new_s8_renderbuffer_wrapper(ctx, stencilRb);
582 set_stencil_renderbuffer(fb, wrapper);
583 ASSERT(fb->_StencilBuffer->Wrapped == stencilRb);
Brian Paul84716042005-11-16 04:05:54 +0000584 }
585 }
Brian Paulea4fe662006-03-26 05:22:17 +0000586 else {
587 /* stencilRb may be null */
588 set_stencil_renderbuffer(fb, stencilRb);
589 }
590}
591
592
593/**
594 * Update the list of color drawing renderbuffer pointers.
595 * Later, when we're rendering we'll loop from 0 to _NumColorDrawBuffers
596 * writing colors.
597 */
598static void
599update_color_draw_buffers(GLcontext *ctx, struct gl_framebuffer *fb)
600{
601 GLuint output;
602
603 /*
604 * Fragment programs can write to multiple colorbuffers with
605 * the GL_ARB_draw_buffers extension.
606 */
607 for (output = 0; output < ctx->Const.MaxDrawBuffers; output++) {
608 GLbitfield bufferMask = fb->_ColorDrawBufferMask[output];
609 GLuint count = 0;
610 GLuint i;
Briane6a93812007-02-26 11:37:37 -0700611 if (!fb->DeletePending) {
612 /* We need the inner loop here because glDrawBuffer(GL_FRONT_AND_BACK)
613 * can specify writing to two or four color buffers (for example).
614 */
615 for (i = 0; bufferMask && i < BUFFER_COUNT; i++) {
616 const GLuint bufferBit = 1 << i;
617 if (bufferBit & bufferMask) {
618 struct gl_renderbuffer *rb = fb->Attachment[i].Renderbuffer;
619 if (rb) {
620 fb->_ColorDrawBuffers[output][count] = rb;
621 count++;
622 }
623 else {
624 /*
625 _mesa_warning(ctx, "DrawBuffer names a missing buffer!\n");
626 */
627 }
628 bufferMask &= ~bufferBit;
Brian Paulea4fe662006-03-26 05:22:17 +0000629 }
Brian Paulea4fe662006-03-26 05:22:17 +0000630 }
631 }
632 fb->_NumColorDrawBuffers[output] = count;
633 }
634}
635
636
637/**
638 * Update the color read renderbuffer pointer.
639 * Unlike the DrawBuffer, we can only read from one (or zero) color buffers.
640 */
641static void
642update_color_read_buffer(GLcontext *ctx, struct gl_framebuffer *fb)
643{
Brian Paul28b014e2006-04-05 03:05:17 +0000644 (void) ctx;
Briane6a93812007-02-26 11:37:37 -0700645 if (fb->_ColorReadBufferIndex == -1 || fb->DeletePending) {
Brian Paulea4fe662006-03-26 05:22:17 +0000646 fb->_ColorReadBuffer = NULL; /* legal! */
647 }
648 else {
649 ASSERT(fb->_ColorReadBufferIndex >= 0);
650 ASSERT(fb->_ColorReadBufferIndex < BUFFER_COUNT);
651 fb->_ColorReadBuffer
652 = fb->Attachment[fb->_ColorReadBufferIndex].Renderbuffer;
653 }
Brian Paul84716042005-11-16 04:05:54 +0000654}
655
656
657/**
Brian Paule4b23562005-05-04 20:11:35 +0000658 * Update state related to the current draw/read framebuffers.
Brian Paul52783592005-08-31 21:38:53 +0000659 * Specifically, update these framebuffer fields:
660 * _ColorDrawBuffers
Brian Paul52783592005-08-31 21:38:53 +0000661 * _NumColorDrawBuffers
662 * _ColorReadBuffer
Brian Paul0f29ef62005-11-16 04:17:20 +0000663 * _DepthBuffer
664 * _StencilBuffer
Brian Paule4b23562005-05-04 20:11:35 +0000665 * If the current framebuffer is user-created, make sure it's complete.
Brian Paul52783592005-08-31 21:38:53 +0000666 * The following functions can effect this state: glReadBuffer,
Brian Paul0f29ef62005-11-16 04:17:20 +0000667 * glDrawBuffer, glDrawBuffersARB, glFramebufferRenderbufferEXT,
668 * glRenderbufferStorageEXT.
Brian Paule4b23562005-05-04 20:11:35 +0000669 */
670void
671_mesa_update_framebuffer(GLcontext *ctx)
672{
673 struct gl_framebuffer *fb = ctx->DrawBuffer;
Brian Paule4b23562005-05-04 20:11:35 +0000674
675 /* Completeness only matters for user-created framebuffers */
Brian Paul474f28e2005-10-08 14:41:17 +0000676 if (fb->Name != 0) {
Brian Paule4b23562005-05-04 20:11:35 +0000677 _mesa_test_framebuffer_completeness(ctx, fb);
Brian Paul474f28e2005-10-08 14:41:17 +0000678 _mesa_update_framebuffer_visual(fb);
679 }
Brian Paule4b23562005-05-04 20:11:35 +0000680
Brian Paulea4fe662006-03-26 05:22:17 +0000681 update_color_draw_buffers(ctx, fb);
682 update_color_read_buffer(ctx, fb);
683 _mesa_update_depth_buffer(ctx, fb, BUFFER_DEPTH);
684 _mesa_update_stencil_buffer(ctx, fb, BUFFER_STENCIL);
Brian Paul84716042005-11-16 04:05:54 +0000685
Brian Paule4b23562005-05-04 20:11:35 +0000686 compute_depth_max(fb);
687}
Brian Paul7275d4d2006-03-20 15:25:18 +0000688
689
690/**
691 * Check if the renderbuffer for a read operation (glReadPixels, glCopyPixels,
692 * glCopyTex[Sub]Image, etc. exists.
693 * \param format a basic image format such as GL_RGB, GL_RGBA, GL_ALPHA,
694 * GL_DEPTH_COMPONENT, etc. or GL_COLOR, GL_DEPTH, GL_STENCIL.
695 * \return GL_TRUE if buffer exists, GL_FALSE otherwise
696 */
697GLboolean
698_mesa_source_buffer_exists(GLcontext *ctx, GLenum format)
699{
700 const struct gl_renderbuffer_attachment *att
701 = ctx->ReadBuffer->Attachment;
702
703 if (ctx->ReadBuffer->_Status != GL_FRAMEBUFFER_COMPLETE_EXT) {
704 return GL_FALSE;
705 }
706
707 switch (format) {
708 case GL_COLOR:
Brian Paul590cd262006-03-24 22:53:00 +0000709 case GL_RED:
710 case GL_GREEN:
711 case GL_BLUE:
Brian Paul7275d4d2006-03-20 15:25:18 +0000712 case GL_ALPHA:
713 case GL_LUMINANCE:
714 case GL_LUMINANCE_ALPHA:
715 case GL_INTENSITY:
716 case GL_RGB:
Brian Paul590cd262006-03-24 22:53:00 +0000717 case GL_BGR:
Brian Paul7275d4d2006-03-20 15:25:18 +0000718 case GL_RGBA:
Brian Paul590cd262006-03-24 22:53:00 +0000719 case GL_BGRA:
720 case GL_ABGR_EXT:
Brian Paul7275d4d2006-03-20 15:25:18 +0000721 case GL_COLOR_INDEX:
722 if (ctx->ReadBuffer->_ColorReadBuffer == NULL) {
723 return GL_FALSE;
724 }
Brian Paul84c5d0a2006-03-30 16:29:41 +0000725 /* XXX enable this post 6.5 release:
726 ASSERT(ctx->ReadBuffer->_ColorReadBuffer->RedBits > 0 ||
727 ctx->ReadBuffer->_ColorReadBuffer->IndexBits > 0);
728 */
Brian Paul7275d4d2006-03-20 15:25:18 +0000729 break;
730 case GL_DEPTH:
731 case GL_DEPTH_COMPONENT:
732 if (!att[BUFFER_DEPTH].Renderbuffer) {
733 return GL_FALSE;
734 }
735 ASSERT(att[BUFFER_DEPTH].Renderbuffer->DepthBits > 0);
736 break;
737 case GL_STENCIL:
738 case GL_STENCIL_INDEX:
739 if (!att[BUFFER_STENCIL].Renderbuffer) {
740 return GL_FALSE;
741 }
742 ASSERT(att[BUFFER_STENCIL].Renderbuffer->StencilBits > 0);
743 break;
744 case GL_DEPTH_STENCIL_EXT:
745 if (!att[BUFFER_DEPTH].Renderbuffer ||
746 !att[BUFFER_STENCIL].Renderbuffer) {
747 return GL_FALSE;
748 }
749 ASSERT(att[BUFFER_DEPTH].Renderbuffer->DepthBits > 0);
750 ASSERT(att[BUFFER_STENCIL].Renderbuffer->StencilBits > 0);
751 break;
752 default:
753 _mesa_problem(ctx,
Brian Paul590cd262006-03-24 22:53:00 +0000754 "Unexpected format 0x%x in _mesa_source_buffer_exists",
755 format);
Brian Paul7275d4d2006-03-20 15:25:18 +0000756 return GL_FALSE;
757 }
758
759 /* OK */
760 return GL_TRUE;
761}
762
763
764/**
765 * As above, but for drawing operations.
766 * XXX code do some code merging w/ above function.
767 */
768GLboolean
769_mesa_dest_buffer_exists(GLcontext *ctx, GLenum format)
770{
771 const struct gl_renderbuffer_attachment *att
772 = ctx->ReadBuffer->Attachment;
773
774 if (ctx->DrawBuffer->_Status != GL_FRAMEBUFFER_COMPLETE_EXT) {
775 return GL_FALSE;
776 }
777
778 switch (format) {
779 case GL_COLOR:
Brian Paul590cd262006-03-24 22:53:00 +0000780 case GL_RED:
781 case GL_GREEN:
782 case GL_BLUE:
Brian Paul7275d4d2006-03-20 15:25:18 +0000783 case GL_ALPHA:
784 case GL_LUMINANCE:
785 case GL_LUMINANCE_ALPHA:
786 case GL_INTENSITY:
787 case GL_RGB:
Brian Paul590cd262006-03-24 22:53:00 +0000788 case GL_BGR:
Brian Paul7275d4d2006-03-20 15:25:18 +0000789 case GL_RGBA:
Brian Paul590cd262006-03-24 22:53:00 +0000790 case GL_BGRA:
791 case GL_ABGR_EXT:
Brian Paul7275d4d2006-03-20 15:25:18 +0000792 case GL_COLOR_INDEX:
793 /* nothing special */
Brian Paul84c5d0a2006-03-30 16:29:41 +0000794 /* Could assert that colorbuffer has RedBits > 0 */
Brian Paul7275d4d2006-03-20 15:25:18 +0000795 break;
796 case GL_DEPTH:
797 case GL_DEPTH_COMPONENT:
798 if (!att[BUFFER_DEPTH].Renderbuffer) {
799 return GL_FALSE;
800 }
801 ASSERT(att[BUFFER_DEPTH].Renderbuffer->DepthBits > 0);
802 break;
803 case GL_STENCIL:
804 case GL_STENCIL_INDEX:
805 if (!att[BUFFER_STENCIL].Renderbuffer) {
806 return GL_FALSE;
807 }
808 ASSERT(att[BUFFER_STENCIL].Renderbuffer->StencilBits > 0);
809 break;
810 case GL_DEPTH_STENCIL_EXT:
811 if (!att[BUFFER_DEPTH].Renderbuffer ||
812 !att[BUFFER_STENCIL].Renderbuffer) {
813 return GL_FALSE;
814 }
815 ASSERT(att[BUFFER_DEPTH].Renderbuffer->DepthBits > 0);
816 ASSERT(att[BUFFER_STENCIL].Renderbuffer->StencilBits > 0);
817 break;
818 default:
819 _mesa_problem(ctx,
Brian Paul590cd262006-03-24 22:53:00 +0000820 "Unexpected format 0x%x in _mesa_source_buffer_exists",
821 format);
Brian Paul7275d4d2006-03-20 15:25:18 +0000822 return GL_FALSE;
823 }
824
825 /* OK */
826 return GL_TRUE;
827}