| /* |
| * Copyright 2012 Google Inc. |
| * |
| * Use of this source code is governed by a BSD-style license that can be |
| * found in the LICENSE file. |
| */ |
| |
| #include "SkCanvasPriv.h" |
| #include "SkDebugCanvas.h" |
| #include "SkDrawCommand.h" |
| #include "SkPaintFilterCanvas.h" |
| #include "SkPicture.h" |
| #include "SkRectPriv.h" |
| #include "SkTextBlob.h" |
| #include "SkClipOpPriv.h" |
| |
| #if SK_SUPPORT_GPU |
| #include "GrAuditTrail.h" |
| #include "GrContext.h" |
| #include "GrRenderTargetContext.h" |
| #endif |
| |
| #define SKDEBUGCANVAS_VERSION 1 |
| #define SKDEBUGCANVAS_ATTRIBUTE_VERSION "version" |
| #define SKDEBUGCANVAS_ATTRIBUTE_COMMANDS "commands" |
| #define SKDEBUGCANVAS_ATTRIBUTE_AUDITTRAIL "auditTrail" |
| |
| class DebugPaintFilterCanvas : public SkPaintFilterCanvas { |
| public: |
| DebugPaintFilterCanvas(SkCanvas* canvas, |
| bool overdrawViz) |
| : INHERITED(canvas) |
| , fOverdrawViz(overdrawViz) {} |
| |
| protected: |
| bool onFilter(SkTCopyOnFirstWrite<SkPaint>* paint, Type) const override { |
| if (*paint) { |
| if (fOverdrawViz) { |
| paint->writable()->setColor(SK_ColorRED); |
| paint->writable()->setAlpha(0x08); |
| paint->writable()->setBlendMode(SkBlendMode::kSrcOver); |
| } |
| } |
| return true; |
| } |
| |
| void onDrawPicture(const SkPicture* picture, |
| const SkMatrix* matrix, |
| const SkPaint* paint) override { |
| // We need to replay the picture onto this canvas in order to filter its internal paints. |
| this->SkCanvas::onDrawPicture(picture, matrix, paint); |
| } |
| |
| private: |
| bool fOverdrawViz; |
| |
| typedef SkPaintFilterCanvas INHERITED; |
| }; |
| |
| SkDebugCanvas::SkDebugCanvas(int width, int height) |
| : INHERITED(width, height) |
| , fOverdrawViz(false) |
| , fClipVizColor(SK_ColorTRANSPARENT) |
| , fDrawGpuOpBounds(false) { |
| // SkPicturePlayback uses the base-class' quickReject calls to cull clipped |
| // operations. This can lead to problems in the debugger which expects all |
| // the operations in the captured skp to appear in the debug canvas. To |
| // circumvent this we create a wide open clip here (an empty clip rect |
| // is not sufficient). |
| // Internally, the SkRect passed to clipRect is converted to an SkIRect and |
| // rounded out. The following code creates a nearly maximal rect that will |
| // not get collapsed by the coming conversions (Due to precision loss the |
| // inset has to be surprisingly large). |
| SkIRect largeIRect = SkRectPriv::MakeILarge(); |
| largeIRect.inset(1024, 1024); |
| SkRect large = SkRect::Make(largeIRect); |
| #ifdef SK_DEBUG |
| SkASSERT(!large.roundOut().isEmpty()); |
| #endif |
| // call the base class' version to avoid adding a draw command |
| this->INHERITED::onClipRect(large, kReplace_SkClipOp, kHard_ClipEdgeStyle); |
| } |
| |
| SkDebugCanvas::~SkDebugCanvas() { |
| fCommandVector.deleteAll(); |
| } |
| |
| void SkDebugCanvas::addDrawCommand(SkDrawCommand* command) { |
| fCommandVector.push(command); |
| } |
| |
| void SkDebugCanvas::draw(SkCanvas* canvas) { |
| if (!fCommandVector.isEmpty()) { |
| this->drawTo(canvas, fCommandVector.count() - 1); |
| } |
| } |
| |
| void SkDebugCanvas::drawTo(SkCanvas* originalCanvas, int index, int m) { |
| SkASSERT(!fCommandVector.isEmpty()); |
| SkASSERT(index < fCommandVector.count()); |
| |
| int saveCount = originalCanvas->save(); |
| |
| SkRect windowRect = SkRect::MakeWH(SkIntToScalar(originalCanvas->getBaseLayerSize().width()), |
| SkIntToScalar(originalCanvas->getBaseLayerSize().height())); |
| |
| originalCanvas->clear(SK_ColorWHITE); |
| originalCanvas->resetMatrix(); |
| if (!windowRect.isEmpty()) { |
| originalCanvas->clipRect(windowRect, kReplace_SkClipOp); |
| } |
| |
| DebugPaintFilterCanvas filterCanvas(originalCanvas, fOverdrawViz); |
| |
| #if SK_SUPPORT_GPU |
| // If we have a GPU backend we can also visualize the op information |
| GrAuditTrail* at = nullptr; |
| if (fDrawGpuOpBounds || m != -1) { |
| // The audit trail must be obtained from the original canvas. |
| at = this->getAuditTrail(originalCanvas); |
| } |
| #endif |
| |
| for (int i = 0; i <= index; i++) { |
| #if SK_SUPPORT_GPU |
| // We need to flush any pending operations, or they might combine with commands below. |
| // Previous operations were not registered with the audit trail when they were |
| // created, so if we allow them to combine, the audit trail will fail to find them. |
| filterCanvas.flush(); |
| |
| GrAuditTrail::AutoCollectOps* acb = nullptr; |
| if (at) { |
| acb = new GrAuditTrail::AutoCollectOps(at, i); |
| } |
| #endif |
| |
| if (fCommandVector[i]->isVisible()) { |
| fCommandVector[i]->execute(&filterCanvas); |
| } |
| #if SK_SUPPORT_GPU |
| if (at && acb) { |
| delete acb; |
| } |
| #endif |
| } |
| |
| if (SkColorGetA(fClipVizColor) != 0) { |
| filterCanvas.save(); |
| #define LARGE_COORD 1000000000 |
| filterCanvas.clipRect( |
| SkRect::MakeLTRB(-LARGE_COORD, -LARGE_COORD, LARGE_COORD, LARGE_COORD), |
| kReverseDifference_SkClipOp); |
| SkPaint clipPaint; |
| clipPaint.setColor(fClipVizColor); |
| filterCanvas.drawPaint(clipPaint); |
| filterCanvas.restore(); |
| } |
| |
| fMatrix = filterCanvas.getTotalMatrix(); |
| fClip = filterCanvas.getDeviceClipBounds(); |
| filterCanvas.restoreToCount(saveCount); |
| |
| #if SK_SUPPORT_GPU |
| // draw any ops if required and issue a full reset onto GrAuditTrail |
| if (at) { |
| // just in case there is global reordering, we flush the canvas before querying |
| // GrAuditTrail |
| GrAuditTrail::AutoEnable ae(at); |
| filterCanvas.flush(); |
| |
| // we pick three colorblind-safe colors, 75% alpha |
| static const SkColor kTotalBounds = SkColorSetARGB(0xC0, 0x6A, 0x3D, 0x9A); |
| static const SkColor kCommandOpBounds = SkColorSetARGB(0xC0, 0xE3, 0x1A, 0x1C); |
| static const SkColor kOtherOpBounds = SkColorSetARGB(0xC0, 0xFF, 0x7F, 0x00); |
| |
| // get the render target of the top device (from the original canvas) so we can ignore ops |
| // drawn offscreen |
| GrRenderTargetContext* rtc = |
| originalCanvas->internal_private_accessTopLayerRenderTargetContext(); |
| GrSurfaceProxy::UniqueID proxyID = rtc->asSurfaceProxy()->uniqueID(); |
| |
| // get the bounding boxes to draw |
| SkTArray<GrAuditTrail::OpInfo> childrenBounds; |
| if (m == -1) { |
| at->getBoundsByClientID(&childrenBounds, index); |
| } else { |
| // the client wants us to draw the mth op |
| at->getBoundsByOpListID(&childrenBounds.push_back(), m); |
| } |
| SkPaint paint; |
| paint.setStyle(SkPaint::kStroke_Style); |
| paint.setStrokeWidth(1); |
| for (int i = 0; i < childrenBounds.count(); i++) { |
| if (childrenBounds[i].fProxyUniqueID != proxyID) { |
| // offscreen draw, ignore for now |
| continue; |
| } |
| paint.setColor(kTotalBounds); |
| filterCanvas.drawRect(childrenBounds[i].fBounds, paint); |
| for (int j = 0; j < childrenBounds[i].fOps.count(); j++) { |
| const GrAuditTrail::OpInfo::Op& op = childrenBounds[i].fOps[j]; |
| if (op.fClientID != index) { |
| paint.setColor(kOtherOpBounds); |
| } else { |
| paint.setColor(kCommandOpBounds); |
| } |
| filterCanvas.drawRect(op.fBounds, paint); |
| } |
| } |
| } |
| #endif |
| this->cleanupAuditTrail(originalCanvas); |
| } |
| |
| void SkDebugCanvas::deleteDrawCommandAt(int index) { |
| SkASSERT(index < fCommandVector.count()); |
| delete fCommandVector[index]; |
| fCommandVector.remove(index); |
| } |
| |
| SkDrawCommand* SkDebugCanvas::getDrawCommandAt(int index) { |
| SkASSERT(index < fCommandVector.count()); |
| return fCommandVector[index]; |
| } |
| |
| GrAuditTrail* SkDebugCanvas::getAuditTrail(SkCanvas* canvas) { |
| GrAuditTrail* at = nullptr; |
| #if SK_SUPPORT_GPU |
| GrContext* ctx = canvas->getGrContext(); |
| if (ctx) { |
| at = ctx->contextPriv().getAuditTrail(); |
| } |
| #endif |
| return at; |
| } |
| |
| void SkDebugCanvas::drawAndCollectOps(int n, SkCanvas* canvas) { |
| #if SK_SUPPORT_GPU |
| GrAuditTrail* at = this->getAuditTrail(canvas); |
| if (at) { |
| // loop over all of the commands and draw them, this is to collect reordering |
| // information |
| for (int i = 0; i < this->getSize() && i <= n; i++) { |
| GrAuditTrail::AutoCollectOps enable(at, i); |
| fCommandVector[i]->execute(canvas); |
| } |
| |
| // in case there is some kind of global reordering |
| { |
| GrAuditTrail::AutoEnable ae(at); |
| canvas->flush(); |
| } |
| } |
| #endif |
| } |
| |
| void SkDebugCanvas::cleanupAuditTrail(SkCanvas* canvas) { |
| GrAuditTrail* at = this->getAuditTrail(canvas); |
| if (at) { |
| #if SK_SUPPORT_GPU |
| GrAuditTrail::AutoEnable ae(at); |
| at->fullReset(); |
| #endif |
| } |
| } |
| |
| Json::Value SkDebugCanvas::toJSON(UrlDataManager& urlDataManager, int n, SkCanvas* canvas) { |
| this->drawAndCollectOps(n, canvas); |
| |
| // now collect json |
| #if SK_SUPPORT_GPU |
| GrAuditTrail* at = this->getAuditTrail(canvas); |
| #endif |
| Json::Value result = Json::Value(Json::objectValue); |
| result[SKDEBUGCANVAS_ATTRIBUTE_VERSION] = Json::Value(SKDEBUGCANVAS_VERSION); |
| Json::Value commands = Json::Value(Json::arrayValue); |
| for (int i = 0; i < this->getSize() && i <= n; i++) { |
| commands[i] = this->getDrawCommandAt(i)->toJSON(urlDataManager); |
| #if SK_SUPPORT_GPU |
| if (at) { |
| // TODO if this is inefficient we could add a method to GrAuditTrail which takes |
| // a Json::Value and is only compiled in this file |
| Json::Value parsedFromString; |
| Json::Reader reader; |
| SkAssertResult(reader.parse(at->toJson(i).c_str(), parsedFromString)); |
| |
| commands[i][SKDEBUGCANVAS_ATTRIBUTE_AUDITTRAIL] = parsedFromString; |
| } |
| #endif |
| } |
| this->cleanupAuditTrail(canvas); |
| result[SKDEBUGCANVAS_ATTRIBUTE_COMMANDS] = commands; |
| return result; |
| } |
| |
| Json::Value SkDebugCanvas::toJSONOpList(int n, SkCanvas* canvas) { |
| this->drawAndCollectOps(n, canvas); |
| |
| Json::Value parsedFromString; |
| #if SK_SUPPORT_GPU |
| GrAuditTrail* at = this->getAuditTrail(canvas); |
| if (at) { |
| GrAuditTrail::AutoManageOpList enable(at); |
| Json::Reader reader; |
| SkAssertResult(reader.parse(at->toJson().c_str(), parsedFromString)); |
| } |
| #endif |
| this->cleanupAuditTrail(canvas); |
| return parsedFromString; |
| } |
| |
| void SkDebugCanvas::setOverdrawViz(bool overdrawViz) { |
| fOverdrawViz = overdrawViz; |
| } |
| |
| void SkDebugCanvas::onClipPath(const SkPath& path, SkClipOp op, ClipEdgeStyle edgeStyle) { |
| this->addDrawCommand(new SkClipPathCommand(path, op, kSoft_ClipEdgeStyle == edgeStyle)); |
| } |
| |
| void SkDebugCanvas::onClipRect(const SkRect& rect, SkClipOp op, ClipEdgeStyle edgeStyle) { |
| this->addDrawCommand(new SkClipRectCommand(rect, op, kSoft_ClipEdgeStyle == edgeStyle)); |
| } |
| |
| void SkDebugCanvas::onClipRRect(const SkRRect& rrect, SkClipOp op, ClipEdgeStyle edgeStyle) { |
| this->addDrawCommand(new SkClipRRectCommand(rrect, op, kSoft_ClipEdgeStyle == edgeStyle)); |
| } |
| |
| void SkDebugCanvas::onClipRegion(const SkRegion& region, SkClipOp op) { |
| this->addDrawCommand(new SkClipRegionCommand(region, op)); |
| } |
| |
| void SkDebugCanvas::didConcat(const SkMatrix& matrix) { |
| this->addDrawCommand(new SkConcatCommand(matrix)); |
| this->INHERITED::didConcat(matrix); |
| } |
| |
| void SkDebugCanvas::onDrawAnnotation(const SkRect& rect, const char key[], SkData* value) { |
| this->addDrawCommand(new SkDrawAnnotationCommand(rect, key, sk_ref_sp(value))); |
| } |
| |
| void SkDebugCanvas::onDrawBitmap(const SkBitmap& bitmap, SkScalar left, |
| SkScalar top, const SkPaint* paint) { |
| this->addDrawCommand(new SkDrawBitmapCommand(bitmap, left, top, paint)); |
| } |
| |
| void SkDebugCanvas::onDrawBitmapRect(const SkBitmap& bitmap, const SkRect* src, const SkRect& dst, |
| const SkPaint* paint, SrcRectConstraint constraint) { |
| this->addDrawCommand(new SkDrawBitmapRectCommand(bitmap, src, dst, paint, |
| (SrcRectConstraint)constraint)); |
| } |
| |
| void SkDebugCanvas::onDrawBitmapNine(const SkBitmap& bitmap, const SkIRect& center, |
| const SkRect& dst, const SkPaint* paint) { |
| this->addDrawCommand(new SkDrawBitmapNineCommand(bitmap, center, dst, paint)); |
| } |
| |
| void SkDebugCanvas::onDrawImage(const SkImage* image, SkScalar left, SkScalar top, |
| const SkPaint* paint) { |
| this->addDrawCommand(new SkDrawImageCommand(image, left, top, paint)); |
| } |
| |
| void SkDebugCanvas::onDrawImageLattice(const SkImage* image, const Lattice& lattice, |
| const SkRect& dst, const SkPaint* paint) { |
| this->addDrawCommand(new SkDrawImageLatticeCommand(image, lattice, dst, paint)); |
| } |
| |
| void SkDebugCanvas::onDrawImageRect(const SkImage* image, const SkRect* src, const SkRect& dst, |
| const SkPaint* paint, SrcRectConstraint constraint) { |
| this->addDrawCommand(new SkDrawImageRectCommand(image, src, dst, paint, constraint)); |
| } |
| |
| void SkDebugCanvas::onDrawImageNine(const SkImage* image, const SkIRect& center, |
| const SkRect& dst, const SkPaint* paint) { |
| this->addDrawCommand(new SkDrawImageNineCommand(image, center, dst, paint)); |
| } |
| |
| void SkDebugCanvas::onDrawOval(const SkRect& oval, const SkPaint& paint) { |
| this->addDrawCommand(new SkDrawOvalCommand(oval, paint)); |
| } |
| |
| void SkDebugCanvas::onDrawArc(const SkRect& oval, SkScalar startAngle, SkScalar sweepAngle, |
| bool useCenter, const SkPaint& paint) { |
| this->addDrawCommand(new SkDrawArcCommand(oval, startAngle, sweepAngle, useCenter, paint)); |
| } |
| |
| void SkDebugCanvas::onDrawPaint(const SkPaint& paint) { |
| this->addDrawCommand(new SkDrawPaintCommand(paint)); |
| } |
| |
| void SkDebugCanvas::onDrawPath(const SkPath& path, const SkPaint& paint) { |
| this->addDrawCommand(new SkDrawPathCommand(path, paint)); |
| } |
| |
| void SkDebugCanvas::onDrawRegion(const SkRegion& region, const SkPaint& paint) { |
| this->addDrawCommand(new SkDrawRegionCommand(region, paint)); |
| } |
| |
| void SkDebugCanvas::onDrawPicture(const SkPicture* picture, |
| const SkMatrix* matrix, |
| const SkPaint* paint) { |
| this->addDrawCommand(new SkBeginDrawPictureCommand(picture, matrix, paint)); |
| SkAutoCanvasMatrixPaint acmp(this, matrix, paint, picture->cullRect()); |
| picture->playback(this); |
| this->addDrawCommand(new SkEndDrawPictureCommand(SkToBool(matrix) || SkToBool(paint))); |
| } |
| |
| void SkDebugCanvas::onDrawPoints(PointMode mode, size_t count, |
| const SkPoint pts[], const SkPaint& paint) { |
| this->addDrawCommand(new SkDrawPointsCommand(mode, count, pts, paint)); |
| } |
| |
| void SkDebugCanvas::onDrawPosText(const void* text, size_t byteLength, const SkPoint pos[], |
| const SkPaint& paint) { |
| this->addDrawCommand(new SkDrawPosTextCommand(text, byteLength, pos, paint)); |
| } |
| |
| void SkDebugCanvas::onDrawPosTextH(const void* text, size_t byteLength, const SkScalar xpos[], |
| SkScalar constY, const SkPaint& paint) { |
| this->addDrawCommand( |
| new SkDrawPosTextHCommand(text, byteLength, xpos, constY, paint)); |
| } |
| |
| void SkDebugCanvas::onDrawRect(const SkRect& rect, const SkPaint& paint) { |
| // NOTE(chudy): Messing up when renamed to DrawRect... Why? |
| addDrawCommand(new SkDrawRectCommand(rect, paint)); |
| } |
| |
| void SkDebugCanvas::onDrawRRect(const SkRRect& rrect, const SkPaint& paint) { |
| this->addDrawCommand(new SkDrawRRectCommand(rrect, paint)); |
| } |
| |
| void SkDebugCanvas::onDrawDRRect(const SkRRect& outer, const SkRRect& inner, |
| const SkPaint& paint) { |
| this->addDrawCommand(new SkDrawDRRectCommand(outer, inner, paint)); |
| } |
| |
| void SkDebugCanvas::onDrawText(const void* text, size_t byteLength, SkScalar x, SkScalar y, |
| const SkPaint& paint) { |
| this->addDrawCommand(new SkDrawTextCommand(text, byteLength, x, y, paint)); |
| } |
| |
| void SkDebugCanvas::onDrawTextOnPath(const void* text, size_t byteLength, const SkPath& path, |
| const SkMatrix* matrix, const SkPaint& paint) { |
| this->addDrawCommand( |
| new SkDrawTextOnPathCommand(text, byteLength, path, matrix, paint)); |
| } |
| |
| void SkDebugCanvas::onDrawTextRSXform(const void* text, size_t byteLength, const SkRSXform xform[], |
| const SkRect* cull, const SkPaint& paint) { |
| this->addDrawCommand(new SkDrawTextRSXformCommand(text, byteLength, xform, cull, paint)); |
| } |
| |
| void SkDebugCanvas::onDrawTextBlob(const SkTextBlob* blob, SkScalar x, SkScalar y, |
| const SkPaint& paint) { |
| this->addDrawCommand(new SkDrawTextBlobCommand(sk_ref_sp(const_cast<SkTextBlob*>(blob)), |
| x, y, paint)); |
| } |
| |
| void SkDebugCanvas::onDrawPatch(const SkPoint cubics[12], const SkColor colors[4], |
| const SkPoint texCoords[4], SkBlendMode bmode, |
| const SkPaint& paint) { |
| this->addDrawCommand(new SkDrawPatchCommand(cubics, colors, texCoords, bmode, paint)); |
| } |
| |
| void SkDebugCanvas::onDrawVerticesObject(const SkVertices* vertices, SkBlendMode bmode, |
| const SkPaint& paint) { |
| this->addDrawCommand(new SkDrawVerticesCommand(sk_ref_sp(const_cast<SkVertices*>(vertices)), |
| bmode, paint)); |
| } |
| |
| void SkDebugCanvas::willRestore() { |
| this->addDrawCommand(new SkRestoreCommand()); |
| this->INHERITED::willRestore(); |
| } |
| |
| void SkDebugCanvas::willSave() { |
| this->addDrawCommand(new SkSaveCommand()); |
| this->INHERITED::willSave(); |
| } |
| |
| SkCanvas::SaveLayerStrategy SkDebugCanvas::getSaveLayerStrategy(const SaveLayerRec& rec) { |
| this->addDrawCommand(new SkSaveLayerCommand(rec)); |
| (void)this->INHERITED::getSaveLayerStrategy(rec); |
| // No need for a full layer. |
| return kNoLayer_SaveLayerStrategy; |
| } |
| |
| void SkDebugCanvas::didSetMatrix(const SkMatrix& matrix) { |
| this->addDrawCommand(new SkSetMatrixCommand(matrix)); |
| this->INHERITED::didSetMatrix(matrix); |
| } |
| |
| void SkDebugCanvas::toggleCommand(int index, bool toggle) { |
| SkASSERT(index < fCommandVector.count()); |
| fCommandVector[index]->setVisible(toggle); |
| } |