1/*
2 * Copyright 2018 Google Inc.
3 *
4 * Use of this source code is governed by a BSD-style license that can be
5 * found in the LICENSE file.
6 */
7
8#ifndef SkCanvasVirtualEnforcer_DEFINED
9#define SkCanvasVirtualEnforcer_DEFINED
10
11#include "include/core/SkCanvas.h"
12
13// If you would ordinarily want to inherit from Base (eg SkCanvas, SkNWayCanvas), instead
14// inherit from SkCanvasVirtualEnforcer<Base>, which will make the build fail if you forget
15// to override one of SkCanvas' key virtual hooks.
16template <typename Base>
17class SkCanvasVirtualEnforcer : public Base {
18public:
19 using Base::Base;
20
21protected:
22 void onDrawPaint(const SkPaint& paint) override = 0;
23 void onDrawBehind(const SkPaint&) override {} // make zero after android updates
24 void onDrawRect(const SkRect& rect, const SkPaint& paint) override = 0;
25 void onDrawRRect(const SkRRect& rrect, const SkPaint& paint) override = 0;
26 void onDrawDRRect(const SkRRect& outer, const SkRRect& inner,
27 const SkPaint& paint) override = 0;
28 void onDrawOval(const SkRect& rect, const SkPaint& paint) override = 0;
29 void onDrawArc(const SkRect& rect, SkScalar startAngle, SkScalar sweepAngle, bool useCenter,
30 const SkPaint& paint) override = 0;
31 void onDrawPath(const SkPath& path, const SkPaint& paint) override = 0;
32 void onDrawRegion(const SkRegion& region, const SkPaint& paint) override = 0;
33
34 void onDrawTextBlob(const SkTextBlob* blob, SkScalar x, SkScalar y,
35 const SkPaint& paint) override = 0;
36
37 void onDrawPatch(const SkPoint cubics[12], const SkColor colors[4],
38 const SkPoint texCoords[4], SkBlendMode mode,
39 const SkPaint& paint) override = 0;
40 void onDrawPoints(SkCanvas::PointMode mode, size_t count, const SkPoint pts[],
41 const SkPaint& paint) override = 0;
42
43 // restore me later when clients are updated
44 // void onDrawVerticesObject(const SkVertices*, SkBlendMode, const SkPaint&) override = 0;
45
46 void onDrawImage(const SkImage* image, SkScalar dx, SkScalar dy,
47 const SkPaint* paint) override = 0;
48 void onDrawImageRect(const SkImage* image, const SkRect* src, const SkRect& dst,
49 const SkPaint* paint, SkCanvas::SrcRectConstraint constraint) override = 0;
50 void onDrawImageNine(const SkImage* image, const SkIRect& center, const SkRect& dst,
51 const SkPaint* paint) override = 0;
52 void onDrawImageLattice(const SkImage* image, const SkCanvas::Lattice& lattice,
53 const SkRect& dst, const SkPaint* paint) override = 0;
54
55#ifdef SK_BUILD_FOR_ANDROID_FRAMEWORK
56 // This is under active development for Chrome and not used in Android. Hold off on adding
57 // implementations in Android's SkCanvas subclasses until this stabilizes.
58 void onDrawEdgeAAQuad(const SkRect& rect, const SkPoint clip[4],
59 SkCanvas::QuadAAFlags aaFlags, const SkColor4f& color, SkBlendMode mode) override {}
60 void onDrawEdgeAAImageSet(const SkCanvas::ImageSetEntry imageSet[], int count,
61 const SkPoint dstClips[], const SkMatrix preViewMatrices[], const SkPaint* paint,
62 SkCanvas::SrcRectConstraint constraint) override {}
63#else
64 void onDrawEdgeAAQuad(const SkRect& rect, const SkPoint clip[4],
65 SkCanvas::QuadAAFlags aaFlags, const SkColor4f& color, SkBlendMode mode) override = 0;
66 void onDrawEdgeAAImageSet(const SkCanvas::ImageSetEntry imageSet[], int count,
67 const SkPoint dstClips[], const SkMatrix preViewMatrices[], const SkPaint* paint,
68 SkCanvas::SrcRectConstraint constraint) override = 0;
69#endif
70
71 void onDrawAtlas(const SkImage* atlas, const SkRSXform xform[], const SkRect rect[],
72 const SkColor colors[], int count, SkBlendMode mode, const SkRect* cull,
73 const SkPaint* paint) override = 0;
74
75 void onDrawAnnotation(const SkRect& rect, const char key[], SkData* value) override = 0;
76 void onDrawShadowRec(const SkPath&, const SkDrawShadowRec&) override = 0;
77
78 void onDrawDrawable(SkDrawable* drawable, const SkMatrix* matrix) override = 0;
79 void onDrawPicture(const SkPicture* picture, const SkMatrix* matrix,
80 const SkPaint* paint) override = 0;
81};
82
83#endif
84