Use clipped bounds for reordering decisions

include/gpu/GrClip.h

 /*
  * Copyright 2010 Google Inc.
  *
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */
 
 #ifndef GrClip_DEFINED
 #define GrClip_DEFINED
 
 #include "GrFragmentProcessor.h"
 #include "GrTypesPriv.h"
 #include "SkClipStack.h"
 
 class GrDrawContext;
 class GrPipelineBuilder;
 
 /**
  * Produced by GrClip. It provides a set of modifications to the drawing state that are used to
  * create the final GrPipeline for a GrBatch.
  */
 class GrAppliedClip : public SkNoncopyable {
 public:
-    GrAppliedClip() : fHasStencilClip(false) {}
+    GrAppliedClip() : fHasStencilClip(false), fDeviceBounds(SkRect::MakeLargest()) {}
     GrFragmentProcessor* getClipCoverageFragmentProcessor() const {
         return fClipCoverageFP.get();
     }
     const GrScissorState& scissorState() const { return fScissorState; }
     bool hasStencilClip() const { return fHasStencilClip; }
 
-    void makeStencil(bool hasStencil) {
+    void makeStencil(bool hasStencil, const SkRect& deviceBounds) {
         fClipCoverageFP = nullptr;
         fScissorState.setDisabled();
         fHasStencilClip = hasStencil;
+        fDeviceBounds = deviceBounds;
     }
 
-    void makeScissoredStencil(bool hasStencil, const SkIRect& scissor) {
+    /**
+     * The device bounds of the clip defaults to the scissor rect, but a tighter bounds (based
+     * on the known effect of the stencil values) can be provided.
+     */
+    void makeScissoredStencil(const SkIRect& scissor, const SkRect* deviceBounds = nullptr) {
         fClipCoverageFP = nullptr;
         fScissorState.set(scissor);
-        fHasStencilClip = hasStencil;
+        fHasStencilClip = true;
+        if (deviceBounds) {
+            fDeviceBounds = *deviceBounds;
+            SkASSERT(scissor.contains(*deviceBounds))
+        } else {
+            fDeviceBounds = SkRect::Make(scissor);
+        }
     }
 
-    void makeFPBased(sk_sp<GrFragmentProcessor> fp) {
+    void makeFPBased(sk_sp<GrFragmentProcessor> fp, const SkRect& deviceBounds) {
         fClipCoverageFP = fp;
         fScissorState.setDisabled();
         fHasStencilClip = false;
+        fDeviceBounds = deviceBounds;
     }
 
     void makeScissored(SkIRect& scissor) {
         fClipCoverageFP.reset();
         fScissorState.set(scissor);
         fHasStencilClip = false;
+        fDeviceBounds = SkRect::Make(scissor);
     }
 
-    void makeScissoredFPBased(sk_sp<GrFragmentProcessor> fp, SkIRect& scissor) {
+    /**
+     * The device bounds of the clip defaults to the scissor rect, but a tighter bounds (based
+     * on the known effect of the fragment processor) can be provided.
+     */
+    void makeScissoredFPBased(sk_sp<GrFragmentProcessor> fp, const SkIRect& scissor,
+                              const SkRect* deviceBounds = nullptr) {
         fClipCoverageFP = fp;
         fScissorState.set(scissor);
         fHasStencilClip = false;
+        if (deviceBounds) {
+            fDeviceBounds = *deviceBounds;
+            SkASSERT(scissor.contains(*deviceBounds))
+        } else {
+            fDeviceBounds = SkRect::Make(scissor);
+        }
     }
 
+    /**
+     * Returns the device bounds of the applied clip. Ideally this considers the combined effect of
+     * all clipping techniques in play (scissor, stencil, and/or coverage fp).
+     */

[robertphillips, 2016/07/08 15:46:14]

SkASSERT(!fDeviceBounds.isLargest());

?

[bsalomon, 2016/07/08 17:06:43]

It can be largest if the clip can be ignored. GrCMM will never add a scissor,
fp, or stencil to the GrAppliedClip, leaving it with largest.

+    const SkRect& deviceBounds() const { return fDeviceBounds; }
+
 private:
     sk_sp<GrFragmentProcessor> fClipCoverageFP;
     GrScissorState             fScissorState;
     bool                       fHasStencilClip;
-
+    SkRect                     fDeviceBounds;
     typedef SkNoncopyable INHERITED;
 };
 
 /**
  * GrClip is an abstract base class for applying a clip. It constructs a clip mask if necessary, and
  * fills out a GrAppliedClip instructing the caller on how to set up the draw state.
  */
 class GrClip {
 public:
     virtual bool quickContains(const SkRect&) const = 0;
@@ skipping 17 matching lines @@
                const SkRect*, GrAppliedClip*) const final { return true; }
 };
 
 /**
  * GrFixedClip is a clip that can be represented by fixed-function hardware. It never modifies the
  * stencil buffer itself, but can be configured to use whatever clip is already there.
  */
 class GrFixedClip final : public GrClip {
 public:
     GrFixedClip() : fHasStencilClip(false) {}
-    GrFixedClip(const SkIRect& scissorRect) : fScissorState(scissorRect), fHasStencilClip(false) {}
+    GrFixedClip(const SkIRect& scissorRect)
+        : fScissorState(scissorRect)
+        , fDeviceBounds(SkRect::Make(scissorRect))
+        , fHasStencilClip(false) {}
 
     void reset() {
         fScissorState.setDisabled();
+        fDeviceBounds.setLargest();
         fHasStencilClip = false;
     }
 
     void reset(const SkIRect& scissorRect) {
         fScissorState.set(scissorRect);
+        fDeviceBounds = SkRect::Make(scissorRect);
         fHasStencilClip = false;
     }
 
-    void enableStencilClip(bool enable) { fHasStencilClip = enable; }
+    void enableStencilClip(const SkRect& deviceBounds) {
+        fHasStencilClip = true;
+        fDeviceBounds = deviceBounds;

[robertphillips, 2016/07/08 15:46:14]

We don't need an "if (fScissorState.enabled())" guard around this assert ?

i.e., would we ever reset() and then enableStencilClip ?

[bsalomon, 2016/07/08 17:06:43]

Done.

+        SkASSERT(fScissorState.rect().contains(deviceBounds));
+    }
+
+    void disableStencilClip() {
+        fHasStencilClip = false;
+        if (fScissorState.enabled()) {
+            fDeviceBounds = SkRect::Make(fScissorState.rect());
+        } else {
+            fDeviceBounds.setLargest();
+        }
+    }
 
     const GrScissorState& scissorState() const { return fScissorState; }
     bool hasStencilClip() const { return fHasStencilClip; }
 
     bool quickContains(const SkRect&) const final;
     void getConservativeBounds(int width, int height, SkIRect* devResult,
                                bool* isIntersectionOfRects) const final;
 
 private:
     bool apply(GrContext*, const GrPipelineBuilder&, GrDrawContext*,
                const SkRect* devBounds, GrAppliedClip* out) const final;
 
     GrScissorState   fScissorState;
+    SkRect           fDeviceBounds;
     bool             fHasStencilClip;
 };
 
 /**
  * GrClipStackClip can apply a generic SkClipStack to the draw state. It may generate clip masks or
  * write to the stencil buffer during apply().
  */
 class GrClipStackClip final : public GrClip {
 public:
     GrClipStackClip(const SkClipStack* stack = nullptr, const SkIPoint* origin = nullptr) {
@@ skipping 13 matching lines @@
                                bool* isIntersectionOfRects) const final;
     bool apply(GrContext*, const GrPipelineBuilder&, GrDrawContext*,
                const SkRect* devBounds, GrAppliedClip*) const final;
 
 private:
     SkIPoint                          fOrigin;
     SkAutoTUnref<const SkClipStack>   fStack;
 };
 
 #endif