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 format
= st_choose_renderbuffer_format(screen
, internalFormat
,
80 if (format
== PIPE_FORMAT_NONE
) {
84 /* init renderbuffer fields */
85 strb
->Base
.Width
= width
;
86 strb
->Base
.Height
= height
;
87 strb
->Base
.Format
= st_pipe_format_to_mesa_format(format
);
88 strb
->Base
._BaseFormat
= _mesa_base_fbo_format(ctx
, internalFormat
);
89 strb
->Base
.DataType
= st_format_datatype(format
);
90 strb
->format
= format
;
92 strb
->defined
= GL_FALSE
; /* undefined contents now */
99 assert(strb
->format
!= PIPE_FORMAT_NONE
);
101 strb
->stride
= util_format_get_stride(strb
->format
, width
);
102 size
= util_format_get_2d_size(strb
->format
, strb
->stride
, height
);
104 strb
->data
= malloc(size
);
106 return strb
->data
!= NULL
;
109 struct pipe_resource
template;
111 /* Free the old surface and texture
113 pipe_surface_reference( &strb
->surface
, NULL
);
114 pipe_resource_reference( &strb
->texture
, NULL
);
115 pipe_sampler_view_reference(&strb
->sampler_view
, NULL
);
117 /* Setup new texture template.
119 memset(&template, 0, sizeof(template));
120 template.target
= st
->internal_target
;
121 template.format
= format
;
122 template.width0
= width
;
123 template.height0
= height
;
125 template.array_size
= 1;
126 template.last_level
= 0;
127 template.nr_samples
= rb
->NumSamples
;
128 if (util_format_is_depth_or_stencil(format
)) {
129 template.bind
= PIPE_BIND_DEPTH_STENCIL
;
132 template.bind
= (PIPE_BIND_DISPLAY_TARGET
|
133 PIPE_BIND_RENDER_TARGET
);
136 strb
->texture
= screen
->resource_create(screen
, &template);
141 memset(&surf_tmpl
, 0, sizeof(surf_tmpl
));
142 u_surface_default_template(&surf_tmpl
, strb
->texture
, template.bind
);
143 strb
->surface
= pipe
->create_surface(pipe
,
147 assert(strb
->surface
->texture
);
148 assert(strb
->surface
->format
);
149 assert(strb
->surface
->width
== width
);
150 assert(strb
->surface
->height
== height
);
153 return strb
->surface
!= NULL
;
159 * gl_renderbuffer::Delete()
162 st_renderbuffer_delete(struct gl_renderbuffer
*rb
)
164 struct st_renderbuffer
*strb
= st_renderbuffer(rb
);
166 pipe_surface_reference(&strb
->surface
, NULL
);
167 pipe_resource_reference(&strb
->texture
, NULL
);
168 pipe_sampler_view_reference(&strb
->sampler_view
, NULL
);
175 * gl_renderbuffer::GetPointer()
178 null_get_pointer(struct gl_context
* ctx
, struct gl_renderbuffer
*rb
,
181 /* By returning NULL we force all software rendering to go through
185 assert(0); /* Should never get called with softpipe */
192 * Called via ctx->Driver.NewFramebuffer()
194 static struct gl_framebuffer
*
195 st_new_framebuffer(struct gl_context
*ctx
, GLuint name
)
197 /* XXX not sure we need to subclass gl_framebuffer for pipe */
198 return _mesa_new_framebuffer(ctx
, name
);
203 * Called via ctx->Driver.NewRenderbuffer()
205 static struct gl_renderbuffer
*
206 st_new_renderbuffer(struct gl_context
*ctx
, GLuint name
)
208 struct st_renderbuffer
*strb
= ST_CALLOC_STRUCT(st_renderbuffer
);
210 _mesa_init_renderbuffer(&strb
->Base
, name
);
211 strb
->Base
.Delete
= st_renderbuffer_delete
;
212 strb
->Base
.AllocStorage
= st_renderbuffer_alloc_storage
;
213 strb
->Base
.GetPointer
= null_get_pointer
;
214 strb
->format
= PIPE_FORMAT_NONE
;
222 * Allocate a renderbuffer for a an on-screen window (not a user-created
223 * renderbuffer). The window system code determines the format.
225 struct gl_renderbuffer
*
226 st_new_renderbuffer_fb(enum pipe_format format
, int samples
, boolean sw
)
228 struct st_renderbuffer
*strb
;
230 strb
= ST_CALLOC_STRUCT(st_renderbuffer
);
232 _mesa_error(NULL
, GL_OUT_OF_MEMORY
, "creating renderbuffer");
236 _mesa_init_renderbuffer(&strb
->Base
, 0);
237 strb
->Base
.ClassID
= 0x4242; /* just a unique value */
238 strb
->Base
.NumSamples
= samples
;
239 strb
->Base
.Format
= st_pipe_format_to_mesa_format(format
);
240 strb
->Base
._BaseFormat
= _mesa_get_format_base_format(strb
->Base
.Format
);
241 strb
->Base
.DataType
= st_format_datatype(format
);
242 strb
->format
= format
;
246 case PIPE_FORMAT_R8G8B8A8_UNORM
:
247 case PIPE_FORMAT_B8G8R8A8_UNORM
:
248 case PIPE_FORMAT_A8R8G8B8_UNORM
:
249 case PIPE_FORMAT_R8G8B8X8_UNORM
:
250 case PIPE_FORMAT_B8G8R8X8_UNORM
:
251 case PIPE_FORMAT_X8R8G8B8_UNORM
:
252 case PIPE_FORMAT_B5G5R5A1_UNORM
:
253 case PIPE_FORMAT_B4G4R4A4_UNORM
:
254 case PIPE_FORMAT_B5G6R5_UNORM
:
255 strb
->Base
.InternalFormat
= GL_RGBA
;
257 case PIPE_FORMAT_Z16_UNORM
:
258 strb
->Base
.InternalFormat
= GL_DEPTH_COMPONENT16
;
260 case PIPE_FORMAT_Z32_UNORM
:
261 strb
->Base
.InternalFormat
= GL_DEPTH_COMPONENT32
;
263 case PIPE_FORMAT_Z24_UNORM_S8_USCALED
:
264 case PIPE_FORMAT_S8_USCALED_Z24_UNORM
:
265 case PIPE_FORMAT_Z24X8_UNORM
:
266 case PIPE_FORMAT_X8Z24_UNORM
:
267 strb
->Base
.InternalFormat
= GL_DEPTH24_STENCIL8_EXT
;
269 case PIPE_FORMAT_S8_USCALED
:
270 strb
->Base
.InternalFormat
= GL_STENCIL_INDEX8_EXT
;
272 case PIPE_FORMAT_R16G16B16A16_SNORM
:
274 strb
->Base
.InternalFormat
= GL_RGBA16_SNORM
;
276 case PIPE_FORMAT_R8_UNORM
:
277 strb
->Base
.InternalFormat
= GL_R8
;
279 case PIPE_FORMAT_R8G8_UNORM
:
280 strb
->Base
.InternalFormat
= GL_RG8
;
282 case PIPE_FORMAT_R16_UNORM
:
283 strb
->Base
.InternalFormat
= GL_R16
;
285 case PIPE_FORMAT_R16G16_UNORM
:
286 strb
->Base
.InternalFormat
= GL_RG16
;
290 "Unexpected format in st_new_renderbuffer_fb");
295 /* st-specific methods */
296 strb
->Base
.Delete
= st_renderbuffer_delete
;
297 strb
->Base
.AllocStorage
= st_renderbuffer_alloc_storage
;
298 strb
->Base
.GetPointer
= null_get_pointer
;
300 /* surface is allocated in st_renderbuffer_alloc_storage() */
301 strb
->surface
= NULL
;
310 * Called via ctx->Driver.BindFramebufferEXT().
313 st_bind_framebuffer(struct gl_context
*ctx
, GLenum target
,
314 struct gl_framebuffer
*fb
, struct gl_framebuffer
*fbread
)
320 * Called by ctx->Driver.FramebufferRenderbuffer
323 st_framebuffer_renderbuffer(struct gl_context
*ctx
,
324 struct gl_framebuffer
*fb
,
326 struct gl_renderbuffer
*rb
)
328 /* XXX no need for derivation? */
329 _mesa_framebuffer_renderbuffer(ctx
, fb
, attachment
, rb
);
334 * Called by ctx->Driver.RenderTexture
337 st_render_texture(struct gl_context
*ctx
,
338 struct gl_framebuffer
*fb
,
339 struct gl_renderbuffer_attachment
*att
)
341 struct st_context
*st
= st_context(ctx
);
342 struct pipe_context
*pipe
= st
->pipe
;
343 struct st_renderbuffer
*strb
;
344 struct gl_renderbuffer
*rb
;
345 struct pipe_resource
*pt
= st_get_texobj_resource(att
->Texture
);
346 struct st_texture_object
*stObj
;
347 const struct gl_texture_image
*texImage
;
348 struct pipe_surface surf_tmpl
;
350 /* When would this fail? Perhaps assert? */
354 /* get pointer to texture image we're rendeing to */
355 texImage
= _mesa_get_attachment_teximage(att
);
357 /* create new renderbuffer which wraps the texture image */
358 rb
= st_new_renderbuffer(ctx
, 0);
360 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glFramebufferTexture()");
364 _mesa_reference_renderbuffer(&att
->Renderbuffer
, rb
);
365 assert(rb
->RefCount
== 1);
366 rb
->AllocStorage
= NULL
; /* should not get called */
367 strb
= st_renderbuffer(rb
);
369 assert(strb
->Base
.RefCount
> 0);
371 /* get the texture for the texture object */
372 stObj
= st_texture_object(att
->Texture
);
374 /* point renderbuffer at texobject */
376 strb
->rtt_level
= att
->TextureLevel
;
377 strb
->rtt_face
= att
->CubeMapFace
;
378 strb
->rtt_slice
= att
->Zoffset
;
380 rb
->Width
= texImage
->Width2
;
381 rb
->Height
= texImage
->Height2
;
382 rb
->_BaseFormat
= texImage
->_BaseFormat
;
383 /*printf("***** render to texture level %d: %d x %d\n", att->TextureLevel, rb->Width, rb->Height);*/
385 /*printf("***** pipe texture %d x %d\n", pt->width0, pt->height0);*/
387 pipe_resource_reference( &strb
->texture
, pt
);
389 pipe_surface_reference(&strb
->surface
, NULL
);
391 pipe_sampler_view_reference(&strb
->sampler_view
,
392 st_get_texture_sampler_view(stObj
, pipe
));
394 assert(strb
->rtt_level
<= strb
->texture
->last_level
);
396 /* new surface for rendering into the texture */
397 memset(&surf_tmpl
, 0, sizeof(surf_tmpl
));
398 surf_tmpl
.format
= ctx
->Color
.sRGBEnabled
? strb
->texture
->format
: util_format_linear(strb
->texture
->format
);
399 surf_tmpl
.usage
= PIPE_BIND_RENDER_TARGET
;
400 surf_tmpl
.u
.tex
.level
= strb
->rtt_level
;
401 surf_tmpl
.u
.tex
.first_layer
= strb
->rtt_face
+ strb
->rtt_slice
;
402 surf_tmpl
.u
.tex
.last_layer
= strb
->rtt_face
+ strb
->rtt_slice
;
403 strb
->surface
= pipe
->create_surface(pipe
,
407 strb
->format
= pt
->format
;
409 strb
->Base
.Format
= st_pipe_format_to_mesa_format(pt
->format
);
410 strb
->Base
.DataType
= st_format_datatype(pt
->format
);
413 printf("RENDER TO TEXTURE obj=%p pt=%p surf=%p %d x %d\n",
414 att->Texture, pt, strb->surface, rb->Width, rb->Height);
417 /* Invalidate buffer state so that the pipe's framebuffer state
419 * That's where the new renderbuffer (which we just created) gets
420 * passed to the pipe as a (color/depth) render target.
422 st_invalidate_state(ctx
, _NEW_BUFFERS
);
427 * Called via ctx->Driver.FinishRenderTexture.
430 st_finish_render_texture(struct gl_context
*ctx
,
431 struct gl_renderbuffer_attachment
*att
)
433 struct st_renderbuffer
*strb
= st_renderbuffer(att
->Renderbuffer
);
441 printf("FINISH RENDER TO TEXTURE surf=%p\n", strb->surface);
444 /* restore previous framebuffer state */
445 st_invalidate_state(ctx
, _NEW_BUFFERS
);
450 * Validate a renderbuffer attachment for a particular set of bindings.
453 st_validate_attachment(struct gl_context
*ctx
,
454 struct pipe_screen
*screen
,
455 const struct gl_renderbuffer_attachment
*att
,
458 const struct st_texture_object
*stObj
= st_texture_object(att
->Texture
);
459 enum pipe_format format
;
462 /* Only validate texture attachments for now, since
463 * st_renderbuffer_alloc_storage makes sure that
464 * the format is supported.
466 if (att
->Type
!= GL_TEXTURE
)
472 format
= stObj
->pt
->format
;
473 texFormat
= _mesa_get_attachment_teximage_const(att
)->TexFormat
;
475 /* If the encoding is sRGB and sRGB rendering cannot be enabled,
476 * check for linear format support instead.
477 * Later when we create a surface, we change the format to a linear one. */
478 if (!ctx
->Const
.sRGBCapable
&&
479 _mesa_get_format_color_encoding(texFormat
) == GL_SRGB
) {
480 const gl_format linearFormat
= _mesa_get_srgb_format_linear(texFormat
);
481 format
= st_mesa_format_to_pipe_format(linearFormat
);
484 return screen
->is_format_supported(screen
, format
,
486 stObj
->pt
->nr_samples
, bindings
);
491 * Check if two renderbuffer attachments name a combined depth/stencil
495 st_is_depth_stencil_combined(const struct gl_renderbuffer_attachment
*depth
,
496 const struct gl_renderbuffer_attachment
*stencil
)
498 assert(depth
&& stencil
);
500 if (depth
->Type
== stencil
->Type
) {
501 if (depth
->Type
== GL_RENDERBUFFER_EXT
&&
502 depth
->Renderbuffer
== stencil
->Renderbuffer
)
505 if (depth
->Type
== GL_TEXTURE
&&
506 depth
->Texture
== stencil
->Texture
)
515 * Check that the framebuffer configuration is valid in terms of what
516 * the driver can support.
518 * For Gallium we only supports combined Z+stencil, not separate buffers.
521 st_validate_framebuffer(struct gl_context
*ctx
, struct gl_framebuffer
*fb
)
523 struct st_context
*st
= st_context(ctx
);
524 struct pipe_screen
*screen
= st
->pipe
->screen
;
525 const struct gl_renderbuffer_attachment
*depth
=
526 &fb
->Attachment
[BUFFER_DEPTH
];
527 const struct gl_renderbuffer_attachment
*stencil
=
528 &fb
->Attachment
[BUFFER_STENCIL
];
530 enum pipe_format first_format
= PIPE_FORMAT_NONE
;
531 boolean mixed_formats
=
532 screen
->get_param(screen
, PIPE_CAP_MIXED_COLORBUFFER_FORMATS
) != 0;
534 if (depth
->Type
&& stencil
->Type
&& depth
->Type
!= stencil
->Type
) {
535 fb
->_Status
= GL_FRAMEBUFFER_UNSUPPORTED_EXT
;
538 if (depth
->Type
== GL_RENDERBUFFER_EXT
&&
539 stencil
->Type
== GL_RENDERBUFFER_EXT
&&
540 depth
->Renderbuffer
!= stencil
->Renderbuffer
) {
541 fb
->_Status
= GL_FRAMEBUFFER_UNSUPPORTED_EXT
;
544 if (depth
->Type
== GL_TEXTURE
&&
545 stencil
->Type
== GL_TEXTURE
&&
546 depth
->Texture
!= stencil
->Texture
) {
547 fb
->_Status
= GL_FRAMEBUFFER_UNSUPPORTED_EXT
;
551 if (!st_validate_attachment(ctx
,
554 PIPE_BIND_DEPTH_STENCIL
)) {
555 fb
->_Status
= GL_FRAMEBUFFER_UNSUPPORTED_EXT
;
558 if (!st_validate_attachment(ctx
,
561 PIPE_BIND_DEPTH_STENCIL
)) {
562 fb
->_Status
= GL_FRAMEBUFFER_UNSUPPORTED_EXT
;
565 for (i
= 0; i
< ctx
->Const
.MaxColorAttachments
; i
++) {
566 struct gl_renderbuffer_attachment
*att
=
567 &fb
->Attachment
[BUFFER_COLOR0
+ i
];
568 enum pipe_format format
;
570 if (!st_validate_attachment(ctx
,
573 PIPE_BIND_RENDER_TARGET
)) {
574 fb
->_Status
= GL_FRAMEBUFFER_UNSUPPORTED_EXT
;
578 if (!mixed_formats
) {
579 /* Disallow mixed formats. */
580 if (att
->Type
!= GL_NONE
) {
581 format
= st_renderbuffer(att
->Renderbuffer
)->surface
->format
;
586 if (first_format
== PIPE_FORMAT_NONE
) {
587 first_format
= format
;
588 } else if (format
!= first_format
) {
589 fb
->_Status
= GL_FRAMEBUFFER_UNSUPPORTED_EXT
;
598 * Called via glDrawBuffer.
601 st_DrawBuffers(struct gl_context
*ctx
, GLsizei count
, const GLenum
*buffers
)
603 struct st_context
*st
= st_context(ctx
);
604 struct gl_framebuffer
*fb
= ctx
->DrawBuffer
;
610 /* add the renderbuffers on demand */
611 for (i
= 0; i
< fb
->_NumColorDrawBuffers
; i
++) {
612 gl_buffer_index idx
= fb
->_ColorDrawBufferIndexes
[i
];
613 st_manager_add_color_renderbuffer(st
, fb
, idx
);
619 * Called via glReadBuffer.
622 st_ReadBuffer(struct gl_context
*ctx
, GLenum buffer
)
624 struct st_context
*st
= st_context(ctx
);
625 struct gl_framebuffer
*fb
= ctx
->ReadBuffer
;
629 /* add the renderbuffer on demand */
630 st_manager_add_color_renderbuffer(st
, fb
, fb
->_ColorReadBufferIndex
);
634 void st_init_fbo_functions(struct dd_function_table
*functions
)
636 #if FEATURE_EXT_framebuffer_object
637 functions
->NewFramebuffer
= st_new_framebuffer
;
638 functions
->NewRenderbuffer
= st_new_renderbuffer
;
639 functions
->BindFramebuffer
= st_bind_framebuffer
;
640 functions
->FramebufferRenderbuffer
= st_framebuffer_renderbuffer
;
641 functions
->RenderTexture
= st_render_texture
;
642 functions
->FinishRenderTexture
= st_finish_render_texture
;
643 functions
->ValidateFramebuffer
= st_validate_framebuffer
;
645 /* no longer needed by core Mesa, drivers handle resizes...
646 functions->ResizeBuffers = st_resize_buffers;
649 functions
->DrawBuffers
= st_DrawBuffers
;
650 functions
->ReadBuffer
= st_ReadBuffer
;
654 struct pipe_sampler_view
*
655 st_get_renderbuffer_sampler_view(struct st_renderbuffer
*rb
,
656 struct pipe_context
*pipe
)
658 if (!rb
->sampler_view
) {
659 rb
->sampler_view
= st_create_texture_sampler_view(pipe
, rb
->texture
);
662 return rb
->sampler_view
;