Define clear regions in terms of GrFixedClip

src/gpu/batches/GrClearBatch.h

 /*
  * Copyright 2015 Google Inc.
  *
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */
 
 #ifndef GrClearBatch_DEFINED
 #define GrClearBatch_DEFINED
 
 #include "GrBatch.h"
 #include "GrBatchFlushState.h"
+#include "GrFixedClip.h"
 #include "GrGpu.h"
 #include "GrGpuCommandBuffer.h"
 #include "GrRenderTarget.h"
 
 class GrClearBatch final : public GrBatch {
 public:
     DEFINE_BATCH_CLASS_ID
 
-    static sk_sp<GrClearBatch> Make(const SkIRect& rect,  GrColor color, GrRenderTarget* rt) {
-        return sk_sp<GrClearBatch>(new GrClearBatch(rect, color, rt));
+    static sk_sp<GrClearBatch> Make(const GrFixedClip& clip, GrColor color, GrRenderTarget* rt) {
+        sk_sp<GrClearBatch> batch(new GrClearBatch(clip, color, rt));
+        if (!batch->renderTarget()) {

[bsalomon, 2016/08/23 15:12:49]

Can this happen or will something upstack have caught it?

[csmartdalton, 2016/08/23 15:23:57]

This is the constructor's way of telling us it failed. If that's confusing we
can pass in a "success" bool and/or update the comment.

[bsalomon, 2016/08/23 16:04:49]

I get that, but I'm just wondering whether we would have (or could have) caught
the non-intersection case up in GrDC.

[csmartdalton, 2016/08/23 16:31:23]

Ah, right. Added comments to that file to discuss this.

+            return nullptr; // The clip did not contain any pixels within the render target.
+        }
+        return batch;
     }
 
     const char* name() const override { return "Clear"; }
 
     uint32_t renderTargetUniqueID() const override { return fRenderTarget.get()->getUniqueID(); }
     GrRenderTarget* renderTarget() const override { return fRenderTarget.get(); }
 
     SkString dumpInfo() const override {
-        SkString string;
-        string.printf("Color: 0x%08x, Rect [L: %d, T: %d, R: %d, B: %d], RT: %d",
-                      fColor, fRect.fLeft, fRect.fTop, fRect.fRight, fRect.fBottom,
-                      fRenderTarget.get()->getUniqueID());
+        SkString string("Scissor [");
+        if (fClip.scissorEnabled()) {
+            const SkIRect& r = fClip.scissorRect();
+            string.appendf("L: %d, T: %d, R: %d, B: %d", r.fLeft, r.fTop, r.fRight, r.fBottom);
+        }
+        string.appendf("], Color: 0x%08x, RT: %d", fColor, fRenderTarget.get()->getUniqueID());
         string.append(INHERITED::dumpInfo());
         return string;
     }
 
     void setColor(GrColor color) { fColor = color; }
 
 private:
-    GrClearBatch(const SkIRect& rect,  GrColor color, GrRenderTarget* rt)
+    GrClearBatch(const GrFixedClip& clip, GrColor color, GrRenderTarget* rt)
         : INHERITED(ClassID())
-        , fRect(rect)
-        , fColor(color)
-        , fRenderTarget(rt) {
-        this->setBounds(SkRect::Make(rect), HasAABloat::kNo, IsZeroArea::kNo);
+        , fClip(clip)
+        , fColor(color) {
+        SkIRect rtRect = SkIRect::MakeWH(rt->width(), rt->height());
+        if (fClip.scissorEnabled()) {
+            // Don't let scissors extend outside the RT. This may improve batching.
+            if (!fClip.intersect(rtRect)) {
+                return;

[csmartdalton, 2016/08/23 15:23:57]

Here the constructor aborts before setting fRenderTarget.

+            }
+            if (fClip.scissorRect() == rtRect) {
+                fClip.disableScissor();
+            }
+        }
+        this->setBounds(SkRect::Make(fClip.scissorEnabled() ? fClip.scissorRect() : rtRect),
+                        HasAABloat::kNo, IsZeroArea::kNo);
+        fRenderTarget.reset(rt);
     }
 
     bool onCombineIfPossible(GrBatch* t, const GrCaps& caps) override {
         // This could be much more complicated. Currently we look at cases where the new clear
         // contains the old clear, or when the new clear is a subset of the old clear and is the
         // same color.
         GrClearBatch* cb = t->cast<GrClearBatch>();
         SkASSERT(cb->fRenderTarget == fRenderTarget);
-        if (cb->fRect.contains(fRect)) {
-            fRect = cb->fRect;
+        if (cb->contains(this)) {
+            fClip = cb->fClip;
             this->replaceBounds(*t);
             fColor = cb->fColor;
             return true;
-        } else if (cb->fColor == fColor && fRect.contains(cb->fRect)) {
+        } else if (cb->fColor == fColor && this->contains(cb)) {
             return true;
         }
         return false;
     }
 
+    bool contains(const GrClearBatch* that) const {
+        // The constructor ensures that scissor gets disabled on any clip that fills the entire RT.
+        return !fClip.scissorEnabled() ||
+               (that->fClip.scissorEnabled() &&
+                fClip.scissorRect().contains(that->fClip.scissorRect()));
+    }
+
     void onPrepare(GrBatchFlushState*) override {}
 
     void onDraw(GrBatchFlushState* state) override {
-        state->commandBuffer()->clear(fRect, fColor, fRenderTarget.get());
+        state->commandBuffer()->clear(fClip, fColor, fRenderTarget.get());
     }
 
-    SkIRect                                                 fRect;
+    GrFixedClip                                             fClip;
     GrColor                                                 fColor;
     GrPendingIOResource<GrRenderTarget, kWrite_GrIOType>    fRenderTarget;
 
     typedef GrBatch INHERITED;
 };
 
 #endif