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/renderbuffer.h"
42 #include "pipe/p_context.h"
43 #include "pipe/p_defines.h"
44 #include "pipe/p_screen.h"
45 #include "st_context.h"
46 #include "st_cb_fbo.h"
47 #include "st_cb_texture.h"
48 #include "st_format.h"
49 #include "st_public.h"
50 #include "st_texture.h"
52 #include "util/u_rect.h"
56 * Compute the renderbuffer's Red/Green/EtcBit fields from the pipe format.
59 init_renderbuffer_bits(struct st_renderbuffer
*strb
,
60 enum pipe_format pipeFormat
)
62 struct pipe_format_info info
;
64 if (!st_get_format_info( pipeFormat
, &info
)) {
68 strb
->Base
._ActualFormat
= info
.base_format
;
69 strb
->Base
.RedBits
= info
.red_bits
;
70 strb
->Base
.GreenBits
= info
.green_bits
;
71 strb
->Base
.BlueBits
= info
.blue_bits
;
72 strb
->Base
.AlphaBits
= info
.alpha_bits
;
73 strb
->Base
.DepthBits
= info
.depth_bits
;
74 strb
->Base
.StencilBits
= info
.stencil_bits
;
75 strb
->Base
.DataType
= st_format_datatype(pipeFormat
);
81 * gl_renderbuffer::AllocStorage()
82 * This is called to allocate the original drawing surface, and
83 * during window resize.
86 st_renderbuffer_alloc_storage(GLcontext
* ctx
, struct gl_renderbuffer
*rb
,
87 GLenum internalFormat
,
88 GLuint width
, GLuint height
)
90 struct pipe_context
*pipe
= ctx
->st
->pipe
;
91 struct st_renderbuffer
*strb
= st_renderbuffer(rb
);
92 enum pipe_format format
;
94 if (strb
->format
!= PIPE_FORMAT_NONE
)
95 format
= strb
->format
;
97 format
= st_choose_renderbuffer_format(pipe
->screen
, internalFormat
);
99 /* init renderbuffer fields */
100 strb
->Base
.Width
= width
;
101 strb
->Base
.Height
= height
;
102 init_renderbuffer_bits(strb
, format
);
104 strb
->defined
= GL_FALSE
; /* undefined contents now */
107 struct pipe_format_block block
;
110 _mesa_free(strb
->data
);
112 assert(strb
->format
!= PIPE_FORMAT_NONE
);
113 pf_get_block(strb
->format
, &block
);
115 strb
->stride
= pf_get_stride(&block
, width
);
116 size
= pf_get_2d_size(&block
, strb
->stride
, height
);
118 strb
->data
= _mesa_malloc(size
);
120 return strb
->data
!= NULL
;
123 struct pipe_texture
template;
124 unsigned surface_usage
;
126 /* Free the old surface and texture
128 pipe_surface_reference( &strb
->surface
, NULL
);
129 pipe_texture_reference( &strb
->texture
, NULL
);
131 /* Setup new texture template.
133 memset(&template, 0, sizeof(template));
134 template.target
= PIPE_TEXTURE_2D
;
135 template.format
= format
;
136 pf_get_block(format
, &template.block
);
137 template.width
[0] = width
;
138 template.height
[0] = height
;
139 template.depth
[0] = 1;
140 template.last_level
= 0;
141 template.nr_samples
= rb
->NumSamples
;
142 if (pf_is_depth_stencil(format
)) {
143 template.tex_usage
= PIPE_TEXTURE_USAGE_DEPTH_STENCIL
;
146 template.tex_usage
= (PIPE_TEXTURE_USAGE_DISPLAY_TARGET
|
147 PIPE_TEXTURE_USAGE_RENDER_TARGET
);
150 /* Probably need dedicated flags for surface usage too:
152 surface_usage
= (PIPE_BUFFER_USAGE_GPU_READ
|
153 PIPE_BUFFER_USAGE_GPU_WRITE
);
155 PIPE_BUFFER_USAGE_CPU_READ
|
156 PIPE_BUFFER_USAGE_CPU_WRITE
);
159 strb
->texture
= pipe
->screen
->texture_create( pipe
->screen
,
165 strb
->surface
= pipe
->screen
->get_tex_surface( pipe
->screen
,
170 assert(strb
->surface
->texture
);
171 assert(strb
->surface
->format
);
172 assert(strb
->surface
->width
== width
);
173 assert(strb
->surface
->height
== height
);
176 return strb
->surface
!= NULL
;
182 * gl_renderbuffer::Delete()
185 st_renderbuffer_delete(struct gl_renderbuffer
*rb
)
187 struct st_renderbuffer
*strb
= st_renderbuffer(rb
);
189 pipe_surface_reference(&strb
->surface
, NULL
);
190 pipe_texture_reference(&strb
->texture
, NULL
);
191 _mesa_free(strb
->data
);
197 * gl_renderbuffer::GetPointer()
200 null_get_pointer(GLcontext
* ctx
, struct gl_renderbuffer
*rb
,
203 /* By returning NULL we force all software rendering to go through
207 assert(0); /* Should never get called with softpipe */
214 * Called via ctx->Driver.NewFramebuffer()
216 static struct gl_framebuffer
*
217 st_new_framebuffer(GLcontext
*ctx
, GLuint name
)
219 /* XXX not sure we need to subclass gl_framebuffer for pipe */
220 return _mesa_new_framebuffer(ctx
, name
);
225 * Called via ctx->Driver.NewRenderbuffer()
227 static struct gl_renderbuffer
*
228 st_new_renderbuffer(GLcontext
*ctx
, GLuint name
)
230 struct st_renderbuffer
*strb
= ST_CALLOC_STRUCT(st_renderbuffer
);
232 _mesa_init_renderbuffer(&strb
->Base
, name
);
233 strb
->Base
.Delete
= st_renderbuffer_delete
;
234 strb
->Base
.AllocStorage
= st_renderbuffer_alloc_storage
;
235 strb
->Base
.GetPointer
= null_get_pointer
;
236 strb
->format
= PIPE_FORMAT_NONE
;
244 * Allocate a renderbuffer for a an on-screen window (not a user-created
245 * renderbuffer). The window system code determines the format.
247 struct gl_renderbuffer
*
248 st_new_renderbuffer_fb(enum pipe_format format
, int samples
, boolean sw
)
250 struct st_renderbuffer
*strb
;
252 strb
= ST_CALLOC_STRUCT(st_renderbuffer
);
254 _mesa_error(NULL
, GL_OUT_OF_MEMORY
, "creating renderbuffer");
258 _mesa_init_renderbuffer(&strb
->Base
, 0);
259 strb
->Base
.ClassID
= 0x4242; /* just a unique value */
260 strb
->Base
.NumSamples
= samples
;
261 strb
->format
= format
;
262 init_renderbuffer_bits(strb
, format
);
266 case PIPE_FORMAT_A8R8G8B8_UNORM
:
267 case PIPE_FORMAT_B8G8R8A8_UNORM
:
268 case PIPE_FORMAT_X8R8G8B8_UNORM
:
269 case PIPE_FORMAT_B8G8R8X8_UNORM
:
270 case PIPE_FORMAT_A1R5G5B5_UNORM
:
271 case PIPE_FORMAT_A4R4G4B4_UNORM
:
272 case PIPE_FORMAT_R5G6B5_UNORM
:
273 strb
->Base
.InternalFormat
= GL_RGBA
;
274 strb
->Base
._BaseFormat
= GL_RGBA
;
276 case PIPE_FORMAT_Z16_UNORM
:
277 strb
->Base
.InternalFormat
= GL_DEPTH_COMPONENT16
;
278 strb
->Base
._BaseFormat
= GL_DEPTH_COMPONENT
;
280 case PIPE_FORMAT_Z32_UNORM
:
281 strb
->Base
.InternalFormat
= GL_DEPTH_COMPONENT32
;
282 strb
->Base
._BaseFormat
= GL_DEPTH_COMPONENT
;
284 case PIPE_FORMAT_S8Z24_UNORM
:
285 case PIPE_FORMAT_Z24S8_UNORM
:
286 case PIPE_FORMAT_X8Z24_UNORM
:
287 case PIPE_FORMAT_Z24X8_UNORM
:
288 strb
->Base
.InternalFormat
= GL_DEPTH24_STENCIL8_EXT
;
289 strb
->Base
._BaseFormat
= GL_DEPTH_STENCIL_EXT
;
291 case PIPE_FORMAT_S8_UNORM
:
292 strb
->Base
.InternalFormat
= GL_STENCIL_INDEX8_EXT
;
293 strb
->Base
._BaseFormat
= GL_STENCIL_INDEX
;
295 case PIPE_FORMAT_R16G16B16A16_SNORM
:
296 strb
->Base
.InternalFormat
= GL_RGBA16
;
297 strb
->Base
._BaseFormat
= GL_RGBA
;
301 "Unexpected format in st_new_renderbuffer_fb");
306 /* st-specific methods */
307 strb
->Base
.Delete
= st_renderbuffer_delete
;
308 strb
->Base
.AllocStorage
= st_renderbuffer_alloc_storage
;
309 strb
->Base
.GetPointer
= null_get_pointer
;
311 /* surface is allocated in st_renderbuffer_alloc_storage() */
312 strb
->surface
= NULL
;
321 * Called via ctx->Driver.BindFramebufferEXT().
324 st_bind_framebuffer(GLcontext
*ctx
, GLenum target
,
325 struct gl_framebuffer
*fb
, struct gl_framebuffer
*fbread
)
331 * Called by ctx->Driver.FramebufferRenderbuffer
334 st_framebuffer_renderbuffer(GLcontext
*ctx
,
335 struct gl_framebuffer
*fb
,
337 struct gl_renderbuffer
*rb
)
339 /* XXX no need for derivation? */
340 _mesa_framebuffer_renderbuffer(ctx
, fb
, attachment
, rb
);
345 * Called by ctx->Driver.RenderTexture
348 st_render_texture(GLcontext
*ctx
,
349 struct gl_framebuffer
*fb
,
350 struct gl_renderbuffer_attachment
*att
)
352 struct pipe_screen
*screen
= ctx
->st
->pipe
->screen
;
353 struct st_renderbuffer
*strb
;
354 struct gl_renderbuffer
*rb
;
355 struct pipe_texture
*pt
= st_get_texobj_texture(att
->Texture
);
356 struct st_texture_object
*stObj
;
357 const struct gl_texture_image
*texImage
=
358 att
->Texture
->Image
[att
->CubeMapFace
][att
->TextureLevel
];
363 /* create new renderbuffer which wraps the texture image */
364 rb
= st_new_renderbuffer(ctx
, 0);
366 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glFramebufferTexture()");
370 _mesa_reference_renderbuffer(&att
->Renderbuffer
, rb
);
371 assert(rb
->RefCount
== 1);
372 rb
->AllocStorage
= NULL
; /* should not get called */
373 strb
= st_renderbuffer(rb
);
375 assert(strb
->Base
.RefCount
> 0);
377 /* get the texture for the texture object */
378 stObj
= st_texture_object(att
->Texture
);
380 /* point renderbuffer at texobject */
382 strb
->rtt_level
= att
->TextureLevel
;
383 strb
->rtt_face
= att
->CubeMapFace
;
384 strb
->rtt_slice
= att
->Zoffset
;
386 rb
->Width
= texImage
->Width2
;
387 rb
->Height
= texImage
->Height2
;
388 rb
->_BaseFormat
= texImage
->_BaseFormat
;
389 /*printf("***** render to texture level %d: %d x %d\n", att->TextureLevel, rb->Width, rb->Height);*/
391 /*printf("***** pipe texture %d x %d\n", pt->width[0], pt->height[0]);*/
393 pipe_texture_reference( &strb
->texture
, pt
);
395 pipe_surface_reference(&strb
->surface
, NULL
);
397 /* new surface for rendering into the texture */
398 strb
->surface
= screen
->get_tex_surface(screen
,
403 PIPE_BUFFER_USAGE_GPU_READ
|
404 PIPE_BUFFER_USAGE_GPU_WRITE
);
406 init_renderbuffer_bits(strb
, pt
->format
);
409 printf("RENDER TO TEXTURE obj=%p pt=%p surf=%p %d x %d\n",
410 att->Texture, pt, strb->surface, rb->Width, rb->Height);
413 /* Invalidate buffer state so that the pipe's framebuffer state
415 * That's where the new renderbuffer (which we just created) gets
416 * passed to the pipe as a (color/depth) render target.
418 st_invalidate_state(ctx
, _NEW_BUFFERS
);
423 * Called via ctx->Driver.FinishRenderTexture.
426 st_finish_render_texture(GLcontext
*ctx
,
427 struct gl_renderbuffer_attachment
*att
)
429 struct st_renderbuffer
*strb
= st_renderbuffer(att
->Renderbuffer
);
434 st_flush( ctx
->st
, PIPE_FLUSH_RENDER_CACHE
, NULL
);
437 pipe_surface_reference( &strb
->surface
, NULL
);
442 printf("FINISH RENDER TO TEXTURE surf=%p\n", strb->surface);
445 _mesa_reference_renderbuffer(&att
->Renderbuffer
, NULL
);
447 /* restore previous framebuffer state */
448 st_invalidate_state(ctx
, _NEW_BUFFERS
);
453 * Validate a renderbuffer attachment for a particular usage.
457 st_validate_attachment(struct pipe_screen
*screen
,
458 const struct gl_renderbuffer_attachment
*att
,
461 const struct st_texture_object
*stObj
=
462 st_texture_object(att
->Texture
);
465 * Only validate texture attachments for now, since
466 * st_renderbuffer_alloc_storage makes sure that
467 * the format is supported.
470 if (att
->Type
!= GL_TEXTURE
)
476 return screen
->is_format_supported(screen
, stObj
->pt
->format
,
482 * Check that the framebuffer configuration is valid in terms of what
483 * the driver can support.
485 * For Gallium we only supports combined Z+stencil, not separate buffers.
488 st_validate_framebuffer(GLcontext
*ctx
, struct gl_framebuffer
*fb
)
490 struct pipe_screen
*screen
= ctx
->st
->pipe
->screen
;
491 const struct gl_renderbuffer
*depthRb
=
492 fb
->Attachment
[BUFFER_DEPTH
].Renderbuffer
;
493 const struct gl_renderbuffer
*stencilRb
=
494 fb
->Attachment
[BUFFER_STENCIL
].Renderbuffer
;
497 if (stencilRb
&& depthRb
&& stencilRb
!= depthRb
) {
498 fb
->_Status
= GL_FRAMEBUFFER_UNSUPPORTED_EXT
;
502 if (!st_validate_attachment(screen
,
503 &fb
->Attachment
[BUFFER_DEPTH
],
504 PIPE_TEXTURE_USAGE_DEPTH_STENCIL
)) {
505 fb
->_Status
= GL_FRAMEBUFFER_UNSUPPORTED_EXT
;
508 if (!st_validate_attachment(screen
,
509 &fb
->Attachment
[BUFFER_STENCIL
],
510 PIPE_TEXTURE_USAGE_DEPTH_STENCIL
)) {
511 fb
->_Status
= GL_FRAMEBUFFER_UNSUPPORTED_EXT
;
514 for (i
= 0; i
< ctx
->Const
.MaxColorAttachments
; i
++) {
515 if (!st_validate_attachment(screen
,
516 &fb
->Attachment
[BUFFER_COLOR0
+ i
],
517 PIPE_TEXTURE_USAGE_RENDER_TARGET
)) {
518 fb
->_Status
= GL_FRAMEBUFFER_UNSUPPORTED_EXT
;
526 * Copy back color buffer to front color buffer.
529 copy_back_to_front(struct st_context
*st
,
530 struct gl_framebuffer
*fb
,
531 gl_buffer_index frontIndex
,
532 gl_buffer_index backIndex
)
535 struct st_framebuffer
*stfb
= (struct st_framebuffer
*) fb
;
536 struct pipe_surface
*surf_front
, *surf_back
;
538 (void) st_get_framebuffer_surface(stfb
, frontIndex
, &surf_front
);
539 (void) st_get_framebuffer_surface(stfb
, backIndex
, &surf_back
);
541 if (surf_front
&& surf_back
) {
542 if (st
->pipe
->surface_copy
) {
543 st
->pipe
->surface_copy(st
->pipe
,
544 surf_front
, 0, 0, /* dest */
545 surf_back
, 0, 0, /* src */
546 fb
->Width
, fb
->Height
);
548 util_surface_copy(st
->pipe
, FALSE
,
551 fb
->Width
, fb
->Height
);
558 * Check if we're drawing into, or read from, a front color buffer. If the
559 * front buffer is missing, create it now.
561 * The back color buffer must exist since we'll use its format/samples info
562 * for creating the front buffer.
564 * \param frontIndex either BUFFER_FRONT_LEFT or BUFFER_FRONT_RIGHT
565 * \param backIndex either BUFFER_BACK_LEFT or BUFFER_BACK_RIGHT
568 check_create_front_buffer(GLcontext
*ctx
, struct gl_framebuffer
*fb
,
569 gl_buffer_index frontIndex
,
570 gl_buffer_index backIndex
)
572 if (fb
->Attachment
[frontIndex
].Renderbuffer
== NULL
) {
573 GLboolean create
= GL_FALSE
;
575 /* check if drawing to or reading from front buffer */
576 if (fb
->_ColorReadBufferIndex
== frontIndex
) {
581 for (b
= 0; b
< fb
->_NumColorDrawBuffers
; b
++) {
582 if (fb
->_ColorDrawBufferIndexes
[b
] == frontIndex
) {
590 struct st_renderbuffer
*back
;
591 struct gl_renderbuffer
*front
;
592 enum pipe_format colorFormat
;
596 _mesa_debug(ctx
, "Allocate new front buffer\n");
598 /* get back renderbuffer info */
599 back
= st_renderbuffer(fb
->Attachment
[backIndex
].Renderbuffer
);
600 colorFormat
= back
->format
;
601 samples
= back
->Base
.NumSamples
;
603 /* create front renderbuffer */
604 front
= st_new_renderbuffer_fb(colorFormat
, samples
, FALSE
);
605 _mesa_add_renderbuffer(fb
, frontIndex
, front
);
607 /* alloc texture/surface for new front buffer */
608 front
->AllocStorage(ctx
, front
, front
->InternalFormat
,
609 fb
->Width
, fb
->Height
);
611 /* initialize the front color buffer contents by copying
614 copy_back_to_front(ctx
->st
, fb
, frontIndex
, backIndex
);
621 * If front left/right color buffers are missing, create them now.
624 check_create_front_buffers(GLcontext
*ctx
, struct gl_framebuffer
*fb
)
626 /* check if we need to create the front left buffer now */
627 check_create_front_buffer(ctx
, fb
, BUFFER_FRONT_LEFT
, BUFFER_BACK_LEFT
);
629 if (fb
->Visual
.stereoMode
) {
630 check_create_front_buffer(ctx
, fb
, BUFFER_FRONT_RIGHT
, BUFFER_BACK_RIGHT
);
633 st_invalidate_state(ctx
, _NEW_BUFFERS
);
638 * Called via glDrawBuffer.
641 st_DrawBuffers(GLcontext
*ctx
, GLsizei count
, const GLenum
*buffers
)
645 check_create_front_buffers(ctx
, ctx
->DrawBuffer
);
650 * Called via glReadBuffer.
653 st_ReadBuffer(GLcontext
*ctx
, GLenum buffer
)
656 check_create_front_buffers(ctx
, ctx
->ReadBuffer
);
660 void st_init_fbo_functions(struct dd_function_table
*functions
)
662 functions
->NewFramebuffer
= st_new_framebuffer
;
663 functions
->NewRenderbuffer
= st_new_renderbuffer
;
664 functions
->BindFramebuffer
= st_bind_framebuffer
;
665 functions
->FramebufferRenderbuffer
= st_framebuffer_renderbuffer
;
666 functions
->RenderTexture
= st_render_texture
;
667 functions
->FinishRenderTexture
= st_finish_render_texture
;
668 functions
->ValidateFramebuffer
= st_validate_framebuffer
;
669 /* no longer needed by core Mesa, drivers handle resizes...
670 functions->ResizeBuffers = st_resize_buffers;
673 functions
->DrawBuffers
= st_DrawBuffers
;
674 functions
->ReadBuffer
= st_ReadBuffer
;