3 * Copyright 2012 Google Inc.
5 * Use of this source code is governed by a BSD-style license that can be
6 * found in the LICENSE file.
9 #ifndef SKDRAWCOMMAND_H_
10 #define SKDRAWCOMMAND_H_
12 #include "SkPictureFlat.h"
16 class SK_API SkDrawCommand {
18 /* TODO(chudy): Remove subclasses. */
19 SkDrawCommand(DrawType drawType);
22 virtual ~SkDrawCommand();
24 virtual SkString toString();
26 void setOffset(size_t offset) { fOffset = offset; }
27 virtual size_t offset() { return fOffset; }
29 virtual const char* toCString() {
30 return GetCommandString(fDrawType);
33 bool isVisible() const {
37 void setVisible(bool toggle) {
41 SkTDArray<SkString*>* Info() {return &fInfo; };
42 virtual void execute(SkCanvas* canvas) = 0;
43 virtual void vizExecute(SkCanvas* canvas) { };
44 /** Does nothing by default, but used by save() and restore()-type
45 subclasses to track unresolved save() calls. */
46 virtual void trackSaveState(int* state) { };
48 // The next "active" system is only used by save, saveLayer, restore,
49 // pushCull and popCull. It is used in two ways:
50 // To determine which saveLayers are currently active (at a
51 // given point in the rendering).
52 // saves just return a kPushLayer action but don't track active state
53 // restores just return a kPopLayer action
54 // saveLayers return kPushLayer but also track the active state
55 // To determine which culls are currently active (at a given point)
57 // pushCulls return a kPushCull action
58 // popCulls return a kPopCull action
66 virtual Action action() const { return kNone_Action; }
67 virtual void setActive(bool active) {}
68 virtual bool active() const { return false; }
70 DrawType getType() { return fDrawType; };
72 virtual bool render(SkCanvas* canvas) const { return false; }
74 static const char* GetCommandString(DrawType type);
77 SkTDArray<SkString*> fInfo;
85 class SkRestoreCommand : public SkDrawCommand {
88 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
89 virtual void trackSaveState(int* state) SK_OVERRIDE;
90 virtual Action action() const SK_OVERRIDE { return kPopLayer_Action; }
93 typedef SkDrawCommand INHERITED;
96 class SkClearCommand : public SkDrawCommand {
98 SkClearCommand(SkColor color);
99 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
103 typedef SkDrawCommand INHERITED;
106 class SkClipPathCommand : public SkDrawCommand {
108 SkClipPathCommand(const SkPath& path, SkRegion::Op op, bool doAA);
109 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
110 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
116 typedef SkDrawCommand INHERITED;
119 class SkClipRegionCommand : public SkDrawCommand {
121 SkClipRegionCommand(const SkRegion& region, SkRegion::Op op);
122 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
127 typedef SkDrawCommand INHERITED;
130 class SkClipRectCommand : public SkDrawCommand {
132 SkClipRectCommand(const SkRect& rect, SkRegion::Op op, bool doAA);
133 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
135 const SkRect& rect() const { return fRect; }
136 SkRegion::Op op() const { return fOp; }
137 bool doAA() const { return fDoAA; }
144 typedef SkDrawCommand INHERITED;
147 class SkClipRRectCommand : public SkDrawCommand {
149 SkClipRRectCommand(const SkRRect& rrect, SkRegion::Op op, bool doAA);
150 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
151 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
153 const SkRRect& rrect() const { return fRRect; }
154 SkRegion::Op op() const { return fOp; }
155 bool doAA() const { return fDoAA; }
162 typedef SkDrawCommand INHERITED;
165 class SkConcatCommand : public SkDrawCommand {
167 SkConcatCommand(const SkMatrix& matrix);
168 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
172 typedef SkDrawCommand INHERITED;
175 class SkDrawBitmapCommand : public SkDrawCommand {
177 SkDrawBitmapCommand(const SkBitmap& bitmap, SkScalar left, SkScalar top,
178 const SkPaint* paint);
179 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
180 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
188 typedef SkDrawCommand INHERITED;
191 class SkDrawBitmapMatrixCommand : public SkDrawCommand {
193 SkDrawBitmapMatrixCommand(const SkBitmap& bitmap, const SkMatrix& matrix,
194 const SkPaint* paint);
195 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
196 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
203 typedef SkDrawCommand INHERITED;
206 class SkDrawBitmapNineCommand : public SkDrawCommand {
208 SkDrawBitmapNineCommand(const SkBitmap& bitmap, const SkIRect& center,
209 const SkRect& dst, const SkPaint* paint);
210 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
211 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
219 typedef SkDrawCommand INHERITED;
222 class SkDrawBitmapRectCommand : public SkDrawCommand {
224 SkDrawBitmapRectCommand(const SkBitmap& bitmap, const SkRect* src,
225 const SkRect& dst, const SkPaint* paint,
226 SkCanvas::DrawBitmapRectFlags flags);
227 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
228 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
230 const SkBitmap& bitmap() const { return fBitmap; }
232 // The non-const 'paint' method allows modification of this object's
233 // SkPaint. For this reason the ctor and setPaint method make a local copy.
234 // The 'fPaintPtr' member acts a signal that the local SkPaint is valid
235 // (since only an SkPaint* is passed into the ctor).
236 const SkPaint* paint() const { return fPaintPtr; }
237 SkPaint* paint() { return fPaintPtr; }
239 void setPaint(const SkPaint& paint) { fPaint = paint; fPaintPtr = &fPaint; }
241 const SkRect* srcRect() const { return fSrc.isEmpty() ? NULL : &fSrc; }
242 void setSrcRect(const SkRect& src) { fSrc = src; }
244 const SkRect& dstRect() const { return fDst; }
245 void setDstRect(const SkRect& dst) { fDst = dst; }
247 SkCanvas::DrawBitmapRectFlags flags() const { return fFlags; }
248 void setFlags(SkCanvas::DrawBitmapRectFlags flags) { fFlags = flags; }
256 SkCanvas::DrawBitmapRectFlags fFlags;
258 typedef SkDrawCommand INHERITED;
261 class SkDrawDataCommand : public SkDrawCommand {
263 SkDrawDataCommand(const void* data, size_t length);
264 virtual ~SkDrawDataCommand() { delete [] fData; }
265 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
270 typedef SkDrawCommand INHERITED;
273 class SkBeginCommentGroupCommand : public SkDrawCommand {
275 SkBeginCommentGroupCommand(const char* description);
276 virtual void execute(SkCanvas* canvas) SK_OVERRIDE {
277 canvas->beginCommentGroup(fDescription.c_str());
280 SkString fDescription;
282 typedef SkDrawCommand INHERITED;
285 class SkCommentCommand : public SkDrawCommand {
287 SkCommentCommand(const char* kywd, const char* value);
288 virtual void execute(SkCanvas* canvas) SK_OVERRIDE {
289 canvas->addComment(fKywd.c_str(), fValue.c_str());
295 typedef SkDrawCommand INHERITED;
298 class SkEndCommentGroupCommand : public SkDrawCommand {
300 SkEndCommentGroupCommand();
301 virtual void execute(SkCanvas* canvas) SK_OVERRIDE {
302 canvas->endCommentGroup();
305 typedef SkDrawCommand INHERITED;
308 class SkDrawOvalCommand : public SkDrawCommand {
310 SkDrawOvalCommand(const SkRect& oval, const SkPaint& paint);
311 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
312 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
317 typedef SkDrawCommand INHERITED;
320 class SkDrawPaintCommand : public SkDrawCommand {
322 SkDrawPaintCommand(const SkPaint& paint);
323 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
324 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
328 typedef SkDrawCommand INHERITED;
331 class SkDrawPathCommand : public SkDrawCommand {
333 SkDrawPathCommand(const SkPath& path, const SkPaint& paint);
334 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
335 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
341 typedef SkDrawCommand INHERITED;
344 class SkDrawPictureCommand : public SkDrawCommand {
346 SkDrawPictureCommand(const SkPicture* picture, const SkMatrix* matrix, const SkPaint* paint);
347 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
348 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
351 SkAutoTUnref<const SkPicture> fPicture;
353 SkMatrix* fMatrixPtr;
357 typedef SkDrawCommand INHERITED;
360 class SkDrawPointsCommand : public SkDrawCommand {
362 SkDrawPointsCommand(SkCanvas::PointMode mode, size_t count, const SkPoint pts[],
363 const SkPaint& paint);
364 virtual ~SkDrawPointsCommand() { delete [] fPts; }
365 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
366 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
368 SkCanvas::PointMode fMode;
373 typedef SkDrawCommand INHERITED;
376 class SkDrawTextCommand : public SkDrawCommand {
378 SkDrawTextCommand(const void* text, size_t byteLength, SkScalar x, SkScalar y,
379 const SkPaint& paint);
380 virtual ~SkDrawTextCommand() { delete [] fText; }
381 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
389 typedef SkDrawCommand INHERITED;
392 class SkDrawPosTextCommand : public SkDrawCommand {
394 SkDrawPosTextCommand(const void* text, size_t byteLength, const SkPoint pos[],
395 const SkPaint& paint);
396 virtual ~SkDrawPosTextCommand() { delete [] fPos; delete [] fText; }
397 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
404 typedef SkDrawCommand INHERITED;
407 class SkDrawTextOnPathCommand : public SkDrawCommand {
409 SkDrawTextOnPathCommand(const void* text, size_t byteLength, const SkPath& path,
410 const SkMatrix* matrix, const SkPaint& paint);
411 virtual ~SkDrawTextOnPathCommand() { delete [] fText; }
412 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
420 typedef SkDrawCommand INHERITED;
423 class SkDrawPosTextHCommand : public SkDrawCommand {
425 SkDrawPosTextHCommand(const void* text, size_t byteLength, const SkScalar xpos[],
426 SkScalar constY, const SkPaint& paint);
427 virtual ~SkDrawPosTextHCommand() { delete [] fXpos; delete [] fText; }
428 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
436 typedef SkDrawCommand INHERITED;
439 class SkDrawTextBlobCommand : public SkDrawCommand {
441 SkDrawTextBlobCommand(const SkTextBlob* blob, SkScalar x, SkScalar y, const SkPaint& paint);
443 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
444 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
447 SkAutoTUnref<const SkTextBlob> fBlob;
452 typedef SkDrawCommand INHERITED;
455 class SkDrawRectCommand : public SkDrawCommand {
457 SkDrawRectCommand(const SkRect& rect, const SkPaint& paint);
458 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
460 const SkRect& rect() const { return fRect; }
461 const SkPaint& paint() const { return fPaint; }
466 typedef SkDrawCommand INHERITED;
469 class SkDrawRRectCommand : public SkDrawCommand {
471 SkDrawRRectCommand(const SkRRect& rrect, const SkPaint& paint);
472 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
473 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
478 typedef SkDrawCommand INHERITED;
481 class SkDrawDRRectCommand : public SkDrawCommand {
483 SkDrawDRRectCommand(const SkRRect& outer, const SkRRect& inner,
484 const SkPaint& paint);
485 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
486 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
492 typedef SkDrawCommand INHERITED;
495 class SkDrawSpriteCommand : public SkDrawCommand {
497 SkDrawSpriteCommand(const SkBitmap& bitmap, int left, int top, const SkPaint* paint);
498 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
499 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
507 typedef SkDrawCommand INHERITED;
510 class SkDrawVerticesCommand : public SkDrawCommand {
512 SkDrawVerticesCommand(SkCanvas::VertexMode vmode, int vertexCount,
513 const SkPoint vertices[], const SkPoint texs[],
514 const SkColor colors[], SkXfermode* xfermode,
515 const uint16_t indices[], int indexCount,
516 const SkPaint& paint);
517 virtual ~SkDrawVerticesCommand();
518 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
520 SkCanvas::VertexMode fVmode;
525 SkXfermode* fXfermode;
530 typedef SkDrawCommand INHERITED;
533 class SkRotateCommand : public SkDrawCommand {
535 SkRotateCommand(SkScalar degrees);
536 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
540 typedef SkDrawCommand INHERITED;
543 class SkSaveCommand : public SkDrawCommand {
546 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
547 virtual void trackSaveState(int* state) SK_OVERRIDE;
548 virtual Action action() const SK_OVERRIDE { return kPushLayer_Action; }
550 typedef SkDrawCommand INHERITED;
553 class SkSaveLayerCommand : public SkDrawCommand {
555 SkSaveLayerCommand(const SkRect* bounds, const SkPaint* paint,
556 SkCanvas::SaveFlags flags);
557 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
558 virtual void vizExecute(SkCanvas* canvas) SK_OVERRIDE;
559 virtual void trackSaveState(int* state) SK_OVERRIDE;
560 virtual Action action() const SK_OVERRIDE{ return kPushLayer_Action; }
561 virtual void setActive(bool active) SK_OVERRIDE { fActive = active; }
562 virtual bool active() const SK_OVERRIDE { return fActive; }
564 const SkPaint* paint() const { return fPaintPtr; }
570 SkCanvas::SaveFlags fFlags;
574 typedef SkDrawCommand INHERITED;
577 class SkScaleCommand : public SkDrawCommand {
579 SkScaleCommand(SkScalar sx, SkScalar sy);
580 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
582 SkScalar x() const { return fSx; }
583 SkScalar y() const { return fSy; }
589 typedef SkDrawCommand INHERITED;
592 class SkSetMatrixCommand : public SkDrawCommand {
594 SkSetMatrixCommand(const SkMatrix& matrix);
595 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
599 typedef SkDrawCommand INHERITED;
602 class SkSkewCommand : public SkDrawCommand {
604 SkSkewCommand(SkScalar sx, SkScalar sy);
605 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
610 typedef SkDrawCommand INHERITED;
613 class SkTranslateCommand : public SkDrawCommand {
615 SkTranslateCommand(SkScalar dx, SkScalar dy);
616 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
618 SkScalar x() const { return fDx; }
619 SkScalar y() const { return fDy; }
625 typedef SkDrawCommand INHERITED;
628 class SkPushCullCommand : public SkDrawCommand {
630 SkPushCullCommand(const SkRect&);
631 virtual void execute(SkCanvas*) SK_OVERRIDE;
632 virtual void vizExecute(SkCanvas* canvas) SK_OVERRIDE;
633 virtual Action action() const { return kPushCull_Action; }
634 virtual void setActive(bool active) { fActive = active; }
635 virtual bool active() const { return fActive; }
640 typedef SkDrawCommand INHERITED;
643 class SkPopCullCommand : public SkDrawCommand {
646 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
647 virtual Action action() const { return kPopCull_Action; }
649 typedef SkDrawCommand INHERITED;