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) { };
45 virtual void setUserMatrix(const SkMatrix& userMtx) { };
47 /** Does nothing by default, but used by save() and restore()-type
48 subclasses to track unresolved save() calls. */
49 virtual void trackSaveState(int* state) { };
51 // The next "active" system is only used by save, saveLayer, restore,
52 // pushCull and popCull. It is used in two ways:
53 // To determine which saveLayers are currently active (at a
54 // given point in the rendering).
55 // saves just return a kPushLayer action but don't track active state
56 // restores just return a kPopLayer action
57 // saveLayers return kPushLayer but also track the active state
58 // To determine which culls are currently active (at a given point)
60 // pushCulls return a kPushCull action
61 // popCulls return a kPopCull action
69 virtual Action action() const { return kNone_Action; }
70 virtual void setActive(bool active) {}
71 virtual bool active() const { return false; }
73 DrawType getType() { return fDrawType; };
75 virtual bool render(SkCanvas* canvas) const { return false; }
77 static const char* GetCommandString(DrawType type);
80 SkTDArray<SkString*> fInfo;
88 class SkRestoreCommand : public SkDrawCommand {
91 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
92 virtual void trackSaveState(int* state) SK_OVERRIDE;
93 virtual Action action() const SK_OVERRIDE { return kPopLayer_Action; }
96 typedef SkDrawCommand INHERITED;
99 class SkClearCommand : public SkDrawCommand {
101 SkClearCommand(SkColor color);
102 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
106 typedef SkDrawCommand INHERITED;
109 class SkClipPathCommand : public SkDrawCommand {
111 SkClipPathCommand(const SkPath& path, SkRegion::Op op, bool doAA);
112 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
113 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
119 typedef SkDrawCommand INHERITED;
122 class SkClipRegionCommand : public SkDrawCommand {
124 SkClipRegionCommand(const SkRegion& region, SkRegion::Op op);
125 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
130 typedef SkDrawCommand INHERITED;
133 class SkClipRectCommand : public SkDrawCommand {
135 SkClipRectCommand(const SkRect& rect, SkRegion::Op op, bool doAA);
136 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
138 const SkRect& rect() const { return fRect; }
139 SkRegion::Op op() const { return fOp; }
140 bool doAA() const { return fDoAA; }
147 typedef SkDrawCommand INHERITED;
150 class SkClipRRectCommand : public SkDrawCommand {
152 SkClipRRectCommand(const SkRRect& rrect, SkRegion::Op op, bool doAA);
153 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
154 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
156 const SkRRect& rrect() const { return fRRect; }
157 SkRegion::Op op() const { return fOp; }
158 bool doAA() const { return fDoAA; }
165 typedef SkDrawCommand INHERITED;
168 class SkConcatCommand : public SkDrawCommand {
170 SkConcatCommand(const SkMatrix& matrix);
171 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
175 typedef SkDrawCommand INHERITED;
178 class SkDrawBitmapCommand : public SkDrawCommand {
180 SkDrawBitmapCommand(const SkBitmap& bitmap, SkScalar left, SkScalar top,
181 const SkPaint* paint);
182 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
183 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
191 typedef SkDrawCommand INHERITED;
194 class SkDrawBitmapMatrixCommand : public SkDrawCommand {
196 SkDrawBitmapMatrixCommand(const SkBitmap& bitmap, const SkMatrix& matrix,
197 const SkPaint* paint);
198 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
199 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
206 typedef SkDrawCommand INHERITED;
209 class SkDrawBitmapNineCommand : public SkDrawCommand {
211 SkDrawBitmapNineCommand(const SkBitmap& bitmap, const SkIRect& center,
212 const SkRect& dst, const SkPaint* paint);
213 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
214 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
222 typedef SkDrawCommand INHERITED;
225 class SkDrawBitmapRectCommand : public SkDrawCommand {
227 SkDrawBitmapRectCommand(const SkBitmap& bitmap, const SkRect* src,
228 const SkRect& dst, const SkPaint* paint,
229 SkCanvas::DrawBitmapRectFlags flags);
230 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
231 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
233 const SkBitmap& bitmap() const { return fBitmap; }
235 // The non-const 'paint' method allows modification of this object's
236 // SkPaint. For this reason the ctor and setPaint method make a local copy.
237 // The 'fPaintPtr' member acts a signal that the local SkPaint is valid
238 // (since only an SkPaint* is passed into the ctor).
239 const SkPaint* paint() const { return fPaintPtr; }
240 SkPaint* paint() { return fPaintPtr; }
242 void setPaint(const SkPaint& paint) { fPaint = paint; fPaintPtr = &fPaint; }
244 const SkRect* srcRect() const { return fSrc.isEmpty() ? NULL : &fSrc; }
245 void setSrcRect(const SkRect& src) { fSrc = src; }
247 const SkRect& dstRect() const { return fDst; }
248 void setDstRect(const SkRect& dst) { fDst = dst; }
250 SkCanvas::DrawBitmapRectFlags flags() const { return fFlags; }
251 void setFlags(SkCanvas::DrawBitmapRectFlags flags) { fFlags = flags; }
259 SkCanvas::DrawBitmapRectFlags fFlags;
261 typedef SkDrawCommand INHERITED;
264 class SkDrawDataCommand : public SkDrawCommand {
266 SkDrawDataCommand(const void* data, size_t length);
267 virtual ~SkDrawDataCommand() { delete [] fData; }
268 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
273 typedef SkDrawCommand INHERITED;
276 class SkBeginCommentGroupCommand : public SkDrawCommand {
278 SkBeginCommentGroupCommand(const char* description);
279 virtual void execute(SkCanvas* canvas) SK_OVERRIDE {
280 canvas->beginCommentGroup(fDescription.c_str());
283 SkString fDescription;
285 typedef SkDrawCommand INHERITED;
288 class SkCommentCommand : public SkDrawCommand {
290 SkCommentCommand(const char* kywd, const char* value);
291 virtual void execute(SkCanvas* canvas) SK_OVERRIDE {
292 canvas->addComment(fKywd.c_str(), fValue.c_str());
298 typedef SkDrawCommand INHERITED;
301 class SkEndCommentGroupCommand : public SkDrawCommand {
303 SkEndCommentGroupCommand();
304 virtual void execute(SkCanvas* canvas) SK_OVERRIDE {
305 canvas->endCommentGroup();
308 typedef SkDrawCommand INHERITED;
311 class SkDrawOvalCommand : public SkDrawCommand {
313 SkDrawOvalCommand(const SkRect& oval, const SkPaint& paint);
314 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
315 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
320 typedef SkDrawCommand INHERITED;
323 class SkDrawPaintCommand : public SkDrawCommand {
325 SkDrawPaintCommand(const SkPaint& paint);
326 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
327 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
331 typedef SkDrawCommand INHERITED;
334 class SkDrawPathCommand : public SkDrawCommand {
336 SkDrawPathCommand(const SkPath& path, const SkPaint& paint);
337 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
338 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
344 typedef SkDrawCommand INHERITED;
347 class SkDrawPictureCommand : public SkDrawCommand {
349 SkDrawPictureCommand(const SkPicture* picture, const SkMatrix* matrix, const SkPaint* paint);
350 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
351 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
354 SkAutoTUnref<const SkPicture> fPicture;
356 SkMatrix* fMatrixPtr;
360 typedef SkDrawCommand INHERITED;
363 class SkDrawPointsCommand : public SkDrawCommand {
365 SkDrawPointsCommand(SkCanvas::PointMode mode, size_t count, const SkPoint pts[],
366 const SkPaint& paint);
367 virtual ~SkDrawPointsCommand() { delete [] fPts; }
368 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
369 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
371 SkCanvas::PointMode fMode;
376 typedef SkDrawCommand INHERITED;
379 class SkDrawTextCommand : public SkDrawCommand {
381 SkDrawTextCommand(const void* text, size_t byteLength, SkScalar x, SkScalar y,
382 const SkPaint& paint);
383 virtual ~SkDrawTextCommand() { delete [] fText; }
384 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
392 typedef SkDrawCommand INHERITED;
395 class SkDrawPosTextCommand : public SkDrawCommand {
397 SkDrawPosTextCommand(const void* text, size_t byteLength, const SkPoint pos[],
398 const SkPaint& paint);
399 virtual ~SkDrawPosTextCommand() { delete [] fPos; delete [] fText; }
400 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
407 typedef SkDrawCommand INHERITED;
410 class SkDrawTextOnPathCommand : public SkDrawCommand {
412 SkDrawTextOnPathCommand(const void* text, size_t byteLength, const SkPath& path,
413 const SkMatrix* matrix, const SkPaint& paint);
414 virtual ~SkDrawTextOnPathCommand() { delete [] fText; }
415 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
423 typedef SkDrawCommand INHERITED;
426 class SkDrawPosTextHCommand : public SkDrawCommand {
428 SkDrawPosTextHCommand(const void* text, size_t byteLength, const SkScalar xpos[],
429 SkScalar constY, const SkPaint& paint);
430 virtual ~SkDrawPosTextHCommand() { delete [] fXpos; delete [] fText; }
431 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
439 typedef SkDrawCommand INHERITED;
442 class SkDrawTextBlobCommand : public SkDrawCommand {
444 SkDrawTextBlobCommand(const SkTextBlob* blob, SkScalar x, SkScalar y, const SkPaint& paint);
446 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
447 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
450 SkAutoTUnref<const SkTextBlob> fBlob;
455 typedef SkDrawCommand INHERITED;
458 class SkDrawRectCommand : public SkDrawCommand {
460 SkDrawRectCommand(const SkRect& rect, const SkPaint& paint);
461 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
463 const SkRect& rect() const { return fRect; }
464 const SkPaint& paint() const { return fPaint; }
469 typedef SkDrawCommand INHERITED;
472 class SkDrawRRectCommand : public SkDrawCommand {
474 SkDrawRRectCommand(const SkRRect& rrect, const SkPaint& paint);
475 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
476 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
481 typedef SkDrawCommand INHERITED;
484 class SkDrawDRRectCommand : public SkDrawCommand {
486 SkDrawDRRectCommand(const SkRRect& outer, const SkRRect& inner,
487 const SkPaint& paint);
488 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
489 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
495 typedef SkDrawCommand INHERITED;
498 class SkDrawSpriteCommand : public SkDrawCommand {
500 SkDrawSpriteCommand(const SkBitmap& bitmap, int left, int top, const SkPaint* paint);
501 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
502 virtual bool render(SkCanvas* canvas) const SK_OVERRIDE;
510 typedef SkDrawCommand INHERITED;
513 class SkDrawVerticesCommand : public SkDrawCommand {
515 SkDrawVerticesCommand(SkCanvas::VertexMode vmode, int vertexCount,
516 const SkPoint vertices[], const SkPoint texs[],
517 const SkColor colors[], SkXfermode* xfermode,
518 const uint16_t indices[], int indexCount,
519 const SkPaint& paint);
520 virtual ~SkDrawVerticesCommand();
521 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
523 SkCanvas::VertexMode fVmode;
528 SkXfermode* fXfermode;
533 typedef SkDrawCommand INHERITED;
536 class SkRotateCommand : public SkDrawCommand {
538 SkRotateCommand(SkScalar degrees);
539 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
543 typedef SkDrawCommand INHERITED;
546 class SkSaveCommand : public SkDrawCommand {
549 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
550 virtual void trackSaveState(int* state) SK_OVERRIDE;
551 virtual Action action() const SK_OVERRIDE { return kPushLayer_Action; }
553 typedef SkDrawCommand INHERITED;
556 class SkSaveLayerCommand : public SkDrawCommand {
558 SkSaveLayerCommand(const SkRect* bounds, const SkPaint* paint,
559 SkCanvas::SaveFlags flags);
560 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
561 virtual void vizExecute(SkCanvas* canvas) SK_OVERRIDE;
562 virtual void trackSaveState(int* state) SK_OVERRIDE;
563 virtual Action action() const SK_OVERRIDE{ return kPushLayer_Action; }
564 virtual void setActive(bool active) SK_OVERRIDE { fActive = active; }
565 virtual bool active() const SK_OVERRIDE { return fActive; }
567 const SkPaint* paint() const { return fPaintPtr; }
573 SkCanvas::SaveFlags fFlags;
577 typedef SkDrawCommand INHERITED;
580 class SkScaleCommand : public SkDrawCommand {
582 SkScaleCommand(SkScalar sx, SkScalar sy);
583 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
585 SkScalar x() const { return fSx; }
586 SkScalar y() const { return fSy; }
592 typedef SkDrawCommand INHERITED;
595 class SkSetMatrixCommand : public SkDrawCommand {
597 SkSetMatrixCommand(const SkMatrix& matrix);
598 virtual void setUserMatrix(const SkMatrix&) SK_OVERRIDE;
599 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
601 SkMatrix fUserMatrix;
604 typedef SkDrawCommand INHERITED;
607 class SkSkewCommand : public SkDrawCommand {
609 SkSkewCommand(SkScalar sx, SkScalar sy);
610 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
615 typedef SkDrawCommand INHERITED;
618 class SkTranslateCommand : public SkDrawCommand {
620 SkTranslateCommand(SkScalar dx, SkScalar dy);
621 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
623 SkScalar x() const { return fDx; }
624 SkScalar y() const { return fDy; }
630 typedef SkDrawCommand INHERITED;
633 class SkPushCullCommand : public SkDrawCommand {
635 SkPushCullCommand(const SkRect&);
636 virtual void execute(SkCanvas*) SK_OVERRIDE;
637 virtual void vizExecute(SkCanvas* canvas) SK_OVERRIDE;
638 virtual Action action() const { return kPushCull_Action; }
639 virtual void setActive(bool active) { fActive = active; }
640 virtual bool active() const { return fActive; }
645 typedef SkDrawCommand INHERITED;
648 class SkPopCullCommand : public SkDrawCommand {
651 virtual void execute(SkCanvas* canvas) SK_OVERRIDE;
652 virtual Action action() const { return kPopCull_Action; }
654 typedef SkDrawCommand INHERITED;