Adding option in SkPicture to record device-space bounds of draw commands.

src/core/SkPictureRecord.h

 
 /*
  * Copyright 2011 Google Inc.
  *
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */
 #ifndef SkPictureRecord_DEFINED
 #define SkPictureRecord_DEFINED
 
 #include "SkCanvas.h"
 #include "SkFlattenable.h"
 #include "SkPathHeap.h"
 #include "SkPicture.h"
 #include "SkPictureFlat.h"
 #include "SkTemplates.h"
 #include "SkWriter32.h"
 
+#ifndef SK_RECORD_BOUNDS_IN_PICTURE
+#define SK_RECORD_BOUNDS_IN_PICTURE 0
+#endif
+
 class SkPictureStateTree;
 class SkBBoxHierarchy;
 
 // These macros help with packing and unpacking a single byte value and
 // a 3 byte value into/out of a uint32_t
 #define MASK_24 0x00FFFFFF
 #define UNPACK_8_24(combined, small, large)             \
     small = (combined >> 24) & 0xFF;                    \
     large = combined & MASK_24;
 #define PACK_8_24(small, large) ((small << 24) | large)
@@ skipping 48 matching lines @@
                                 const SkPaint&) SK_OVERRIDE;
     virtual void drawPicture(SkPicture& picture) SK_OVERRIDE;
     virtual void drawVertices(VertexMode, int vertexCount,
                           const SkPoint vertices[], const SkPoint texs[],
                           const SkColor colors[], SkXfermode*,
                           const uint16_t indices[], int indexCount,
                               const SkPaint&) SK_OVERRIDE;
     virtual void drawData(const void*, size_t) SK_OVERRIDE;
     virtual bool isDrawingToLayer() const SK_OVERRIDE;
 
+#if !(SK_RECORD_BOUNDS_IN_PICTURE)
     void addFontMetricsTopBottom(const SkPaint& paint, const SkFlatData&,
                                  SkScalar minY, SkScalar maxY);
+#endif
 
     const SkTDArray<SkPicture* >& getPictureRefs() const {
         return fPictureRefs;
     }
 
     void setFlags(uint32_t recordFlags) {
         fRecordFlags = recordFlags;
     }
 
     const SkWriter32& writeStream() const {
         return fWriter;
     }
 
     void beginRecording();
     void endRecording();
 
+    static bool canRecordBounds(DrawType op);
 private:
     bool updateClipConservativelyUsingBounds(const SkRect&, SkRegion::Op,
                                              bool doAA, bool inverseFilled);
     void handleOptimization(int opt);
     void recordRestoreOffsetPlaceholder(SkRegion::Op);
     void fillRestoreOffsetPlaceholdersForCurrentStackLevel(
         uint32_t restoreOffset);
 
     SkTDArray<int32_t> fRestoreOffsetStack;
     int fFirstSavedLayerIndex;
     enum {
-        kNoSavedLayerIndex = -1
+        kNoSavedLayerIndex = -1,
     };
+    static const uint32_t kInvalidOffset = ~0;
 
     /*
-     * Write the 'drawType' operation and chunk size to the skp. 'size'
-     * can potentially be increased if the chunk size needs its own storage
-     * location (i.e., it overflows 24 bits).
+     * Write the 'drawType' operation, chunk size and optionally the draw
+     * bounds to the skp. 'size' can potentially be increased if the chunk
+     * size needs its own storage location (i.e., it overflows 24 bits).
+     * Bounds are recorded in device space, if canRecordBounds(drawType)
+     * returns true;

[Tom Hudson, 2013/05/14 17:00:49]

Nit: trailing semicolon - did you mean to do more here?
Nit: this ordering of clauses to me reads as though bounds are recorded in
something *other than* device space if !canRecordBounds(drawType).

      * Returns the start offset of the chunk. This is the location at which
      * the opcode & size are stored.
      * TODO: since we are handing the size into here we could call reserve
      * and then return a pointer to the memory storage. This could decrease
      * allocation overhead but could lead to more wasted space (the tail
      * end of blocks could go unused). Possibly add a second addDraw that
      * operates in this manner.
      */
-    uint32_t addDraw(DrawType drawType, uint32_t* size) {
-        uint32_t offset = fWriter.size();
-
-        this->predrawNotify();
-
-    #ifdef SK_DEBUG_TRACE
-        SkDebugf("add %s\n", DrawTypeToString(drawType));
-    #endif
-
-        SkASSERT(0 != *size);
-        SkASSERT(((uint8_t) drawType) == drawType);
-
-        if (0 != (*size & ~MASK_24) || *size == MASK_24) {
-            fWriter.writeInt(PACK_8_24(drawType, MASK_24));
-            *size += 1;
-            fWriter.writeInt(*size);
-        } else {
-            fWriter.writeInt(PACK_8_24(drawType, *size));
-        }
-
-        return offset;
-    }
+    uint32_t addDraw(DrawType drawType, uint32_t* size, const SkPaint* paint = NULL,
+                     const SkRect* localBounds = NULL);
 
     void addInt(int value) {
         fWriter.writeInt(value);
     }
     void addScalar(SkScalar scalar) {
         fWriter.writeScalar(scalar);
     }
 
     void addBitmap(const SkBitmap& bitmap);
     void addMatrix(const SkMatrix& matrix);
@@ skipping 52 matching lines @@
 
 protected:
 
     // These are set to NULL in our constructor, but may be changed by
     // subclasses, in which case they will be SkSafeUnref'd in our destructor.
     SkBBoxHierarchy* fBoundingHierarchy;
     SkPictureStateTree* fStateTree;
 
     // Allocated in the constructor and managed by this class.
     SkBitmapHeap* fBitmapHeap;
-
+#if SK_RECORD_BOUNDS_IN_PICTURE
+    SkIRect fLastDrawBounds;
+#endif
 private:
     SkChunkFlatController fFlattenableHeap;
 
     SkMatrixDictionary fMatrices;
     SkPaintDictionary fPaints;
     SkRegionDictionary fRegions;
 
     SkPathHeap* fPathHeap;  // reference counted
     SkWriter32 fWriter;
 
     // we ref each item in these arrays
     SkTDArray<SkPicture*> fPictureRefs;
 
     uint32_t fRecordFlags;
     int fInitialSaveCount;
 
     friend class SkPicturePlayback;
     friend class SkPictureTester; // for unit testing
 
     typedef SkCanvas INHERITED;
 };
 
 #endif