1 /**************************************************************************
3 * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21 * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 **************************************************************************/
30 * Framebuffer/renderbuffer functions.
36 #include "main/imports.h"
37 #include "main/context.h"
38 #include "main/fbobject.h"
39 #include "main/framebuffer.h"
40 #include "main/macros.h"
41 #include "main/mfeatures.h"
42 #include "main/renderbuffer.h"
44 #include "pipe/p_context.h"
45 #include "pipe/p_defines.h"
46 #include "pipe/p_screen.h"
47 #include "st_context.h"
48 #include "st_cb_fbo.h"
49 #include "st_cb_flush.h"
50 #include "st_format.h"
51 #include "st_texture.h"
52 #include "st_manager.h"
54 #include "util/u_format.h"
55 #include "util/u_inlines.h"
56 #include "util/u_surface.h"
60 * gl_renderbuffer::AllocStorage()
61 * This is called to allocate the original drawing surface, and
62 * during window resize.
65 st_renderbuffer_alloc_storage(struct gl_context
* ctx
,
66 struct gl_renderbuffer
*rb
,
67 GLenum internalFormat
,
68 GLuint width
, GLuint height
)
70 struct st_context
*st
= st_context(ctx
);
71 struct pipe_context
*pipe
= st
->pipe
;
72 struct pipe_screen
*screen
= st
->pipe
->screen
;
73 struct st_renderbuffer
*strb
= st_renderbuffer(rb
);
74 enum pipe_format format
;
75 struct pipe_surface surf_tmpl
;
77 if (strb
->format
!= PIPE_FORMAT_NONE
)
78 format
= strb
->format
;
80 format
= st_choose_renderbuffer_format(screen
, internalFormat
,
83 if (format
== PIPE_FORMAT_NONE
) {
87 /* init renderbuffer fields */
88 strb
->Base
.Width
= width
;
89 strb
->Base
.Height
= height
;
90 strb
->Base
.Format
= st_pipe_format_to_mesa_format(format
);
91 strb
->Base
._BaseFormat
= _mesa_base_fbo_format(ctx
, internalFormat
);
92 strb
->Base
.DataType
= st_format_datatype(format
);
94 strb
->defined
= GL_FALSE
; /* undefined contents now */
101 assert(strb
->format
!= PIPE_FORMAT_NONE
);
103 strb
->stride
= util_format_get_stride(strb
->format
, width
);
104 size
= util_format_get_2d_size(strb
->format
, strb
->stride
, height
);
106 strb
->data
= malloc(size
);
108 return strb
->data
!= NULL
;
111 struct pipe_resource
template;
113 /* Free the old surface and texture
115 pipe_surface_reference( &strb
->surface
, NULL
);
116 pipe_resource_reference( &strb
->texture
, NULL
);
117 pipe_sampler_view_reference(&strb
->sampler_view
, NULL
);
119 /* Setup new texture template.
121 memset(&template, 0, sizeof(template));
122 template.target
= st
->internal_target
;
123 template.format
= format
;
124 template.width0
= width
;
125 template.height0
= height
;
127 template.array_size
= 1;
128 template.last_level
= 0;
129 template.nr_samples
= rb
->NumSamples
;
130 if (util_format_is_depth_or_stencil(format
)) {
131 template.bind
= PIPE_BIND_DEPTH_STENCIL
;
134 template.bind
= (PIPE_BIND_DISPLAY_TARGET
|
135 PIPE_BIND_RENDER_TARGET
);
138 strb
->texture
= screen
->resource_create(screen
, &template);
143 memset(&surf_tmpl
, 0, sizeof(surf_tmpl
));
144 u_surface_default_template(&surf_tmpl
, strb
->texture
, template.bind
);
145 strb
->surface
= pipe
->create_surface(pipe
,
149 assert(strb
->surface
->texture
);
150 assert(strb
->surface
->format
);
151 assert(strb
->surface
->width
== width
);
152 assert(strb
->surface
->height
== height
);
155 return strb
->surface
!= NULL
;
161 * gl_renderbuffer::Delete()
164 st_renderbuffer_delete(struct gl_renderbuffer
*rb
)
166 struct st_renderbuffer
*strb
= st_renderbuffer(rb
);
168 pipe_surface_reference(&strb
->surface
, NULL
);
169 pipe_resource_reference(&strb
->texture
, NULL
);
170 pipe_sampler_view_reference(&strb
->sampler_view
, NULL
);
177 * gl_renderbuffer::GetPointer()
180 null_get_pointer(struct gl_context
* ctx
, struct gl_renderbuffer
*rb
,
183 /* By returning NULL we force all software rendering to go through
187 assert(0); /* Should never get called with softpipe */
194 * Called via ctx->Driver.NewFramebuffer()
196 static struct gl_framebuffer
*
197 st_new_framebuffer(struct gl_context
*ctx
, GLuint name
)
199 /* XXX not sure we need to subclass gl_framebuffer for pipe */
200 return _mesa_new_framebuffer(ctx
, name
);
205 * Called via ctx->Driver.NewRenderbuffer()
207 static struct gl_renderbuffer
*
208 st_new_renderbuffer(struct gl_context
*ctx
, GLuint name
)
210 struct st_renderbuffer
*strb
= ST_CALLOC_STRUCT(st_renderbuffer
);
212 _mesa_init_renderbuffer(&strb
->Base
, name
);
213 strb
->Base
.Delete
= st_renderbuffer_delete
;
214 strb
->Base
.AllocStorage
= st_renderbuffer_alloc_storage
;
215 strb
->Base
.GetPointer
= null_get_pointer
;
216 strb
->format
= PIPE_FORMAT_NONE
;
224 * Allocate a renderbuffer for a an on-screen window (not a user-created
225 * renderbuffer). The window system code determines the format.
227 struct gl_renderbuffer
*
228 st_new_renderbuffer_fb(enum pipe_format format
, int samples
, boolean sw
)
230 struct st_renderbuffer
*strb
;
232 strb
= ST_CALLOC_STRUCT(st_renderbuffer
);
234 _mesa_error(NULL
, GL_OUT_OF_MEMORY
, "creating renderbuffer");
238 _mesa_init_renderbuffer(&strb
->Base
, 0);
239 strb
->Base
.ClassID
= 0x4242; /* just a unique value */
240 strb
->Base
.NumSamples
= samples
;
241 strb
->Base
.Format
= st_pipe_format_to_mesa_format(format
);
242 strb
->Base
._BaseFormat
= _mesa_get_format_base_format(strb
->Base
.Format
);
243 strb
->Base
.DataType
= st_format_datatype(format
);
244 strb
->format
= format
;
248 case PIPE_FORMAT_R8G8B8A8_UNORM
:
249 case PIPE_FORMAT_B8G8R8A8_UNORM
:
250 case PIPE_FORMAT_A8R8G8B8_UNORM
:
251 case PIPE_FORMAT_R8G8B8X8_UNORM
:
252 case PIPE_FORMAT_B8G8R8X8_UNORM
:
253 case PIPE_FORMAT_X8R8G8B8_UNORM
:
254 case PIPE_FORMAT_B5G5R5A1_UNORM
:
255 case PIPE_FORMAT_B4G4R4A4_UNORM
:
256 case PIPE_FORMAT_B5G6R5_UNORM
:
257 strb
->Base
.InternalFormat
= GL_RGBA
;
259 case PIPE_FORMAT_Z16_UNORM
:
260 strb
->Base
.InternalFormat
= GL_DEPTH_COMPONENT16
;
262 case PIPE_FORMAT_Z32_UNORM
:
263 strb
->Base
.InternalFormat
= GL_DEPTH_COMPONENT32
;
265 case PIPE_FORMAT_Z24_UNORM_S8_USCALED
:
266 case PIPE_FORMAT_S8_USCALED_Z24_UNORM
:
267 case PIPE_FORMAT_Z24X8_UNORM
:
268 case PIPE_FORMAT_X8Z24_UNORM
:
269 strb
->Base
.InternalFormat
= GL_DEPTH24_STENCIL8_EXT
;
271 case PIPE_FORMAT_S8_USCALED
:
272 strb
->Base
.InternalFormat
= GL_STENCIL_INDEX8_EXT
;
274 case PIPE_FORMAT_R16G16B16A16_SNORM
:
275 strb
->Base
.InternalFormat
= GL_RGBA16
;
277 case PIPE_FORMAT_R8_UNORM
:
278 strb
->Base
.InternalFormat
= GL_R8
;
280 case PIPE_FORMAT_R8G8_UNORM
:
281 strb
->Base
.InternalFormat
= GL_RG8
;
283 case PIPE_FORMAT_R16_UNORM
:
284 strb
->Base
.InternalFormat
= GL_R16
;
286 case PIPE_FORMAT_R16G16_UNORM
:
287 strb
->Base
.InternalFormat
= GL_RG16
;
291 "Unexpected format in st_new_renderbuffer_fb");
296 /* st-specific methods */
297 strb
->Base
.Delete
= st_renderbuffer_delete
;
298 strb
->Base
.AllocStorage
= st_renderbuffer_alloc_storage
;
299 strb
->Base
.GetPointer
= null_get_pointer
;
301 /* surface is allocated in st_renderbuffer_alloc_storage() */
302 strb
->surface
= NULL
;
311 * Called via ctx->Driver.BindFramebufferEXT().
314 st_bind_framebuffer(struct gl_context
*ctx
, GLenum target
,
315 struct gl_framebuffer
*fb
, struct gl_framebuffer
*fbread
)
321 * Called by ctx->Driver.FramebufferRenderbuffer
324 st_framebuffer_renderbuffer(struct gl_context
*ctx
,
325 struct gl_framebuffer
*fb
,
327 struct gl_renderbuffer
*rb
)
329 /* XXX no need for derivation? */
330 _mesa_framebuffer_renderbuffer(ctx
, fb
, attachment
, rb
);
335 * Called by ctx->Driver.RenderTexture
338 st_render_texture(struct gl_context
*ctx
,
339 struct gl_framebuffer
*fb
,
340 struct gl_renderbuffer_attachment
*att
)
342 struct st_context
*st
= st_context(ctx
);
343 struct pipe_context
*pipe
= st
->pipe
;
344 struct st_renderbuffer
*strb
;
345 struct gl_renderbuffer
*rb
;
346 struct pipe_resource
*pt
= st_get_texobj_resource(att
->Texture
);
347 struct st_texture_object
*stObj
;
348 const struct gl_texture_image
*texImage
;
349 struct pipe_surface surf_tmpl
;
351 /* When would this fail? Perhaps assert? */
355 /* get pointer to texture image we're rendeing to */
356 texImage
= _mesa_get_attachment_teximage(att
);
358 /* create new renderbuffer which wraps the texture image */
359 rb
= st_new_renderbuffer(ctx
, 0);
361 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glFramebufferTexture()");
365 _mesa_reference_renderbuffer(&att
->Renderbuffer
, rb
);
366 assert(rb
->RefCount
== 1);
367 rb
->AllocStorage
= NULL
; /* should not get called */
368 strb
= st_renderbuffer(rb
);
370 assert(strb
->Base
.RefCount
> 0);
372 /* get the texture for the texture object */
373 stObj
= st_texture_object(att
->Texture
);
375 /* point renderbuffer at texobject */
377 strb
->rtt_level
= att
->TextureLevel
;
378 strb
->rtt_face
= att
->CubeMapFace
;
379 strb
->rtt_slice
= att
->Zoffset
;
381 rb
->Width
= texImage
->Width2
;
382 rb
->Height
= texImage
->Height2
;
383 rb
->_BaseFormat
= texImage
->_BaseFormat
;
384 /*printf("***** render to texture level %d: %d x %d\n", att->TextureLevel, rb->Width, rb->Height);*/
386 /*printf("***** pipe texture %d x %d\n", pt->width0, pt->height0);*/
388 pipe_resource_reference( &strb
->texture
, pt
);
390 pipe_surface_reference(&strb
->surface
, NULL
);
392 pipe_sampler_view_reference(&strb
->sampler_view
,
393 st_get_texture_sampler_view(stObj
, pipe
));
395 assert(strb
->rtt_level
<= strb
->texture
->last_level
);
397 /* new surface for rendering into the texture */
398 memset(&surf_tmpl
, 0, sizeof(surf_tmpl
));
399 surf_tmpl
.format
= ctx
->Color
.sRGBEnabled
? strb
->texture
->format
: util_format_linear(strb
->texture
->format
);
400 surf_tmpl
.usage
= PIPE_BIND_RENDER_TARGET
;
401 surf_tmpl
.u
.tex
.level
= strb
->rtt_level
;
402 surf_tmpl
.u
.tex
.first_layer
= strb
->rtt_face
+ strb
->rtt_slice
;
403 surf_tmpl
.u
.tex
.last_layer
= strb
->rtt_face
+ strb
->rtt_slice
;
404 strb
->surface
= pipe
->create_surface(pipe
,
408 strb
->format
= pt
->format
;
410 strb
->Base
.Format
= st_pipe_format_to_mesa_format(pt
->format
);
411 strb
->Base
.DataType
= st_format_datatype(pt
->format
);
414 printf("RENDER TO TEXTURE obj=%p pt=%p surf=%p %d x %d\n",
415 att->Texture, pt, strb->surface, rb->Width, rb->Height);
418 /* Invalidate buffer state so that the pipe's framebuffer state
420 * That's where the new renderbuffer (which we just created) gets
421 * passed to the pipe as a (color/depth) render target.
423 st_invalidate_state(ctx
, _NEW_BUFFERS
);
428 * Called via ctx->Driver.FinishRenderTexture.
431 st_finish_render_texture(struct gl_context
*ctx
,
432 struct gl_renderbuffer_attachment
*att
)
434 struct st_renderbuffer
*strb
= st_renderbuffer(att
->Renderbuffer
);
442 printf("FINISH RENDER TO TEXTURE surf=%p\n", strb->surface);
445 /* restore previous framebuffer state */
446 st_invalidate_state(ctx
, _NEW_BUFFERS
);
451 * Validate a renderbuffer attachment for a particular set of bindings.
454 st_validate_attachment(struct gl_context
*ctx
,
455 struct pipe_screen
*screen
,
456 const struct gl_renderbuffer_attachment
*att
,
459 const struct st_texture_object
*stObj
= st_texture_object(att
->Texture
);
460 enum pipe_format format
;
463 /* Only validate texture attachments for now, since
464 * st_renderbuffer_alloc_storage makes sure that
465 * the format is supported.
467 if (att
->Type
!= GL_TEXTURE
)
473 format
= stObj
->pt
->format
;
474 texFormat
= _mesa_get_attachment_teximage_const(att
)->TexFormat
;
476 /* If the encoding is sRGB and sRGB rendering cannot be enabled,
477 * check for linear format support instead.
478 * Later when we create a surface, we change the format to a linear one. */
479 if (!ctx
->Const
.sRGBCapable
&&
480 _mesa_get_format_color_encoding(texFormat
) == GL_SRGB
) {
481 const gl_format linearFormat
= _mesa_get_srgb_format_linear(texFormat
);
482 format
= st_mesa_format_to_pipe_format(linearFormat
);
485 return screen
->is_format_supported(screen
, format
,
487 stObj
->pt
->nr_samples
, bindings
);
492 * Check if two renderbuffer attachments name a combined depth/stencil
496 st_is_depth_stencil_combined(const struct gl_renderbuffer_attachment
*depth
,
497 const struct gl_renderbuffer_attachment
*stencil
)
499 assert(depth
&& stencil
);
501 if (depth
->Type
== stencil
->Type
) {
502 if (depth
->Type
== GL_RENDERBUFFER_EXT
&&
503 depth
->Renderbuffer
== stencil
->Renderbuffer
)
506 if (depth
->Type
== GL_TEXTURE
&&
507 depth
->Texture
== stencil
->Texture
)
516 * Check that the framebuffer configuration is valid in terms of what
517 * the driver can support.
519 * For Gallium we only supports combined Z+stencil, not separate buffers.
522 st_validate_framebuffer(struct gl_context
*ctx
, struct gl_framebuffer
*fb
)
524 struct st_context
*st
= st_context(ctx
);
525 struct pipe_screen
*screen
= st
->pipe
->screen
;
526 const struct gl_renderbuffer_attachment
*depth
=
527 &fb
->Attachment
[BUFFER_DEPTH
];
528 const struct gl_renderbuffer_attachment
*stencil
=
529 &fb
->Attachment
[BUFFER_STENCIL
];
531 enum pipe_format first_format
= PIPE_FORMAT_NONE
;
532 boolean mixed_formats
=
533 screen
->get_param(screen
, PIPE_CAP_MIXED_COLORBUFFER_FORMATS
) != 0;
535 if (depth
->Type
&& stencil
->Type
&& depth
->Type
!= stencil
->Type
) {
536 fb
->_Status
= GL_FRAMEBUFFER_UNSUPPORTED_EXT
;
539 if (depth
->Type
== GL_RENDERBUFFER_EXT
&&
540 stencil
->Type
== GL_RENDERBUFFER_EXT
&&
541 depth
->Renderbuffer
!= stencil
->Renderbuffer
) {
542 fb
->_Status
= GL_FRAMEBUFFER_UNSUPPORTED_EXT
;
545 if (depth
->Type
== GL_TEXTURE
&&
546 stencil
->Type
== GL_TEXTURE
&&
547 depth
->Texture
!= stencil
->Texture
) {
548 fb
->_Status
= GL_FRAMEBUFFER_UNSUPPORTED_EXT
;
552 if (!st_validate_attachment(ctx
,
555 PIPE_BIND_DEPTH_STENCIL
)) {
556 fb
->_Status
= GL_FRAMEBUFFER_UNSUPPORTED_EXT
;
559 if (!st_validate_attachment(ctx
,
562 PIPE_BIND_DEPTH_STENCIL
)) {
563 fb
->_Status
= GL_FRAMEBUFFER_UNSUPPORTED_EXT
;
566 for (i
= 0; i
< ctx
->Const
.MaxColorAttachments
; i
++) {
567 struct gl_renderbuffer_attachment
*att
=
568 &fb
->Attachment
[BUFFER_COLOR0
+ i
];
569 enum pipe_format format
;
571 if (!st_validate_attachment(ctx
,
574 PIPE_BIND_RENDER_TARGET
)) {
575 fb
->_Status
= GL_FRAMEBUFFER_UNSUPPORTED_EXT
;
579 if (!mixed_formats
) {
580 /* Disallow mixed formats. */
581 if (att
->Type
!= GL_NONE
) {
582 format
= st_renderbuffer(att
->Renderbuffer
)->surface
->format
;
587 if (first_format
== PIPE_FORMAT_NONE
) {
588 first_format
= format
;
589 } else if (format
!= first_format
) {
590 fb
->_Status
= GL_FRAMEBUFFER_UNSUPPORTED_EXT
;
599 * Called via glDrawBuffer.
602 st_DrawBuffers(struct gl_context
*ctx
, GLsizei count
, const GLenum
*buffers
)
604 struct st_context
*st
= st_context(ctx
);
605 struct gl_framebuffer
*fb
= ctx
->DrawBuffer
;
611 /* add the renderbuffers on demand */
612 for (i
= 0; i
< fb
->_NumColorDrawBuffers
; i
++) {
613 gl_buffer_index idx
= fb
->_ColorDrawBufferIndexes
[i
];
614 st_manager_add_color_renderbuffer(st
, fb
, idx
);
620 * Called via glReadBuffer.
623 st_ReadBuffer(struct gl_context
*ctx
, GLenum buffer
)
625 struct st_context
*st
= st_context(ctx
);
626 struct gl_framebuffer
*fb
= ctx
->ReadBuffer
;
630 /* add the renderbuffer on demand */
631 st_manager_add_color_renderbuffer(st
, fb
, fb
->_ColorReadBufferIndex
);
635 void st_init_fbo_functions(struct dd_function_table
*functions
)
637 #if FEATURE_EXT_framebuffer_object
638 functions
->NewFramebuffer
= st_new_framebuffer
;
639 functions
->NewRenderbuffer
= st_new_renderbuffer
;
640 functions
->BindFramebuffer
= st_bind_framebuffer
;
641 functions
->FramebufferRenderbuffer
= st_framebuffer_renderbuffer
;
642 functions
->RenderTexture
= st_render_texture
;
643 functions
->FinishRenderTexture
= st_finish_render_texture
;
644 functions
->ValidateFramebuffer
= st_validate_framebuffer
;
646 /* no longer needed by core Mesa, drivers handle resizes...
647 functions->ResizeBuffers = st_resize_buffers;
650 functions
->DrawBuffers
= st_DrawBuffers
;
651 functions
->ReadBuffer
= st_ReadBuffer
;
655 struct pipe_sampler_view
*
656 st_get_renderbuffer_sampler_view(struct st_renderbuffer
*rb
,
657 struct pipe_context
*pipe
)
659 if (!rb
->sampler_view
) {
660 rb
->sampler_view
= st_create_texture_sampler_view(pipe
, rb
->texture
);
663 return rb
->sampler_view
;