epoger@google.com | ec3ed6a | 2011-07-28 14:26:00 +0000 | [diff] [blame] | 1 | |
| 2 | /* |
| 3 | * Copyright 2011 Google Inc. |
| 4 | * |
| 5 | * Use of this source code is governed by a BSD-style license that can be |
| 6 | * found in the LICENSE file. |
| 7 | */ |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 8 | #ifndef SkDumpCanvas_DEFINED |
| 9 | #define SkDumpCanvas_DEFINED |
| 10 | |
| 11 | #include "SkCanvas.h" |
| 12 | |
robertphillips@google.com | 76f9e93 | 2013-01-15 20:17:47 +0000 | [diff] [blame] | 13 | #ifdef SK_DEVELOPER |
| 14 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 15 | /** This class overrides all the draw methods on SkCanvas, and formats them |
| 16 | as text, and then sends that to a Dumper helper object. |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 17 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 18 | Typical use might be to dump a display list to a log file to see what is |
| 19 | being drawn. |
| 20 | */ |
| 21 | class SkDumpCanvas : public SkCanvas { |
| 22 | public: |
| 23 | class Dumper; |
| 24 | |
| 25 | explicit SkDumpCanvas(Dumper* = 0); |
| 26 | virtual ~SkDumpCanvas(); |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 27 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 28 | enum Verb { |
| 29 | kNULL_Verb, |
| 30 | |
| 31 | kSave_Verb, |
| 32 | kRestore_Verb, |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 33 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 34 | kMatrix_Verb, |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 35 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 36 | kClip_Verb, |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 37 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 38 | kDrawPaint_Verb, |
| 39 | kDrawPoints_Verb, |
reed@google.com | 4ed0fb7 | 2012-12-12 20:48:18 +0000 | [diff] [blame] | 40 | kDrawOval_Verb, |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 41 | kDrawRect_Verb, |
reed@google.com | 4ed0fb7 | 2012-12-12 20:48:18 +0000 | [diff] [blame] | 42 | kDrawRRect_Verb, |
commit-bot@chromium.org | ab58273 | 2014-02-21 12:20:45 +0000 | [diff] [blame] | 43 | kDrawDRRect_Verb, |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 44 | kDrawPath_Verb, |
| 45 | kDrawBitmap_Verb, |
| 46 | kDrawText_Verb, |
| 47 | kDrawPicture_Verb, |
reed@android.com | cb60844 | 2009-12-04 21:32:27 +0000 | [diff] [blame] | 48 | kDrawVertices_Verb, |
dandov | 963137b | 2014-08-07 07:49:53 -0700 | [diff] [blame] | 49 | kDrawPatch_Verb, |
reed | c4fda92 | 2015-01-02 06:39:51 -0800 | [diff] [blame] | 50 | kDrawData_Verb, // obsolete |
robertphillips@google.com | 0a4805e | 2013-05-29 13:24:23 +0000 | [diff] [blame] | 51 | |
commit-bot@chromium.org | 210ae2a | 2014-02-27 17:40:13 +0000 | [diff] [blame] | 52 | kCull_Verb |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 53 | }; |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 54 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 55 | /** Subclasses of this are installed on the DumpCanvas, and then called for |
| 56 | each drawing command. |
| 57 | */ |
| 58 | class Dumper : public SkRefCnt { |
| 59 | public: |
reed@google.com | 563a3b4 | 2012-06-26 19:24:50 +0000 | [diff] [blame] | 60 | SK_DECLARE_INST_COUNT(Dumper) |
| 61 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 62 | virtual void dump(SkDumpCanvas*, SkDumpCanvas::Verb, const char str[], |
| 63 | const SkPaint*) = 0; |
rmistry@google.com | fbfcd56 | 2012-08-23 18:09:54 +0000 | [diff] [blame] | 64 | |
reed@google.com | 563a3b4 | 2012-06-26 19:24:50 +0000 | [diff] [blame] | 65 | private: |
| 66 | typedef SkRefCnt INHERITED; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 67 | }; |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 68 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 69 | Dumper* getDumper() const { return fDumper; } |
| 70 | void setDumper(Dumper*); |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 71 | |
reed@android.com | 9b46e77 | 2009-06-05 12:24:41 +0000 | [diff] [blame] | 72 | int getNestLevel() const { return fNestLevel; } |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 73 | |
commit-bot@chromium.org | ab58273 | 2014-02-21 12:20:45 +0000 | [diff] [blame] | 74 | protected: |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 75 | void willSave() override; |
| 76 | SaveLayerStrategy willSaveLayer(const SkRect*, const SkPaint*, SaveFlags) override; |
| 77 | void willRestore() override; |
commit-bot@chromium.org | e54a23f | 2014-03-12 20:21:48 +0000 | [diff] [blame] | 78 | |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 79 | void didConcat(const SkMatrix&) override; |
| 80 | void didSetMatrix(const SkMatrix&) override; |
commit-bot@chromium.org | 44c48d0 | 2014-03-13 20:03:58 +0000 | [diff] [blame] | 81 | |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 82 | void onDrawDRRect(const SkRRect&, const SkRRect&, const SkPaint&) override; |
reed@google.com | e0d9ce8 | 2014-04-23 04:00:17 +0000 | [diff] [blame] | 83 | virtual void onDrawText(const void* text, size_t byteLength, SkScalar x, SkScalar y, |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 84 | const SkPaint&) override; |
reed@google.com | e0d9ce8 | 2014-04-23 04:00:17 +0000 | [diff] [blame] | 85 | virtual void onDrawPosText(const void* text, size_t byteLength, const SkPoint pos[], |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 86 | const SkPaint&) override; |
reed@google.com | e0d9ce8 | 2014-04-23 04:00:17 +0000 | [diff] [blame] | 87 | virtual void onDrawPosTextH(const void* text, size_t byteLength, const SkScalar xpos[], |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 88 | SkScalar constY, const SkPaint&) override; |
reed@google.com | e0d9ce8 | 2014-04-23 04:00:17 +0000 | [diff] [blame] | 89 | virtual void onDrawTextOnPath(const void* text, size_t byteLength, const SkPath& path, |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 90 | const SkMatrix* matrix, const SkPaint&) override; |
fmalita | b742517 | 2014-08-26 07:56:44 -0700 | [diff] [blame] | 91 | virtual void onDrawTextBlob(const SkTextBlob* blob, SkScalar x, SkScalar y, |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 92 | const SkPaint& paint) override; |
dandov | b3c9d1c | 2014-08-12 08:34:29 -0700 | [diff] [blame] | 93 | virtual void onDrawPatch(const SkPoint cubics[12], const SkColor colors[4], |
| 94 | const SkPoint texCoords[4], SkXfermode* xmode, |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 95 | const SkPaint& paint) override; |
commit-bot@chromium.org | ab58273 | 2014-02-21 12:20:45 +0000 | [diff] [blame] | 96 | |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 97 | void onDrawPaint(const SkPaint&) override; |
| 98 | void onDrawPoints(PointMode, size_t count, const SkPoint pts[], const SkPaint&) override; |
| 99 | void onDrawRect(const SkRect&, const SkPaint&) override; |
| 100 | void onDrawOval(const SkRect&, const SkPaint&) override; |
| 101 | void onDrawRRect(const SkRRect&, const SkPaint&) override; |
| 102 | void onDrawPath(const SkPath&, const SkPaint&) override; |
| 103 | void onDrawBitmap(const SkBitmap&, SkScalar left, SkScalar top, const SkPaint*) override; |
reed | 41af966 | 2015-01-05 07:49:08 -0800 | [diff] [blame] | 104 | void onDrawBitmapRect(const SkBitmap&, const SkRect* src, const SkRect& dst, const SkPaint*, |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 105 | DrawBitmapRectFlags flags) override; |
| 106 | void onDrawImage(const SkImage*, SkScalar left, SkScalar top, const SkPaint*) override; |
reed | 41af966 | 2015-01-05 07:49:08 -0800 | [diff] [blame] | 107 | void onDrawImageRect(const SkImage*, const SkRect* src, const SkRect& dst, |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 108 | const SkPaint*) override; |
reed | 41af966 | 2015-01-05 07:49:08 -0800 | [diff] [blame] | 109 | void onDrawBitmapNine(const SkBitmap&, const SkIRect& center, const SkRect& dst, |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 110 | const SkPaint*) override; |
| 111 | void onDrawSprite(const SkBitmap&, int left, int top, const SkPaint*) override; |
reed | 41af966 | 2015-01-05 07:49:08 -0800 | [diff] [blame] | 112 | void onDrawVertices(VertexMode vmode, int vertexCount, |
| 113 | const SkPoint vertices[], const SkPoint texs[], |
| 114 | const SkColor colors[], SkXfermode* xmode, |
| 115 | const uint16_t indices[], int indexCount, |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 116 | const SkPaint&) override; |
reed | 41af966 | 2015-01-05 07:49:08 -0800 | [diff] [blame] | 117 | |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 118 | void onClipRect(const SkRect&, SkRegion::Op, ClipEdgeStyle) override; |
| 119 | void onClipRRect(const SkRRect&, SkRegion::Op, ClipEdgeStyle) override; |
| 120 | void onClipPath(const SkPath&, SkRegion::Op, ClipEdgeStyle) override; |
| 121 | void onClipRegion(const SkRegion&, SkRegion::Op) override; |
robertphillips@google.com | 8f90a89 | 2014-02-28 18:19:39 +0000 | [diff] [blame] | 122 | |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 123 | void onDrawPicture(const SkPicture*, const SkMatrix*, const SkPaint*) override; |
robertphillips | 9b14f26 | 2014-06-04 05:40:44 -0700 | [diff] [blame] | 124 | |
robertphillips@google.com | 8f90a89 | 2014-02-28 18:19:39 +0000 | [diff] [blame] | 125 | static const char* EdgeStyleToAAString(ClipEdgeStyle edgeStyle); |
| 126 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 127 | private: |
| 128 | Dumper* fDumper; |
reed@android.com | 9b46e77 | 2009-06-05 12:24:41 +0000 | [diff] [blame] | 129 | int fNestLevel; // for nesting recursive elements like pictures |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 130 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 131 | void dump(Verb, const SkPaint*, const char format[], ...); |
| 132 | |
| 133 | typedef SkCanvas INHERITED; |
| 134 | }; |
| 135 | |
| 136 | /** Formats the draw commands, and send them to a function-pointer provided |
| 137 | by the caller. |
| 138 | */ |
| 139 | class SkFormatDumper : public SkDumpCanvas::Dumper { |
| 140 | public: |
| 141 | SkFormatDumper(void (*)(const char text[], void* refcon), void* refcon); |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 142 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 143 | // override from baseclass that does the formatting, and in turn calls |
| 144 | // the function pointer that was passed to the constructor |
| 145 | virtual void dump(SkDumpCanvas*, SkDumpCanvas::Verb, const char str[], |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 146 | const SkPaint*) override; |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 147 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 148 | private: |
| 149 | void (*fProc)(const char*, void*); |
| 150 | void* fRefcon; |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 151 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 152 | typedef SkDumpCanvas::Dumper INHERITED; |
| 153 | }; |
| 154 | |
| 155 | /** Subclass of Dumper that dumps the drawing command to SkDebugf |
| 156 | */ |
| 157 | class SkDebugfDumper : public SkFormatDumper { |
| 158 | public: |
| 159 | SkDebugfDumper(); |
| 160 | |
| 161 | private: |
| 162 | typedef SkFormatDumper INHERITED; |
| 163 | }; |
| 164 | |
| 165 | #endif |
robertphillips@google.com | 76f9e93 | 2013-01-15 20:17:47 +0000 | [diff] [blame] | 166 | |
| 167 | #endif |