blob: 4d6871bb7d063ba80a790e44602362c611292aa4 [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
Brian Paule4b23562005-05-04 20:11:35 +0000169 /* save the visual */
170 fb->Visual = *visual;
171
172 /* Init glRead/DrawBuffer state */
173 if (visual->doubleBufferMode) {
174 fb->ColorDrawBuffer[0] = GL_BACK;
175 fb->_ColorDrawBufferMask[0] = BUFFER_BIT_BACK_LEFT;
176 fb->ColorReadBuffer = GL_BACK;
Brian Paul048b13d2005-09-23 03:22:20 +0000177 fb->_ColorReadBufferIndex = BUFFER_BACK_LEFT;
Brian Paule4b23562005-05-04 20:11:35 +0000178 }
179 else {
180 fb->ColorDrawBuffer[0] = GL_FRONT;
181 fb->_ColorDrawBufferMask[0] = BUFFER_BIT_FRONT_LEFT;
182 fb->ColorReadBuffer = GL_FRONT;
Brian Paul048b13d2005-09-23 03:22:20 +0000183 fb->_ColorReadBufferIndex = BUFFER_FRONT_LEFT;
Brian Paule4b23562005-05-04 20:11:35 +0000184 }
185
186 fb->Delete = _mesa_destroy_framebuffer;
Brian Pauld95000d2005-09-28 15:46:46 +0000187 fb->_Status = GL_FRAMEBUFFER_COMPLETE_EXT;
Brian Paule4b23562005-05-04 20:11:35 +0000188
189 compute_depth_max(fb);
190}
191
192
193/**
Brian Paule4b23562005-05-04 20:11:35 +0000194 * Deallocate buffer and everything attached to it.
Brian Paulf084f602005-09-13 23:37:50 +0000195 * Typically called via the gl_framebuffer->Delete() method.
Brian Paule4b23562005-05-04 20:11:35 +0000196 */
197void
Brian Paulf084f602005-09-13 23:37:50 +0000198_mesa_destroy_framebuffer(struct gl_framebuffer *fb)
Brian Paule4b23562005-05-04 20:11:35 +0000199{
Brian Paulf084f602005-09-13 23:37:50 +0000200 if (fb) {
Brian Paulea4fe662006-03-26 05:22:17 +0000201 _glthread_DESTROY_MUTEX(fb->Mutex);
Brian Paulf084f602005-09-13 23:37:50 +0000202 _mesa_free_framebuffer_data(fb);
Brian Paul84716042005-11-16 04:05:54 +0000203 _mesa_free(fb);
Brian Paule4b23562005-05-04 20:11:35 +0000204 }
205}
206
207
208/**
209 * Free all the data hanging off the given gl_framebuffer, but don't free
210 * the gl_framebuffer object itself.
211 */
212void
213_mesa_free_framebuffer_data(struct gl_framebuffer *fb)
214{
215 GLuint i;
216
217 assert(fb);
218
219 for (i = 0; i < BUFFER_COUNT; i++) {
220 struct gl_renderbuffer_attachment *att = &fb->Attachment[i];
Brian Paul753af3a2006-03-25 17:57:52 +0000221 if (att->Renderbuffer) {
Brian Paule4b23562005-05-04 20:11:35 +0000222 struct gl_renderbuffer *rb = att->Renderbuffer;
Brian Paul2eb88c172006-05-20 15:06:35 +0000223 /* remove framebuffer's reference to renderbuffer */
224 _mesa_dereference_renderbuffer(&rb);
225 if (rb && rb->Name == 0) {
226 /* delete window system renderbuffer */
227 _mesa_dereference_renderbuffer(&rb);
Brian Paule4b23562005-05-04 20:11:35 +0000228 }
229 }
230 att->Type = GL_NONE;
231 att->Renderbuffer = NULL;
232 }
Brian Paul84716042005-11-16 04:05:54 +0000233
Brian Paulea4fe662006-03-26 05:22:17 +0000234 /* unbind depth/stencil to decr ref counts */
235 set_depth_renderbuffer(fb, NULL);
236 set_stencil_renderbuffer(fb, NULL);
Brian Paule4b23562005-05-04 20:11:35 +0000237}
238
239
240/**
Brian Paul2eb88c172006-05-20 15:06:35 +0000241 * Decrement the reference count on a framebuffer and delete it when
242 * the refcount hits zero.
243 * Note: we pass the address of a pointer and set it to NULL if we delete it.
244 */
245void
246_mesa_dereference_framebuffer(struct gl_framebuffer **fb)
247{
248 GLboolean deleteFlag = GL_FALSE;
249
250 _glthread_LOCK_MUTEX((*fb)->Mutex);
251 {
252 ASSERT((*fb)->RefCount > 0);
253 (*fb)->RefCount--;
254 deleteFlag = ((*fb)->RefCount == 0);
255 }
256 _glthread_UNLOCK_MUTEX((*fb)->Mutex);
257
258 if (deleteFlag) {
259 (*fb)->Delete(*fb);
260 *fb = NULL;
261 }
262}
263
264
265
266
267/**
Brian Paule4b23562005-05-04 20:11:35 +0000268 * Resize the given framebuffer's renderbuffers to the new width and height.
269 * This should only be used for window-system framebuffers, not
270 * user-created renderbuffers (i.e. made with GL_EXT_framebuffer_object).
Brian Paul84716042005-11-16 04:05:54 +0000271 * This will typically be called via ctx->Driver.ResizeBuffers() or directly
272 * from a device driver.
273 *
274 * \note it's possible for ctx to be null since a window can be resized
275 * without a currently bound rendering context.
Brian Paule4b23562005-05-04 20:11:35 +0000276 */
277void
278_mesa_resize_framebuffer(GLcontext *ctx, struct gl_framebuffer *fb,
279 GLuint width, GLuint height)
280{
281 GLuint i;
282
Brian Paulea4fe662006-03-26 05:22:17 +0000283 /* XXX I think we could check if the size is not changing
284 * and return early.
285 */
286
Brian Paule4b23562005-05-04 20:11:35 +0000287 /* For window system framebuffers, Name is zero */
288 assert(fb->Name == 0);
289
290 for (i = 0; i < BUFFER_COUNT; i++) {
291 struct gl_renderbuffer_attachment *att = &fb->Attachment[i];
292 if (att->Type == GL_RENDERBUFFER_EXT && att->Renderbuffer) {
293 struct gl_renderbuffer *rb = att->Renderbuffer;
294 /* only resize if size is changing */
295 if (rb->Width != width || rb->Height != height) {
Brian Paulea4fe662006-03-26 05:22:17 +0000296 /* could just as well pass rb->_ActualFormat here */
Brian Paule4b23562005-05-04 20:11:35 +0000297 if (rb->AllocStorage(ctx, rb, rb->InternalFormat, width, height)) {
Brian Paulea4fe662006-03-26 05:22:17 +0000298 ASSERT(rb->Width == width);
299 ASSERT(rb->Height == height);
Brian Paule4b23562005-05-04 20:11:35 +0000300 }
301 else {
302 _mesa_error(ctx, GL_OUT_OF_MEMORY, "Resizing framebuffer");
Brian Paulea4fe662006-03-26 05:22:17 +0000303 /* no return */
Brian Paule4b23562005-05-04 20:11:35 +0000304 }
305 }
306 }
307 }
308
Brian Paulea4fe662006-03-26 05:22:17 +0000309 if (fb->_DepthBuffer) {
310 struct gl_renderbuffer *rb = fb->_DepthBuffer;
311 if (rb->Width != width || rb->Height != height) {
312 if (!rb->AllocStorage(ctx, rb, rb->InternalFormat, width, height)) {
313 _mesa_error(ctx, GL_OUT_OF_MEMORY, "Resizing framebuffer");
314 }
315 }
316 }
317
318 if (fb->_StencilBuffer) {
319 struct gl_renderbuffer *rb = fb->_StencilBuffer;
320 if (rb->Width != width || rb->Height != height) {
321 if (!rb->AllocStorage(ctx, rb, rb->InternalFormat, width, height)) {
322 _mesa_error(ctx, GL_OUT_OF_MEMORY, "Resizing framebuffer");
323 }
324 }
325 }
326
Brian Paule4b23562005-05-04 20:11:35 +0000327 fb->Width = width;
328 fb->Height = height;
Brian Paul52f686c2005-10-21 21:39:10 +0000329
330 /* to update scissor / window bounds */
Brian Paulea4fe662006-03-26 05:22:17 +0000331 _mesa_update_draw_buffer_bounds(ctx);
Brian Paule4b23562005-05-04 20:11:35 +0000332}
333
334
335/**
336 * Examine all the framebuffer's renderbuffers to update the Width/Height
337 * fields of the framebuffer. If we have renderbuffers with different
338 * sizes, set the framebuffer's width and height to zero.
339 * Note: this is only intended for user-created framebuffers, not
340 * window-system framebuffes.
341 */
342static void
343update_framebuffer_size(struct gl_framebuffer *fb)
344{
345 GLboolean haveSize = GL_FALSE;
346 GLuint i;
347
348 /* user-created framebuffers only */
349 assert(fb->Name);
350
351 for (i = 0; i < BUFFER_COUNT; i++) {
352 struct gl_renderbuffer_attachment *att = &fb->Attachment[i];
353 const struct gl_renderbuffer *rb = att->Renderbuffer;
354 if (rb) {
355 if (haveSize) {
356 if (rb->Width != fb->Width && rb->Height != fb->Height) {
357 /* size mismatch! */
358 fb->Width = 0;
359 fb->Height = 0;
360 return;
361 }
362 }
363 else {
364 fb->Width = rb->Width;
365 fb->Height = rb->Height;
366 haveSize = GL_TRUE;
367 }
368 }
369 }
370}
371
372
373/**
374 * Update the context's current drawing buffer's Xmin, Xmax, Ymin, Ymax fields.
375 * These values are computed from the buffer's width and height and
376 * the scissor box, if it's enabled.
377 * \param ctx the GL context.
378 */
379void
380_mesa_update_draw_buffer_bounds(GLcontext *ctx)
381{
382 struct gl_framebuffer *buffer = ctx->DrawBuffer;
383
384 if (buffer->Name) {
385 /* user-created framebuffer size depends on the renderbuffers */
386 update_framebuffer_size(buffer);
387 }
388
389 buffer->_Xmin = 0;
390 buffer->_Ymin = 0;
391 buffer->_Xmax = buffer->Width;
392 buffer->_Ymax = buffer->Height;
393
394 if (ctx->Scissor.Enabled) {
395 if (ctx->Scissor.X > buffer->_Xmin) {
396 buffer->_Xmin = ctx->Scissor.X;
397 }
398 if (ctx->Scissor.Y > buffer->_Ymin) {
399 buffer->_Ymin = ctx->Scissor.Y;
400 }
401 if (ctx->Scissor.X + ctx->Scissor.Width < buffer->_Xmax) {
402 buffer->_Xmax = ctx->Scissor.X + ctx->Scissor.Width;
403 }
404 if (ctx->Scissor.Y + ctx->Scissor.Height < buffer->_Ymax) {
405 buffer->_Ymax = ctx->Scissor.Y + ctx->Scissor.Height;
406 }
407 /* finally, check for empty region */
408 if (buffer->_Xmin > buffer->_Xmax) {
409 buffer->_Xmin = buffer->_Xmax;
410 }
411 if (buffer->_Ymin > buffer->_Ymax) {
412 buffer->_Ymin = buffer->_Ymax;
413 }
414 }
415
416 ASSERT(buffer->_Xmin <= buffer->_Xmax);
417 ASSERT(buffer->_Ymin <= buffer->_Ymax);
418}
419
420
421/**
422 * The glGet queries of the framebuffer red/green/blue size, stencil size,
423 * etc. are satisfied by the fields of ctx->DrawBuffer->Visual. These can
Brian Paulf084f602005-09-13 23:37:50 +0000424 * change depending on the renderbuffer bindings. This function updates
Brian Paule4b23562005-05-04 20:11:35 +0000425 * the given framebuffer's Visual from the current renderbuffer bindings.
426 * This is only intended for user-created framebuffers.
Brian Pauleb063cf2005-10-04 14:48:24 +0000427 *
428 * Also note: ctx->DrawBuffer->Visual.depthBits might not equal
429 * ctx->DrawBuffer->Attachment[BUFFER_DEPTH].Renderbuffer.DepthBits.
430 * The former one is used to convert floating point depth values into
431 * integer Z values.
Brian Paule4b23562005-05-04 20:11:35 +0000432 */
433void
434_mesa_update_framebuffer_visual(struct gl_framebuffer *fb)
435{
Brian Paul474f28e2005-10-08 14:41:17 +0000436 GLuint i;
437
Brian Paule4b23562005-05-04 20:11:35 +0000438 _mesa_bzero(&fb->Visual, sizeof(fb->Visual));
Brian Paul474f28e2005-10-08 14:41:17 +0000439 fb->Visual.rgbMode = GL_TRUE; /* assume this */
Brian Paule4b23562005-05-04 20:11:35 +0000440
Brian Paul34b3b402006-04-20 00:45:08 +0000441#if 0 /* this _might_ be needed */
442 if (fb->_Status != GL_FRAMEBUFFER_COMPLETE_EXT) {
443 /* leave visual fields zero'd */
444 return;
445 }
446#endif
447
Brian Paul474f28e2005-10-08 14:41:17 +0000448 /* find first RGB or CI renderbuffer */
449 for (i = 0; i < BUFFER_COUNT; i++) {
450 if (fb->Attachment[i].Renderbuffer) {
451 const struct gl_renderbuffer *rb = fb->Attachment[i].Renderbuffer;
452 if (rb->_BaseFormat == GL_RGBA || rb->_BaseFormat == GL_RGB) {
453 fb->Visual.redBits = rb->RedBits;
454 fb->Visual.greenBits = rb->GreenBits;
455 fb->Visual.blueBits = rb->BlueBits;
456 fb->Visual.alphaBits = rb->AlphaBits;
457 fb->Visual.rgbBits = fb->Visual.redBits
458 + fb->Visual.greenBits + fb->Visual.blueBits;
459 fb->Visual.floatMode = GL_FALSE;
460 break;
461 }
462 else if (rb->_BaseFormat == GL_COLOR_INDEX) {
463 fb->Visual.indexBits = rb->IndexBits;
464 fb->Visual.rgbMode = GL_FALSE;
465 break;
466 }
467 }
Brian Paule4b23562005-05-04 20:11:35 +0000468 }
469
470 if (fb->Attachment[BUFFER_DEPTH].Renderbuffer) {
471 fb->Visual.haveDepthBuffer = GL_TRUE;
472 fb->Visual.depthBits
Brian Paul676d0ac2005-09-22 05:19:57 +0000473 = fb->Attachment[BUFFER_DEPTH].Renderbuffer->DepthBits;
Brian Paule4b23562005-05-04 20:11:35 +0000474 }
475
476 if (fb->Attachment[BUFFER_STENCIL].Renderbuffer) {
477 fb->Visual.haveStencilBuffer = GL_TRUE;
478 fb->Visual.stencilBits
Brian Paul676d0ac2005-09-22 05:19:57 +0000479 = fb->Attachment[BUFFER_STENCIL].Renderbuffer->StencilBits;
Brian Paule4b23562005-05-04 20:11:35 +0000480 }
481
482 compute_depth_max(fb);
483}
484
485
486/**
Brian Paulea4fe662006-03-26 05:22:17 +0000487 * Update the framebuffer's _DepthBuffer field using the renderbuffer
488 * found at the given attachment index.
489 *
490 * If that attachment points to a combined GL_DEPTH_STENCIL renderbuffer,
491 * create and install a depth wrapper/adaptor.
492 *
493 * \param fb the framebuffer whose _DepthBuffer field to update
494 * \param attIndex indicates the renderbuffer to possibly wrap
Brian Paul84716042005-11-16 04:05:54 +0000495 */
Brian Paulea4fe662006-03-26 05:22:17 +0000496void
497_mesa_update_depth_buffer(GLcontext *ctx,
498 struct gl_framebuffer *fb,
499 GLuint attIndex)
Brian Paul84716042005-11-16 04:05:54 +0000500{
Brian Paulea4fe662006-03-26 05:22:17 +0000501 struct gl_renderbuffer *depthRb;
502
503 /* only one possiblity for now */
504 ASSERT(attIndex == BUFFER_DEPTH);
505
506 depthRb = fb->Attachment[attIndex].Renderbuffer;
507
508 if (depthRb && depthRb->_ActualFormat == GL_DEPTH24_STENCIL8_EXT) {
509 /* The attached depth buffer is a GL_DEPTH_STENCIL renderbuffer */
Brian Paul57223382006-04-06 04:09:03 +0000510 if (!fb->_DepthBuffer
511 || fb->_DepthBuffer->Wrapped != depthRb
512 || fb->_DepthBuffer->_BaseFormat != GL_DEPTH_COMPONENT) {
Brian Paulea4fe662006-03-26 05:22:17 +0000513 /* need to update wrapper */
514 struct gl_renderbuffer *wrapper
515 = _mesa_new_z24_renderbuffer_wrapper(ctx, depthRb);
516 set_depth_renderbuffer(fb, wrapper);
517 ASSERT(fb->_DepthBuffer->Wrapped == depthRb);
Brian Paul84716042005-11-16 04:05:54 +0000518 }
519 }
Brian Paulea4fe662006-03-26 05:22:17 +0000520 else {
521 /* depthRb may be null */
522 set_depth_renderbuffer(fb, depthRb);
523 }
Brian Paul84716042005-11-16 04:05:54 +0000524}
525
Brian Paulea4fe662006-03-26 05:22:17 +0000526
Brian Paul84716042005-11-16 04:05:54 +0000527/**
Brian Paulea4fe662006-03-26 05:22:17 +0000528 * Update the framebuffer's _StencilBuffer field using the renderbuffer
529 * found at the given attachment index.
530 *
531 * If that attachment points to a combined GL_DEPTH_STENCIL renderbuffer,
532 * create and install a stencil wrapper/adaptor.
533 *
534 * \param fb the framebuffer whose _StencilBuffer field to update
535 * \param attIndex indicates the renderbuffer to possibly wrap
Brian Paul84716042005-11-16 04:05:54 +0000536 */
Brian Paulea4fe662006-03-26 05:22:17 +0000537void
538_mesa_update_stencil_buffer(GLcontext *ctx,
539 struct gl_framebuffer *fb,
540 GLuint attIndex)
Brian Paul84716042005-11-16 04:05:54 +0000541{
Brian Paulea4fe662006-03-26 05:22:17 +0000542 struct gl_renderbuffer *stencilRb;
543
544 ASSERT(attIndex == BUFFER_DEPTH ||
545 attIndex == BUFFER_STENCIL);
546
547 stencilRb = fb->Attachment[attIndex].Renderbuffer;
548
549 if (stencilRb && stencilRb->_ActualFormat == GL_DEPTH24_STENCIL8_EXT) {
550 /* The attached stencil buffer is a GL_DEPTH_STENCIL renderbuffer */
Brian Paul57223382006-04-06 04:09:03 +0000551 if (!fb->_StencilBuffer
552 || fb->_StencilBuffer->Wrapped != stencilRb
553 || fb->_StencilBuffer->_BaseFormat != GL_STENCIL_INDEX) {
Brian Paulea4fe662006-03-26 05:22:17 +0000554 /* need to update wrapper */
555 struct gl_renderbuffer *wrapper
556 = _mesa_new_s8_renderbuffer_wrapper(ctx, stencilRb);
557 set_stencil_renderbuffer(fb, wrapper);
558 ASSERT(fb->_StencilBuffer->Wrapped == stencilRb);
Brian Paul84716042005-11-16 04:05:54 +0000559 }
560 }
Brian Paulea4fe662006-03-26 05:22:17 +0000561 else {
562 /* stencilRb may be null */
563 set_stencil_renderbuffer(fb, stencilRb);
564 }
565}
566
567
568/**
569 * Update the list of color drawing renderbuffer pointers.
570 * Later, when we're rendering we'll loop from 0 to _NumColorDrawBuffers
571 * writing colors.
572 */
573static void
574update_color_draw_buffers(GLcontext *ctx, struct gl_framebuffer *fb)
575{
576 GLuint output;
577
578 /*
579 * Fragment programs can write to multiple colorbuffers with
580 * the GL_ARB_draw_buffers extension.
581 */
582 for (output = 0; output < ctx->Const.MaxDrawBuffers; output++) {
583 GLbitfield bufferMask = fb->_ColorDrawBufferMask[output];
584 GLuint count = 0;
585 GLuint i;
586 /* We need the inner loop here because glDrawBuffer(GL_FRONT_AND_BACK)
587 * can specify writing to two or four color buffers (for example).
588 */
589 for (i = 0; bufferMask && i < BUFFER_COUNT; i++) {
590 const GLuint bufferBit = 1 << i;
591 if (bufferBit & bufferMask) {
592 struct gl_renderbuffer *rb = fb->Attachment[i].Renderbuffer;
593 if (rb) {
594 fb->_ColorDrawBuffers[output][count] = rb;
595 count++;
596 }
597 else {
598 /*_mesa_warning(ctx, "DrawBuffer names a missing buffer!\n");*/
599 }
600 bufferMask &= ~bufferBit;
601 }
602 }
603 fb->_NumColorDrawBuffers[output] = count;
604 }
605}
606
607
608/**
609 * Update the color read renderbuffer pointer.
610 * Unlike the DrawBuffer, we can only read from one (or zero) color buffers.
611 */
612static void
613update_color_read_buffer(GLcontext *ctx, struct gl_framebuffer *fb)
614{
Brian Paul28b014e2006-04-05 03:05:17 +0000615 (void) ctx;
Brian Paulea4fe662006-03-26 05:22:17 +0000616 if (fb->_ColorReadBufferIndex == -1) {
617 fb->_ColorReadBuffer = NULL; /* legal! */
618 }
619 else {
620 ASSERT(fb->_ColorReadBufferIndex >= 0);
621 ASSERT(fb->_ColorReadBufferIndex < BUFFER_COUNT);
622 fb->_ColorReadBuffer
623 = fb->Attachment[fb->_ColorReadBufferIndex].Renderbuffer;
624 }
Brian Paul84716042005-11-16 04:05:54 +0000625}
626
627
628/**
Brian Paule4b23562005-05-04 20:11:35 +0000629 * Update state related to the current draw/read framebuffers.
Brian Paul52783592005-08-31 21:38:53 +0000630 * Specifically, update these framebuffer fields:
631 * _ColorDrawBuffers
Brian Paul52783592005-08-31 21:38:53 +0000632 * _NumColorDrawBuffers
633 * _ColorReadBuffer
Brian Paul0f29ef62005-11-16 04:17:20 +0000634 * _DepthBuffer
635 * _StencilBuffer
Brian Paule4b23562005-05-04 20:11:35 +0000636 * If the current framebuffer is user-created, make sure it's complete.
Brian Paul52783592005-08-31 21:38:53 +0000637 * The following functions can effect this state: glReadBuffer,
Brian Paul0f29ef62005-11-16 04:17:20 +0000638 * glDrawBuffer, glDrawBuffersARB, glFramebufferRenderbufferEXT,
639 * glRenderbufferStorageEXT.
Brian Paule4b23562005-05-04 20:11:35 +0000640 */
641void
642_mesa_update_framebuffer(GLcontext *ctx)
643{
644 struct gl_framebuffer *fb = ctx->DrawBuffer;
Brian Paule4b23562005-05-04 20:11:35 +0000645
646 /* Completeness only matters for user-created framebuffers */
Brian Paul474f28e2005-10-08 14:41:17 +0000647 if (fb->Name != 0) {
Brian Paule4b23562005-05-04 20:11:35 +0000648 _mesa_test_framebuffer_completeness(ctx, fb);
Brian Paul474f28e2005-10-08 14:41:17 +0000649 _mesa_update_framebuffer_visual(fb);
650 }
Brian Paule4b23562005-05-04 20:11:35 +0000651
Brian Paulea4fe662006-03-26 05:22:17 +0000652 update_color_draw_buffers(ctx, fb);
653 update_color_read_buffer(ctx, fb);
654 _mesa_update_depth_buffer(ctx, fb, BUFFER_DEPTH);
655 _mesa_update_stencil_buffer(ctx, fb, BUFFER_STENCIL);
Brian Paul84716042005-11-16 04:05:54 +0000656
Brian Paule4b23562005-05-04 20:11:35 +0000657 compute_depth_max(fb);
658}
Brian Paul7275d4d2006-03-20 15:25:18 +0000659
660
661/**
662 * Check if the renderbuffer for a read operation (glReadPixels, glCopyPixels,
663 * glCopyTex[Sub]Image, etc. exists.
664 * \param format a basic image format such as GL_RGB, GL_RGBA, GL_ALPHA,
665 * GL_DEPTH_COMPONENT, etc. or GL_COLOR, GL_DEPTH, GL_STENCIL.
666 * \return GL_TRUE if buffer exists, GL_FALSE otherwise
667 */
668GLboolean
669_mesa_source_buffer_exists(GLcontext *ctx, GLenum format)
670{
671 const struct gl_renderbuffer_attachment *att
672 = ctx->ReadBuffer->Attachment;
673
674 if (ctx->ReadBuffer->_Status != GL_FRAMEBUFFER_COMPLETE_EXT) {
675 return GL_FALSE;
676 }
677
678 switch (format) {
679 case GL_COLOR:
Brian Paul590cd262006-03-24 22:53:00 +0000680 case GL_RED:
681 case GL_GREEN:
682 case GL_BLUE:
Brian Paul7275d4d2006-03-20 15:25:18 +0000683 case GL_ALPHA:
684 case GL_LUMINANCE:
685 case GL_LUMINANCE_ALPHA:
686 case GL_INTENSITY:
687 case GL_RGB:
Brian Paul590cd262006-03-24 22:53:00 +0000688 case GL_BGR:
Brian Paul7275d4d2006-03-20 15:25:18 +0000689 case GL_RGBA:
Brian Paul590cd262006-03-24 22:53:00 +0000690 case GL_BGRA:
691 case GL_ABGR_EXT:
Brian Paul7275d4d2006-03-20 15:25:18 +0000692 case GL_COLOR_INDEX:
693 if (ctx->ReadBuffer->_ColorReadBuffer == NULL) {
694 return GL_FALSE;
695 }
Brian Paul84c5d0a2006-03-30 16:29:41 +0000696 /* XXX enable this post 6.5 release:
697 ASSERT(ctx->ReadBuffer->_ColorReadBuffer->RedBits > 0 ||
698 ctx->ReadBuffer->_ColorReadBuffer->IndexBits > 0);
699 */
Brian Paul7275d4d2006-03-20 15:25:18 +0000700 break;
701 case GL_DEPTH:
702 case GL_DEPTH_COMPONENT:
703 if (!att[BUFFER_DEPTH].Renderbuffer) {
704 return GL_FALSE;
705 }
706 ASSERT(att[BUFFER_DEPTH].Renderbuffer->DepthBits > 0);
707 break;
708 case GL_STENCIL:
709 case GL_STENCIL_INDEX:
710 if (!att[BUFFER_STENCIL].Renderbuffer) {
711 return GL_FALSE;
712 }
713 ASSERT(att[BUFFER_STENCIL].Renderbuffer->StencilBits > 0);
714 break;
715 case GL_DEPTH_STENCIL_EXT:
716 if (!att[BUFFER_DEPTH].Renderbuffer ||
717 !att[BUFFER_STENCIL].Renderbuffer) {
718 return GL_FALSE;
719 }
720 ASSERT(att[BUFFER_DEPTH].Renderbuffer->DepthBits > 0);
721 ASSERT(att[BUFFER_STENCIL].Renderbuffer->StencilBits > 0);
722 break;
723 default:
724 _mesa_problem(ctx,
Brian Paul590cd262006-03-24 22:53:00 +0000725 "Unexpected format 0x%x in _mesa_source_buffer_exists",
726 format);
Brian Paul7275d4d2006-03-20 15:25:18 +0000727 return GL_FALSE;
728 }
729
730 /* OK */
731 return GL_TRUE;
732}
733
734
735/**
736 * As above, but for drawing operations.
737 * XXX code do some code merging w/ above function.
738 */
739GLboolean
740_mesa_dest_buffer_exists(GLcontext *ctx, GLenum format)
741{
742 const struct gl_renderbuffer_attachment *att
743 = ctx->ReadBuffer->Attachment;
744
745 if (ctx->DrawBuffer->_Status != GL_FRAMEBUFFER_COMPLETE_EXT) {
746 return GL_FALSE;
747 }
748
749 switch (format) {
750 case GL_COLOR:
Brian Paul590cd262006-03-24 22:53:00 +0000751 case GL_RED:
752 case GL_GREEN:
753 case GL_BLUE:
Brian Paul7275d4d2006-03-20 15:25:18 +0000754 case GL_ALPHA:
755 case GL_LUMINANCE:
756 case GL_LUMINANCE_ALPHA:
757 case GL_INTENSITY:
758 case GL_RGB:
Brian Paul590cd262006-03-24 22:53:00 +0000759 case GL_BGR:
Brian Paul7275d4d2006-03-20 15:25:18 +0000760 case GL_RGBA:
Brian Paul590cd262006-03-24 22:53:00 +0000761 case GL_BGRA:
762 case GL_ABGR_EXT:
Brian Paul7275d4d2006-03-20 15:25:18 +0000763 case GL_COLOR_INDEX:
764 /* nothing special */
Brian Paul84c5d0a2006-03-30 16:29:41 +0000765 /* Could assert that colorbuffer has RedBits > 0 */
Brian Paul7275d4d2006-03-20 15:25:18 +0000766 break;
767 case GL_DEPTH:
768 case GL_DEPTH_COMPONENT:
769 if (!att[BUFFER_DEPTH].Renderbuffer) {
770 return GL_FALSE;
771 }
772 ASSERT(att[BUFFER_DEPTH].Renderbuffer->DepthBits > 0);
773 break;
774 case GL_STENCIL:
775 case GL_STENCIL_INDEX:
776 if (!att[BUFFER_STENCIL].Renderbuffer) {
777 return GL_FALSE;
778 }
779 ASSERT(att[BUFFER_STENCIL].Renderbuffer->StencilBits > 0);
780 break;
781 case GL_DEPTH_STENCIL_EXT:
782 if (!att[BUFFER_DEPTH].Renderbuffer ||
783 !att[BUFFER_STENCIL].Renderbuffer) {
784 return GL_FALSE;
785 }
786 ASSERT(att[BUFFER_DEPTH].Renderbuffer->DepthBits > 0);
787 ASSERT(att[BUFFER_STENCIL].Renderbuffer->StencilBits > 0);
788 break;
789 default:
790 _mesa_problem(ctx,
Brian Paul590cd262006-03-24 22:53:00 +0000791 "Unexpected format 0x%x in _mesa_source_buffer_exists",
792 format);
Brian Paul7275d4d2006-03-20 15:25:18 +0000793 return GL_FALSE;
794 }
795
796 /* OK */
797 return GL_TRUE;
798}