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_format.h"
53 #include "util/u_rect.h"
57 * Compute the renderbuffer's Red/Green/EtcBit fields from the pipe format.
60 init_renderbuffer_bits(struct st_renderbuffer
*strb
,
61 enum pipe_format pipeFormat
)
63 struct pipe_format_info info
;
65 if (!st_get_format_info( pipeFormat
, &info
)) {
69 strb
->Base
.Format
= info
.mesa_format
;
70 strb
->Base
.DataType
= st_format_datatype(pipeFormat
);
76 * gl_renderbuffer::AllocStorage()
77 * This is called to allocate the original drawing surface, and
78 * during window resize.
81 st_renderbuffer_alloc_storage(GLcontext
* ctx
, struct gl_renderbuffer
*rb
,
82 GLenum internalFormat
,
83 GLuint width
, GLuint height
)
85 struct pipe_context
*pipe
= ctx
->st
->pipe
;
86 struct st_renderbuffer
*strb
= st_renderbuffer(rb
);
87 enum pipe_format format
;
89 if (strb
->format
!= PIPE_FORMAT_NONE
)
90 format
= strb
->format
;
92 format
= st_choose_renderbuffer_format(pipe
->screen
, internalFormat
);
94 /* init renderbuffer fields */
95 strb
->Base
.Width
= width
;
96 strb
->Base
.Height
= height
;
97 init_renderbuffer_bits(strb
, format
);
99 strb
->defined
= GL_FALSE
; /* undefined contents now */
104 _mesa_free(strb
->data
);
106 assert(strb
->format
!= PIPE_FORMAT_NONE
);
108 strb
->stride
= util_format_get_stride(strb
->format
, width
);
109 size
= util_format_get_2d_size(strb
->format
, strb
->stride
, height
);
111 strb
->data
= _mesa_malloc(size
);
113 return strb
->data
!= NULL
;
116 struct pipe_texture
template;
117 unsigned surface_usage
;
119 /* Free the old surface and texture
121 pipe_surface_reference( &strb
->surface
, NULL
);
122 pipe_texture_reference( &strb
->texture
, NULL
);
124 /* Setup new texture template.
126 memset(&template, 0, sizeof(template));
127 template.target
= PIPE_TEXTURE_2D
;
128 template.format
= format
;
129 template.width0
= width
;
130 template.height0
= height
;
132 template.last_level
= 0;
133 template.nr_samples
= rb
->NumSamples
;
134 if (util_format_is_depth_or_stencil(format
)) {
135 template.tex_usage
= PIPE_TEXTURE_USAGE_DEPTH_STENCIL
;
138 template.tex_usage
= (PIPE_TEXTURE_USAGE_DISPLAY_TARGET
|
139 PIPE_TEXTURE_USAGE_RENDER_TARGET
);
142 /* Probably need dedicated flags for surface usage too:
144 surface_usage
= (PIPE_BUFFER_USAGE_GPU_READ
|
145 PIPE_BUFFER_USAGE_GPU_WRITE
);
147 PIPE_BUFFER_USAGE_CPU_READ
|
148 PIPE_BUFFER_USAGE_CPU_WRITE
);
151 strb
->texture
= pipe
->screen
->texture_create( pipe
->screen
,
157 strb
->surface
= pipe
->screen
->get_tex_surface( pipe
->screen
,
162 assert(strb
->surface
->texture
);
163 assert(strb
->surface
->format
);
164 assert(strb
->surface
->width
== width
);
165 assert(strb
->surface
->height
== height
);
168 return strb
->surface
!= NULL
;
174 * gl_renderbuffer::Delete()
177 st_renderbuffer_delete(struct gl_renderbuffer
*rb
)
179 struct st_renderbuffer
*strb
= st_renderbuffer(rb
);
181 pipe_surface_reference(&strb
->surface
, NULL
);
182 pipe_texture_reference(&strb
->texture
, NULL
);
183 _mesa_free(strb
->data
);
189 * gl_renderbuffer::GetPointer()
192 null_get_pointer(GLcontext
* ctx
, struct gl_renderbuffer
*rb
,
195 /* By returning NULL we force all software rendering to go through
199 assert(0); /* Should never get called with softpipe */
206 * Called via ctx->Driver.NewFramebuffer()
208 static struct gl_framebuffer
*
209 st_new_framebuffer(GLcontext
*ctx
, GLuint name
)
211 /* XXX not sure we need to subclass gl_framebuffer for pipe */
212 return _mesa_new_framebuffer(ctx
, name
);
217 * Called via ctx->Driver.NewRenderbuffer()
219 static struct gl_renderbuffer
*
220 st_new_renderbuffer(GLcontext
*ctx
, GLuint name
)
222 struct st_renderbuffer
*strb
= ST_CALLOC_STRUCT(st_renderbuffer
);
224 _mesa_init_renderbuffer(&strb
->Base
, name
);
225 strb
->Base
.Delete
= st_renderbuffer_delete
;
226 strb
->Base
.AllocStorage
= st_renderbuffer_alloc_storage
;
227 strb
->Base
.GetPointer
= null_get_pointer
;
228 strb
->format
= PIPE_FORMAT_NONE
;
236 * Allocate a renderbuffer for a an on-screen window (not a user-created
237 * renderbuffer). The window system code determines the format.
239 struct gl_renderbuffer
*
240 st_new_renderbuffer_fb(enum pipe_format format
, int samples
, boolean sw
)
242 struct st_renderbuffer
*strb
;
244 strb
= ST_CALLOC_STRUCT(st_renderbuffer
);
246 _mesa_error(NULL
, GL_OUT_OF_MEMORY
, "creating renderbuffer");
250 _mesa_init_renderbuffer(&strb
->Base
, 0);
251 strb
->Base
.ClassID
= 0x4242; /* just a unique value */
252 strb
->Base
.NumSamples
= samples
;
253 strb
->format
= format
;
254 init_renderbuffer_bits(strb
, format
);
258 case PIPE_FORMAT_A8R8G8B8_UNORM
:
259 case PIPE_FORMAT_B8G8R8A8_UNORM
:
260 case PIPE_FORMAT_X8R8G8B8_UNORM
:
261 case PIPE_FORMAT_B8G8R8X8_UNORM
:
262 case PIPE_FORMAT_A1R5G5B5_UNORM
:
263 case PIPE_FORMAT_A4R4G4B4_UNORM
:
264 case PIPE_FORMAT_R5G6B5_UNORM
:
265 strb
->Base
.InternalFormat
= GL_RGBA
;
267 case PIPE_FORMAT_Z16_UNORM
:
268 strb
->Base
.InternalFormat
= GL_DEPTH_COMPONENT16
;
270 case PIPE_FORMAT_Z32_UNORM
:
271 strb
->Base
.InternalFormat
= GL_DEPTH_COMPONENT32
;
273 case PIPE_FORMAT_S8Z24_UNORM
:
274 case PIPE_FORMAT_Z24S8_UNORM
:
275 case PIPE_FORMAT_X8Z24_UNORM
:
276 case PIPE_FORMAT_Z24X8_UNORM
:
277 strb
->Base
.InternalFormat
= GL_DEPTH24_STENCIL8_EXT
;
279 case PIPE_FORMAT_S8_UNORM
:
280 strb
->Base
.InternalFormat
= GL_STENCIL_INDEX8_EXT
;
282 case PIPE_FORMAT_R16G16B16A16_SNORM
:
283 strb
->Base
.InternalFormat
= GL_RGBA16
;
287 "Unexpected format in st_new_renderbuffer_fb");
292 /* st-specific methods */
293 strb
->Base
.Delete
= st_renderbuffer_delete
;
294 strb
->Base
.AllocStorage
= st_renderbuffer_alloc_storage
;
295 strb
->Base
.GetPointer
= null_get_pointer
;
297 /* surface is allocated in st_renderbuffer_alloc_storage() */
298 strb
->surface
= NULL
;
307 * Called via ctx->Driver.BindFramebufferEXT().
310 st_bind_framebuffer(GLcontext
*ctx
, GLenum target
,
311 struct gl_framebuffer
*fb
, struct gl_framebuffer
*fbread
)
317 * Called by ctx->Driver.FramebufferRenderbuffer
320 st_framebuffer_renderbuffer(GLcontext
*ctx
,
321 struct gl_framebuffer
*fb
,
323 struct gl_renderbuffer
*rb
)
325 /* XXX no need for derivation? */
326 _mesa_framebuffer_renderbuffer(ctx
, fb
, attachment
, rb
);
331 * Called by ctx->Driver.RenderTexture
334 st_render_texture(GLcontext
*ctx
,
335 struct gl_framebuffer
*fb
,
336 struct gl_renderbuffer_attachment
*att
)
338 struct pipe_screen
*screen
= ctx
->st
->pipe
->screen
;
339 struct st_renderbuffer
*strb
;
340 struct gl_renderbuffer
*rb
;
341 struct pipe_texture
*pt
= st_get_texobj_texture(att
->Texture
);
342 struct st_texture_object
*stObj
;
343 const struct gl_texture_image
*texImage
=
344 att
->Texture
->Image
[att
->CubeMapFace
][att
->TextureLevel
];
349 /* create new renderbuffer which wraps the texture image */
350 rb
= st_new_renderbuffer(ctx
, 0);
352 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glFramebufferTexture()");
356 _mesa_reference_renderbuffer(&att
->Renderbuffer
, rb
);
357 assert(rb
->RefCount
== 1);
358 rb
->AllocStorage
= NULL
; /* should not get called */
359 strb
= st_renderbuffer(rb
);
361 assert(strb
->Base
.RefCount
> 0);
363 /* get the texture for the texture object */
364 stObj
= st_texture_object(att
->Texture
);
366 /* point renderbuffer at texobject */
368 strb
->rtt_level
= att
->TextureLevel
;
369 strb
->rtt_face
= att
->CubeMapFace
;
370 strb
->rtt_slice
= att
->Zoffset
;
372 rb
->Width
= texImage
->Width2
;
373 rb
->Height
= texImage
->Height2
;
374 rb
->_BaseFormat
= texImage
->_BaseFormat
;
375 /*printf("***** render to texture level %d: %d x %d\n", att->TextureLevel, rb->Width, rb->Height);*/
377 /*printf("***** pipe texture %d x %d\n", pt->width0, pt->height0);*/
379 pipe_texture_reference( &strb
->texture
, pt
);
381 pipe_surface_reference(&strb
->surface
, NULL
);
383 /* new surface for rendering into the texture */
384 strb
->surface
= screen
->get_tex_surface(screen
,
389 PIPE_BUFFER_USAGE_GPU_READ
|
390 PIPE_BUFFER_USAGE_GPU_WRITE
);
392 init_renderbuffer_bits(strb
, pt
->format
);
395 printf("RENDER TO TEXTURE obj=%p pt=%p surf=%p %d x %d\n",
396 att->Texture, pt, strb->surface, rb->Width, rb->Height);
399 /* Invalidate buffer state so that the pipe's framebuffer state
401 * That's where the new renderbuffer (which we just created) gets
402 * passed to the pipe as a (color/depth) render target.
404 st_invalidate_state(ctx
, _NEW_BUFFERS
);
409 * Called via ctx->Driver.FinishRenderTexture.
412 st_finish_render_texture(GLcontext
*ctx
,
413 struct gl_renderbuffer_attachment
*att
)
415 struct st_renderbuffer
*strb
= st_renderbuffer(att
->Renderbuffer
);
420 st_flush( ctx
->st
, PIPE_FLUSH_RENDER_CACHE
, NULL
);
423 pipe_surface_reference( &strb
->surface
, NULL
);
428 printf("FINISH RENDER TO TEXTURE surf=%p\n", strb->surface);
431 _mesa_reference_renderbuffer(&att
->Renderbuffer
, NULL
);
433 /* restore previous framebuffer state */
434 st_invalidate_state(ctx
, _NEW_BUFFERS
);
439 * Validate a renderbuffer attachment for a particular usage.
443 st_validate_attachment(struct pipe_screen
*screen
,
444 const struct gl_renderbuffer_attachment
*att
,
447 const struct st_texture_object
*stObj
=
448 st_texture_object(att
->Texture
);
451 * Only validate texture attachments for now, since
452 * st_renderbuffer_alloc_storage makes sure that
453 * the format is supported.
456 if (att
->Type
!= GL_TEXTURE
)
462 return screen
->is_format_supported(screen
, stObj
->pt
->format
,
468 * Check that the framebuffer configuration is valid in terms of what
469 * the driver can support.
471 * For Gallium we only supports combined Z+stencil, not separate buffers.
474 st_validate_framebuffer(GLcontext
*ctx
, struct gl_framebuffer
*fb
)
476 struct pipe_screen
*screen
= ctx
->st
->pipe
->screen
;
477 const struct gl_renderbuffer
*depthRb
=
478 fb
->Attachment
[BUFFER_DEPTH
].Renderbuffer
;
479 const struct gl_renderbuffer
*stencilRb
=
480 fb
->Attachment
[BUFFER_STENCIL
].Renderbuffer
;
483 if (stencilRb
&& depthRb
&& stencilRb
!= depthRb
) {
484 fb
->_Status
= GL_FRAMEBUFFER_UNSUPPORTED_EXT
;
488 if (!st_validate_attachment(screen
,
489 &fb
->Attachment
[BUFFER_DEPTH
],
490 PIPE_TEXTURE_USAGE_DEPTH_STENCIL
)) {
491 fb
->_Status
= GL_FRAMEBUFFER_UNSUPPORTED_EXT
;
494 if (!st_validate_attachment(screen
,
495 &fb
->Attachment
[BUFFER_STENCIL
],
496 PIPE_TEXTURE_USAGE_DEPTH_STENCIL
)) {
497 fb
->_Status
= GL_FRAMEBUFFER_UNSUPPORTED_EXT
;
500 for (i
= 0; i
< ctx
->Const
.MaxColorAttachments
; i
++) {
501 if (!st_validate_attachment(screen
,
502 &fb
->Attachment
[BUFFER_COLOR0
+ i
],
503 PIPE_TEXTURE_USAGE_RENDER_TARGET
)) {
504 fb
->_Status
= GL_FRAMEBUFFER_UNSUPPORTED_EXT
;
512 * Copy back color buffer to front color buffer.
515 copy_back_to_front(struct st_context
*st
,
516 struct gl_framebuffer
*fb
,
517 gl_buffer_index frontIndex
,
518 gl_buffer_index backIndex
)
521 struct st_framebuffer
*stfb
= (struct st_framebuffer
*) fb
;
522 struct pipe_surface
*surf_front
, *surf_back
;
524 (void) st_get_framebuffer_surface(stfb
, frontIndex
, &surf_front
);
525 (void) st_get_framebuffer_surface(stfb
, backIndex
, &surf_back
);
527 if (surf_front
&& surf_back
) {
528 if (st
->pipe
->surface_copy
) {
529 st
->pipe
->surface_copy(st
->pipe
,
530 surf_front
, 0, 0, /* dest */
531 surf_back
, 0, 0, /* src */
532 fb
->Width
, fb
->Height
);
534 util_surface_copy(st
->pipe
, FALSE
,
537 fb
->Width
, fb
->Height
);
544 * Check if we're drawing into, or read from, a front color buffer. If the
545 * front buffer is missing, create it now.
547 * The back color buffer must exist since we'll use its format/samples info
548 * for creating the front buffer.
550 * \param frontIndex either BUFFER_FRONT_LEFT or BUFFER_FRONT_RIGHT
551 * \param backIndex either BUFFER_BACK_LEFT or BUFFER_BACK_RIGHT
554 check_create_front_buffer(GLcontext
*ctx
, struct gl_framebuffer
*fb
,
555 gl_buffer_index frontIndex
,
556 gl_buffer_index backIndex
)
558 if (fb
->Attachment
[frontIndex
].Renderbuffer
== NULL
) {
559 GLboolean create
= GL_FALSE
;
561 /* check if drawing to or reading from front buffer */
562 if (fb
->_ColorReadBufferIndex
== frontIndex
) {
567 for (b
= 0; b
< fb
->_NumColorDrawBuffers
; b
++) {
568 if (fb
->_ColorDrawBufferIndexes
[b
] == frontIndex
) {
576 struct st_renderbuffer
*back
;
577 struct gl_renderbuffer
*front
;
578 enum pipe_format colorFormat
;
582 _mesa_debug(ctx
, "Allocate new front buffer\n");
584 /* get back renderbuffer info */
585 back
= st_renderbuffer(fb
->Attachment
[backIndex
].Renderbuffer
);
586 colorFormat
= back
->format
;
587 samples
= back
->Base
.NumSamples
;
589 /* create front renderbuffer */
590 front
= st_new_renderbuffer_fb(colorFormat
, samples
, FALSE
);
591 _mesa_add_renderbuffer(fb
, frontIndex
, front
);
593 /* alloc texture/surface for new front buffer */
594 front
->AllocStorage(ctx
, front
, front
->InternalFormat
,
595 fb
->Width
, fb
->Height
);
597 /* initialize the front color buffer contents by copying
600 copy_back_to_front(ctx
->st
, fb
, frontIndex
, backIndex
);
607 * If front left/right color buffers are missing, create them now.
610 check_create_front_buffers(GLcontext
*ctx
, struct gl_framebuffer
*fb
)
612 /* check if we need to create the front left buffer now */
613 check_create_front_buffer(ctx
, fb
, BUFFER_FRONT_LEFT
, BUFFER_BACK_LEFT
);
615 if (fb
->Visual
.stereoMode
) {
616 check_create_front_buffer(ctx
, fb
, BUFFER_FRONT_RIGHT
, BUFFER_BACK_RIGHT
);
619 st_invalidate_state(ctx
, _NEW_BUFFERS
);
624 * Called via glDrawBuffer.
627 st_DrawBuffers(GLcontext
*ctx
, GLsizei count
, const GLenum
*buffers
)
631 check_create_front_buffers(ctx
, ctx
->DrawBuffer
);
636 * Called via glReadBuffer.
639 st_ReadBuffer(GLcontext
*ctx
, GLenum buffer
)
642 check_create_front_buffers(ctx
, ctx
->ReadBuffer
);
646 void st_init_fbo_functions(struct dd_function_table
*functions
)
648 functions
->NewFramebuffer
= st_new_framebuffer
;
649 functions
->NewRenderbuffer
= st_new_renderbuffer
;
650 functions
->BindFramebuffer
= st_bind_framebuffer
;
651 functions
->FramebufferRenderbuffer
= st_framebuffer_renderbuffer
;
652 functions
->RenderTexture
= st_render_texture
;
653 functions
->FinishRenderTexture
= st_finish_render_texture
;
654 functions
->ValidateFramebuffer
= st_validate_framebuffer
;
655 /* no longer needed by core Mesa, drivers handle resizes...
656 functions->ResizeBuffers = st_resize_buffers;
659 functions
->DrawBuffers
= st_DrawBuffers
;
660 functions
->ReadBuffer
= st_ReadBuffer
;