src/mesa/state_tracker/st_cb_clear.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
   4  * All Rights Reserved.
   5  * Copyright 2009 VMware, Inc.  All Rights Reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the
   9  * "Software"), to deal in the Software without restriction, including
  10  * without limitation the rights to use, copy, modify, merge, publish,
  11  * distribute, sub license, and/or sell copies of the Software, and to
  12  * permit persons to whom the Software is furnished to do so, subject to
  13  * the following conditions:
  14  *
  15  * The above copyright notice and this permission notice (including the
  16  * next paragraph) shall be included in all copies or substantial portions
  17  * of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  20  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  21  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  22  * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
  23  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  24  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  25  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  26  *
  27  **************************************************************************/
  28
  29  /*
  30   * Authors:
  31   *   Keith Whitwell <keith@tungstengraphics.com>
  32   *   Brian Paul
  33   *   Michel Dänzer
  34   */
  35
  36 #include "main/glheader.h"
  37 #include "main/formats.h"
  38 #include "main/macros.h"
  39 #include "shader/prog_instruction.h"
  40 #include "st_context.h"
  41 #include "st_atom.h"
  42 #include "st_cb_accum.h"
  43 #include "st_cb_clear.h"
  44 #include "st_cb_fbo.h"
  45 #include "st_program.h"
  46 #include "st_public.h"
  47 #include "st_inlines.h"
  48
  49 #include "pipe/p_context.h"
  50 #include "util/u_inlines.h"
  51 #include "pipe/p_state.h"
  52 #include "pipe/p_defines.h"
  53 #include "util/u_format.h"
  54 #include "util/u_simple_shaders.h"
  55 #include "util/u_draw_quad.h"
  56
  57 #include "cso_cache/cso_context.h"
  58
  59
  60 void
  61 st_init_clear(struct st_context *st)
  62 {
  63    struct pipe_context *pipe = st->pipe;
  64
  65    memset(&st->clear, 0, sizeof(st->clear));
  66
  67    st->clear.raster.gl_rasterization_rules = 1;
  68
  69    /* fragment shader state: color pass-through program */
  70    st->clear.fs =
  71       util_make_fragment_passthrough_shader(pipe);
  72
  73    /* vertex shader state: color/position pass-through */
  74    {
  75       const uint semantic_names[] = { TGSI_SEMANTIC_POSITION,
  76                                       TGSI_SEMANTIC_COLOR };
  77       const uint semantic_indexes[] = { 0, 0 };
  78       st->clear.vs = util_make_vertex_passthrough_shader(pipe, 2,
  79                                                          semantic_names,
  80                                                          semantic_indexes);
  81    }
  82 }
  83
  84
  85 void
  86 st_destroy_clear(struct st_context *st)
  87 {
  88    if (st->clear.fs) {
  89       cso_delete_fragment_shader(st->cso_context, st->clear.fs);
  90       st->clear.fs = NULL;
  91    }
  92    if (st->clear.vs) {
  93       cso_delete_vertex_shader(st->cso_context, st->clear.vs);
  94       st->clear.vs = NULL;
  95    }
  96    if (st->clear.vbuf) {
  97       pipe_buffer_reference(&st->clear.vbuf, NULL);
  98       st->clear.vbuf = NULL;
  99    }
 100 }
 101
 102
 103 /**
 104  * Draw a screen-aligned quadrilateral.
 105  * Coords are clip coords with y=0=bottom.
 106  */
 107 static void
 108 draw_quad(GLcontext *ctx,
 109           float x0, float y0, float x1, float y1, GLfloat z,
 110           const GLfloat color[4])
 111 {
 112    struct st_context *st = ctx->st;
 113    struct pipe_context *pipe = st->pipe;
 114
 115    /* XXX: Need to improve buffer_write to allow NO_WAIT (as well as
 116     * no_flush) updates to buffers where we know there is no conflict
 117     * with previous data.  Currently using max_slots > 1 will cause
 118     * synchronous rendering if the driver flushes its command buffers
 119     * between one bitmap and the next.  Our flush hook below isn't
 120     * sufficient to catch this as the driver doesn't tell us when it
 121     * flushes its own command buffers.  Until this gets fixed, pay the
 122     * price of allocating a new buffer for each bitmap cache-flush to
 123     * avoid synchronous rendering.
 124     */
 125    const GLuint max_slots = 1; /* 1024 / sizeof(st->clear.vertices); */
 126    GLuint i;
 127
 128    if (st->clear.vbuf_slot >= max_slots) {
 129       pipe_buffer_reference(&st->clear.vbuf, NULL);
 130       st->clear.vbuf_slot = 0;
 131    }
 132
 133    if (!st->clear.vbuf) {
 134       st->clear.vbuf = pipe_buffer_create(pipe->screen, 32, PIPE_BUFFER_USAGE_VERTEX,
 135                                           max_slots * sizeof(st->clear.vertices));
 136    }
 137
 138    /* positions */
 139    st->clear.vertices[0][0][0] = x0;
 140    st->clear.vertices[0][0][1] = y0;
 141
 142    st->clear.vertices[1][0][0] = x1;
 143    st->clear.vertices[1][0][1] = y0;
 144
 145    st->clear.vertices[2][0][0] = x1;
 146    st->clear.vertices[2][0][1] = y1;
 147
 148    st->clear.vertices[3][0][0] = x0;
 149    st->clear.vertices[3][0][1] = y1;
 150
 151    /* same for all verts: */
 152    for (i = 0; i < 4; i++) {
 153       st->clear.vertices[i][0][2] = z;
 154       st->clear.vertices[i][0][3] = 1.0;
 155       st->clear.vertices[i][1][0] = color[0];
 156       st->clear.vertices[i][1][1] = color[1];
 157       st->clear.vertices[i][1][2] = color[2];
 158       st->clear.vertices[i][1][3] = color[3];
 159    }
 160
 161    /* put vertex data into vbuf */
 162    st_no_flush_pipe_buffer_write_nooverlap(st, st->clear.vbuf,
 163                                            st->clear.vbuf_slot * sizeof(st->clear.vertices),
 164                                            sizeof(st->clear.vertices),
 165                                            st->clear.vertices);
 166
 167    /* draw */
 168    util_draw_vertex_buffer(pipe,
 169                            st->clear.vbuf,
 170                            st->clear.vbuf_slot * sizeof(st->clear.vertices),
 171                            PIPE_PRIM_TRIANGLE_FAN,
 172                            4,  /* verts */
 173                            2); /* attribs/vert */
 174
 175    /* Increment slot */
 176    st->clear.vbuf_slot++;
 177 }
 178
 179
 180
 181 /**
 182  * Do glClear by drawing a quadrilateral.
 183  * The vertices of the quad will be computed from the
 184  * ctx->DrawBuffer->_X/Ymin/max fields.
 185  */
 186 static void
 187 clear_with_quad(GLcontext *ctx,
 188                 GLboolean color, GLboolean depth, GLboolean stencil)
 189 {
 190    struct st_context *st = ctx->st;
 191    const struct gl_framebuffer *fb = ctx->DrawBuffer;
 192    const GLfloat fb_width = (GLfloat) fb->Width;
 193    const GLfloat fb_height = (GLfloat) fb->Height;
 194    const GLfloat x0 = (GLfloat) ctx->DrawBuffer->_Xmin / fb_width * 2.0f - 1.0f;
 195    const GLfloat x1 = (GLfloat) ctx->DrawBuffer->_Xmax / fb_width * 2.0f - 1.0f;
 196    const GLfloat y0 = (GLfloat) ctx->DrawBuffer->_Ymin / fb_height * 2.0f - 1.0f;
 197    const GLfloat y1 = (GLfloat) ctx->DrawBuffer->_Ymax / fb_height * 2.0f - 1.0f;
 198
 199    /*
 200    printf("%s %s%s%s %f,%f %f,%f\n", __FUNCTION__,
 201           color ? "color, " : "",
 202           depth ? "depth, " : "",
 203           stencil ? "stencil" : "",
 204           x0, y0,
 205           x1, y1);
 206    */
 207
 208    cso_save_blend(st->cso_context);
 209    cso_save_stencil_ref(st->cso_context);
 210    cso_save_depth_stencil_alpha(st->cso_context);
 211    cso_save_rasterizer(st->cso_context);
 212    cso_save_viewport(st->cso_context);
 213    cso_save_clip(st->cso_context);
 214    cso_save_fragment_shader(st->cso_context);
 215    cso_save_vertex_shader(st->cso_context);
 216
 217    /* blend state: RGBA masking */
 218    {
 219       struct pipe_blend_state blend;
 220       memset(&blend, 0, sizeof(blend));
 221       blend.rt[0].rgb_src_factor = PIPE_BLENDFACTOR_ONE;
 222       blend.rt[0].alpha_src_factor = PIPE_BLENDFACTOR_ONE;
 223       blend.rt[0].rgb_dst_factor = PIPE_BLENDFACTOR_ZERO;
 224       blend.rt[0].alpha_dst_factor = PIPE_BLENDFACTOR_ZERO;
 225       if (color) {
 226          if (ctx->Color.ColorMask[0][0])
 227             blend.rt[0].colormask |= PIPE_MASK_R;
 228          if (ctx->Color.ColorMask[0][1])
 229             blend.rt[0].colormask |= PIPE_MASK_G;
 230          if (ctx->Color.ColorMask[0][2])
 231             blend.rt[0].colormask |= PIPE_MASK_B;
 232          if (ctx->Color.ColorMask[0][3])
 233             blend.rt[0].colormask |= PIPE_MASK_A;
 234          if (st->ctx->Color.DitherFlag)
 235             blend.dither = 1;
 236       }
 237       cso_set_blend(st->cso_context, &blend);
 238    }
 239
 240    /* depth_stencil state: always pass/set to ref value */
 241    {
 242       struct pipe_depth_stencil_alpha_state depth_stencil;
 243       memset(&depth_stencil, 0, sizeof(depth_stencil));
 244       if (depth) {
 245          depth_stencil.depth.enabled = 1;
 246          depth_stencil.depth.writemask = 1;
 247          depth_stencil.depth.func = PIPE_FUNC_ALWAYS;
 248       }
 249
 250       if (stencil) {
 251          struct pipe_stencil_ref stencil_ref;
 252          memset(&stencil_ref, 0, sizeof(stencil_ref));
 253          depth_stencil.stencil[0].enabled = 1;
 254          depth_stencil.stencil[0].func = PIPE_FUNC_ALWAYS;
 255          depth_stencil.stencil[0].fail_op = PIPE_STENCIL_OP_REPLACE;
 256          depth_stencil.stencil[0].zpass_op = PIPE_STENCIL_OP_REPLACE;
 257          depth_stencil.stencil[0].zfail_op = PIPE_STENCIL_OP_REPLACE;
 258          depth_stencil.stencil[0].valuemask = 0xff;
 259          depth_stencil.stencil[0].writemask = ctx->Stencil.WriteMask[0] & 0xff;
 260          stencil_ref.ref_value[0] = ctx->Stencil.Clear;
 261          cso_set_stencil_ref(st->cso_context, &stencil_ref);
 262       }
 263
 264       cso_set_depth_stencil_alpha(st->cso_context, &depth_stencil);
 265    }
 266
 267    cso_set_rasterizer(st->cso_context, &st->clear.raster);
 268
 269    /* viewport state: viewport matching window dims */
 270    {
 271       const GLboolean invert = (st_fb_orientation(fb) == Y_0_TOP);
 272       struct pipe_viewport_state vp;
 273       vp.scale[0] = 0.5f * fb_width;
 274       vp.scale[1] = fb_height * (invert ? -0.5f : 0.5f);
 275       vp.scale[2] = 1.0f;
 276       vp.scale[3] = 1.0f;
 277       vp.translate[0] = 0.5f * fb_width;
 278       vp.translate[1] = 0.5f * fb_height;
 279       vp.translate[2] = 0.0f;
 280       vp.translate[3] = 0.0f;
 281       cso_set_viewport(st->cso_context, &vp);
 282    }
 283
 284    cso_set_clip(st->cso_context, &st->clear.clip);
 285    cso_set_fragment_shader_handle(st->cso_context, st->clear.fs);
 286    cso_set_vertex_shader_handle(st->cso_context, st->clear.vs);
 287
 288    /* draw quad matching scissor rect (XXX verify coord round-off) */
 289    draw_quad(ctx, x0, y0, x1, y1, (GLfloat) ctx->Depth.Clear, ctx->Color.ClearColor);
 290
 291    /* Restore pipe state */
 292    cso_restore_blend(st->cso_context);
 293    cso_restore_stencil_ref(st->cso_context);
 294    cso_restore_depth_stencil_alpha(st->cso_context);
 295    cso_restore_rasterizer(st->cso_context);
 296    cso_restore_viewport(st->cso_context);
 297    cso_restore_clip(st->cso_context);
 298    cso_restore_fragment_shader(st->cso_context);
 299    cso_restore_vertex_shader(st->cso_context);
 300 }
 301
 302
 303 /**
 304  * Determine if we need to clear the depth buffer by drawing a quad.
 305  */
 306 static INLINE GLboolean
 307 check_clear_color_with_quad(GLcontext *ctx, struct gl_renderbuffer *rb)
 308 {
 309    if (ctx->Scissor.Enabled &&
 310        (ctx->Scissor.X != 0 ||
 311         ctx->Scissor.Y != 0 ||
 312         ctx->Scissor.Width < rb->Width ||
 313         ctx->Scissor.Height < rb->Height))
 314       return TRUE;
 315
 316    if (!ctx->Color.ColorMask[0][0] ||
 317        !ctx->Color.ColorMask[0][1] ||
 318        !ctx->Color.ColorMask[0][2] ||
 319        !ctx->Color.ColorMask[0][3])
 320       return TRUE;
 321
 322    return FALSE;
 323 }
 324
 325
 326 static INLINE GLboolean
 327 check_clear_depth_stencil_with_quad(GLcontext *ctx, struct gl_renderbuffer *rb)
 328 {
 329    const GLuint stencilMax = 0xff;
 330    GLboolean maskStencil
 331       = (ctx->Stencil.WriteMask[0] & stencilMax) != stencilMax;
 332
 333    assert(rb->Format == MESA_FORMAT_S8 ||
 334           rb->Format == MESA_FORMAT_Z24_S8 ||
 335           rb->Format == MESA_FORMAT_S8_Z24);
 336
 337    if (ctx->Scissor.Enabled &&
 338        (ctx->Scissor.X != 0 ||
 339         ctx->Scissor.Y != 0 ||
 340         ctx->Scissor.Width < rb->Width ||
 341         ctx->Scissor.Height < rb->Height))
 342       return TRUE;
 343
 344    if (maskStencil)
 345       return TRUE;
 346
 347    return FALSE;
 348 }
 349
 350
 351 /**
 352  * Determine if we need to clear the depth buffer by drawing a quad.
 353  */
 354 static INLINE GLboolean
 355 check_clear_depth_with_quad(GLcontext *ctx, struct gl_renderbuffer *rb)
 356 {
 357    const struct st_renderbuffer *strb = st_renderbuffer(rb);
 358    const GLboolean isDS = util_format_is_depth_and_stencil(strb->surface->format);
 359
 360    if (ctx->Scissor.Enabled &&
 361        (ctx->Scissor.X != 0 ||
 362         ctx->Scissor.Y != 0 ||
 363         ctx->Scissor.Width < rb->Width ||
 364         ctx->Scissor.Height < rb->Height))
 365       return TRUE;
 366
 367    if (isDS &&
 368        ctx->DrawBuffer->Visual.stencilBits > 0)
 369       return TRUE;
 370
 371    return FALSE;
 372 }
 373
 374
 375 /**
 376  * Determine if we need to clear the stencil buffer by drawing a quad.
 377  */
 378 static INLINE GLboolean
 379 check_clear_stencil_with_quad(GLcontext *ctx, struct gl_renderbuffer *rb)
 380 {
 381    const struct st_renderbuffer *strb = st_renderbuffer(rb);
 382    const GLboolean isDS = util_format_is_depth_and_stencil(strb->surface->format);
 383    const GLuint stencilMax = 0xff;
 384    const GLboolean maskStencil
 385       = (ctx->Stencil.WriteMask[0] & stencilMax) != stencilMax;
 386
 387    assert(rb->Format == MESA_FORMAT_S8 ||
 388           rb->Format == MESA_FORMAT_Z24_S8 ||
 389           rb->Format == MESA_FORMAT_S8_Z24);
 390
 391    if (maskStencil)
 392       return TRUE;
 393
 394    if (ctx->Scissor.Enabled &&
 395        (ctx->Scissor.X != 0 ||
 396         ctx->Scissor.Y != 0 ||
 397         ctx->Scissor.Width < rb->Width ||
 398         ctx->Scissor.Height < rb->Height))
 399       return TRUE;
 400
 401    /* This is correct, but it is necessary to look at the depth clear
 402     * value held in the surface when it comes time to issue the clear,
 403     * rather than taking depth and stencil clear values from the
 404     * current state.
 405     */
 406    if (isDS &&
 407        ctx->DrawBuffer->Visual.depthBits > 0)
 408       return TRUE;
 409
 410    return FALSE;
 411 }
 412
 413
 414
 415 void st_flush_clear( struct st_context *st )
 416 {
 417    /* Release vertex buffer to avoid synchronous rendering if we were
 418     * to map it in the next frame.
 419     */
 420    pipe_buffer_reference(&st->clear.vbuf, NULL);
 421    st->clear.vbuf_slot = 0;
 422 }
 423
 424
 425
 426 /**
 427  * Called via ctx->Driver.Clear()
 428  * XXX: doesn't pick up the differences between front/back/left/right
 429  * clears.  Need to sort that out...
 430  */
 431 static void st_clear(GLcontext *ctx, GLbitfield mask)
 432 {
 433    static const GLbitfield BUFFER_BITS_DS
 434       = (BUFFER_BIT_DEPTH | BUFFER_BIT_STENCIL);
 435    struct st_context *st = ctx->st;
 436    struct gl_renderbuffer *depthRb
 437       = ctx->DrawBuffer->Attachment[BUFFER_DEPTH].Renderbuffer;
 438    struct gl_renderbuffer *stencilRb
 439       = ctx->DrawBuffer->Attachment[BUFFER_STENCIL].Renderbuffer;
 440    GLbitfield quad_buffers = 0;
 441    GLbitfield clear_buffers = 0;
 442    GLuint i;
 443
 444    /* This makes sure the pipe has the latest scissor, etc values */
 445    st_validate_state( st );
 446
 447    if (mask & BUFFER_BITS_COLOR) {
 448       for (i = 0; i < ctx->DrawBuffer->_NumColorDrawBuffers; i++) {
 449          GLuint b = ctx->DrawBuffer->_ColorDrawBufferIndexes[i];
 450
 451          if (mask & (1 << b)) {
 452             struct gl_renderbuffer *rb
 453                = ctx->DrawBuffer->Attachment[b].Renderbuffer;
 454             struct st_renderbuffer *strb;
 455
 456             assert(rb);
 457
 458             strb = st_renderbuffer(rb);
 459
 460             if (!strb->surface)
 461                continue;
 462
 463             if (check_clear_color_with_quad( ctx, rb ))
 464                quad_buffers |= PIPE_CLEAR_COLOR;
 465             else
 466                clear_buffers |= PIPE_CLEAR_COLOR;
 467          }
 468       }
 469    }
 470
 471    if ((mask & BUFFER_BITS_DS) == BUFFER_BITS_DS && depthRb == stencilRb) {
 472       /* clearing combined depth + stencil */
 473       struct st_renderbuffer *strb = st_renderbuffer(depthRb);
 474
 475       if (strb->surface) {
 476          if (check_clear_depth_stencil_with_quad(ctx, depthRb))
 477             quad_buffers |= PIPE_CLEAR_DEPTHSTENCIL;
 478          else
 479             clear_buffers |= PIPE_CLEAR_DEPTHSTENCIL;
 480       }
 481    }
 482    else {
 483       /* separate depth/stencil clears */
 484       if (mask & BUFFER_BIT_DEPTH) {
 485          struct st_renderbuffer *strb = st_renderbuffer(depthRb);
 486
 487          if (strb->surface) {
 488             if (check_clear_depth_with_quad(ctx, depthRb))
 489                quad_buffers |= PIPE_CLEAR_DEPTHSTENCIL;
 490             else
 491                clear_buffers |= PIPE_CLEAR_DEPTHSTENCIL;
 492          }
 493       }
 494       if (mask & BUFFER_BIT_STENCIL) {
 495          struct st_renderbuffer *strb = st_renderbuffer(stencilRb);
 496
 497          if (strb->surface) {
 498             if (check_clear_stencil_with_quad(ctx, stencilRb))
 499                quad_buffers |= PIPE_CLEAR_DEPTHSTENCIL;
 500             else
 501                clear_buffers |= PIPE_CLEAR_DEPTHSTENCIL;
 502          }
 503       }
 504    }
 505
 506    /*
 507     * If we're going to use clear_with_quad() for any reason, use it for
 508     * everything possible.
 509     */
 510    if (quad_buffers) {
 511       quad_buffers |= clear_buffers;
 512       clear_with_quad(ctx,
 513                       quad_buffers & PIPE_CLEAR_COLOR,
 514                       mask & BUFFER_BIT_DEPTH,
 515                       mask & BUFFER_BIT_STENCIL);
 516    } else if (clear_buffers)
 517       ctx->st->pipe->clear(ctx->st->pipe, clear_buffers, ctx->Color.ClearColor,
 518                            ctx->Depth.Clear, ctx->Stencil.Clear);
 519
 520    if (mask & BUFFER_BIT_ACCUM)
 521       st_clear_accum_buffer(ctx,
 522                             ctx->DrawBuffer->Attachment[BUFFER_ACCUM].Renderbuffer);
 523 }
 524
 525
 526 void st_init_clear_functions(struct dd_function_table *functions)
 527 {
 528    functions->Clear = st_clear;
 529 }