enne | 34f6084c | 2017-02-02 22:39:08 | [diff] [blame] | 1 | // Copyright 2017 The Chromium Authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #ifndef CC_PAINT_PAINT_CANVAS_H_ |
| 6 | #define CC_PAINT_PAINT_CANVAS_H_ |
| 7 | |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 8 | #include "base/compiler_specific.h" |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 9 | #include "base/macros.h" |
enne | ea15ddb | 2017-03-22 01:49:08 | [diff] [blame] | 10 | #include "base/memory/ref_counted.h" |
enne | 7b64edf3 | 2017-02-16 20:10:02 | [diff] [blame] | 11 | #include "build/build_config.h" |
enne | 34f6084c | 2017-02-02 22:39:08 | [diff] [blame] | 12 | #include "cc/paint/paint_export.h" |
vmpstr | 94cfa88 | 2017-04-14 01:19:35 | [diff] [blame] | 13 | #include "cc/paint/paint_image.h" |
Vladimir Levin | 06970f1 | 2017-11-09 02:05:28 | [diff] [blame] | 14 | #include "cc/paint/paint_text_blob.h" |
enne | 34f6084c | 2017-02-02 22:39:08 | [diff] [blame] | 15 | #include "third_party/skia/include/core/SkCanvas.h" |
enne | 34f6084c | 2017-02-02 22:39:08 | [diff] [blame] | 16 | |
| 17 | namespace cc { |
| 18 | |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 19 | class PaintFlags; |
enne | 59df29de | 2017-05-02 03:23:37 | [diff] [blame] | 20 | class PaintOpBuffer; |
| 21 | |
| 22 | using PaintRecord = PaintOpBuffer; |
enne | 34f6084c | 2017-02-02 22:39:08 | [diff] [blame] | 23 | |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 24 | class CC_PAINT_EXPORT PaintCanvas { |
enne | 34f6084c | 2017-02-02 22:39:08 | [diff] [blame] | 25 | public: |
enne | 59df29de | 2017-05-02 03:23:37 | [diff] [blame] | 26 | PaintCanvas() {} |
khushalsagar | b74f912 | 2017-03-22 04:37:47 | [diff] [blame] | 27 | virtual ~PaintCanvas() {} |
| 28 | |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 29 | virtual SkMetaData& getMetaData() = 0; |
enne | 59df29de | 2017-05-02 03:23:37 | [diff] [blame] | 30 | |
| 31 | // TODO(enne): this only appears to mostly be used to determine if this is |
| 32 | // recording or not, so could be simplified or removed. |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 33 | virtual SkImageInfo imageInfo() const = 0; |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 34 | |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 35 | // TODO(enne): It would be nice to get rid of flush() entirely, as it |
| 36 | // doesn't really make sense for recording. However, this gets used by |
zhuoyu.qian | 4689dde2 | 2017-10-16 04:11:48 | [diff] [blame] | 37 | // PaintCanvasVideoRenderer which takes a PaintCanvas to paint both |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 38 | // software and hardware video. This is super entangled with ImageBuffer |
| 39 | // and canvas/video painting in Blink where the same paths are used for |
| 40 | // both recording and gpu work. |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 41 | virtual void flush() = 0; |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 42 | |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 43 | virtual int save() = 0; |
| 44 | virtual int saveLayer(const SkRect* bounds, const PaintFlags* flags) = 0; |
danakj | f4730d5 | 2017-06-06 22:03:02 | [diff] [blame] | 45 | virtual int saveLayerAlpha(const SkRect* bounds, |
| 46 | uint8_t alpha, |
| 47 | bool preserve_lcd_text_requests) = 0; |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 48 | |
| 49 | virtual void restore() = 0; |
| 50 | virtual int getSaveCount() const = 0; |
| 51 | virtual void restoreToCount(int save_count) = 0; |
| 52 | virtual void translate(SkScalar dx, SkScalar dy) = 0; |
| 53 | virtual void scale(SkScalar sx, SkScalar sy) = 0; |
| 54 | virtual void rotate(SkScalar degrees) = 0; |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 55 | virtual void concat(const SkMatrix& matrix) = 0; |
| 56 | virtual void setMatrix(const SkMatrix& matrix) = 0; |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 57 | |
| 58 | virtual void clipRect(const SkRect& rect, |
| 59 | SkClipOp op, |
| 60 | bool do_anti_alias) = 0; |
| 61 | void clipRect(const SkRect& rect, SkClipOp op) { clipRect(rect, op, false); } |
| 62 | void clipRect(const SkRect& rect, bool do_anti_alias) { |
| 63 | clipRect(rect, SkClipOp::kIntersect, do_anti_alias); |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 64 | } |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 65 | void clipRect(const SkRect& rect) { |
| 66 | clipRect(rect, SkClipOp::kIntersect, false); |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 67 | } |
| 68 | |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 69 | virtual void clipRRect(const SkRRect& rrect, |
| 70 | SkClipOp op, |
| 71 | bool do_anti_alias) = 0; |
| 72 | void clipRRect(const SkRRect& rrect, bool do_anti_alias) { |
| 73 | clipRRect(rrect, SkClipOp::kIntersect, do_anti_alias); |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 74 | } |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 75 | void clipRRect(const SkRRect& rrect, SkClipOp op) { |
| 76 | clipRRect(rrect, op, false); |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 77 | } |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 78 | void clipRRect(const SkRRect& rrect) { |
| 79 | clipRRect(rrect, SkClipOp::kIntersect, false); |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 80 | } |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 81 | |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 82 | virtual void clipPath(const SkPath& path, |
| 83 | SkClipOp op, |
| 84 | bool do_anti_alias) = 0; |
| 85 | void clipPath(const SkPath& path, SkClipOp op) { clipPath(path, op, false); } |
| 86 | void clipPath(const SkPath& path, bool do_anti_alias) { |
| 87 | clipPath(path, SkClipOp::kIntersect, do_anti_alias); |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 88 | } |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 89 | |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 90 | virtual SkRect getLocalClipBounds() const = 0; |
| 91 | virtual bool getLocalClipBounds(SkRect* bounds) const = 0; |
| 92 | virtual SkIRect getDeviceClipBounds() const = 0; |
| 93 | virtual bool getDeviceClipBounds(SkIRect* bounds) const = 0; |
| 94 | virtual void drawColor(SkColor color, SkBlendMode mode) = 0; |
| 95 | void drawColor(SkColor color) { drawColor(color, SkBlendMode::kSrcOver); } |
enne | 59df29de | 2017-05-02 03:23:37 | [diff] [blame] | 96 | |
| 97 | // TODO(enne): This is a synonym for drawColor with kSrc. Remove it. |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 98 | virtual void clear(SkColor color) = 0; |
| 99 | |
| 100 | virtual void drawLine(SkScalar x0, |
| 101 | SkScalar y0, |
| 102 | SkScalar x1, |
| 103 | SkScalar y1, |
| 104 | const PaintFlags& flags) = 0; |
| 105 | virtual void drawRect(const SkRect& rect, const PaintFlags& flags) = 0; |
| 106 | virtual void drawIRect(const SkIRect& rect, const PaintFlags& flags) = 0; |
| 107 | virtual void drawOval(const SkRect& oval, const PaintFlags& flags) = 0; |
| 108 | virtual void drawRRect(const SkRRect& rrect, const PaintFlags& flags) = 0; |
| 109 | virtual void drawDRRect(const SkRRect& outer, |
| 110 | const SkRRect& inner, |
| 111 | const PaintFlags& flags) = 0; |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 112 | virtual void drawRoundRect(const SkRect& rect, |
| 113 | SkScalar rx, |
| 114 | SkScalar ry, |
| 115 | const PaintFlags& flags) = 0; |
| 116 | virtual void drawPath(const SkPath& path, const PaintFlags& flags) = 0; |
vmpstr | 94cfa88 | 2017-04-14 01:19:35 | [diff] [blame] | 117 | virtual void drawImage(const PaintImage& image, |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 118 | SkScalar left, |
| 119 | SkScalar top, |
| 120 | const PaintFlags* flags) = 0; |
vmpstr | 94cfa88 | 2017-04-14 01:19:35 | [diff] [blame] | 121 | void drawImage(const PaintImage& image, SkScalar left, SkScalar top) { |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 122 | drawImage(image, left, top, nullptr); |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 123 | } |
| 124 | |
| 125 | enum SrcRectConstraint { |
| 126 | kStrict_SrcRectConstraint = SkCanvas::kStrict_SrcRectConstraint, |
| 127 | kFast_SrcRectConstraint = SkCanvas::kFast_SrcRectConstraint, |
| 128 | }; |
| 129 | |
vmpstr | 94cfa88 | 2017-04-14 01:19:35 | [diff] [blame] | 130 | virtual void drawImageRect(const PaintImage& image, |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 131 | const SkRect& src, |
| 132 | const SkRect& dst, |
| 133 | const PaintFlags* flags, |
| 134 | SrcRectConstraint constraint) = 0; |
| 135 | virtual void drawBitmap(const SkBitmap& bitmap, |
| 136 | SkScalar left, |
| 137 | SkScalar top, |
| 138 | const PaintFlags* flags) = 0; |
| 139 | void drawBitmap(const SkBitmap& bitmap, SkScalar left, SkScalar top) { |
| 140 | drawBitmap(bitmap, left, top, nullptr); |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 141 | } |
| 142 | |
Vladimir Levin | 06970f1 | 2017-11-09 02:05:28 | [diff] [blame] | 143 | virtual void drawTextBlob(scoped_refptr<PaintTextBlob> blob, |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 144 | SkScalar x, |
| 145 | SkScalar y, |
| 146 | const PaintFlags& flags) = 0; |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 147 | |
Adrienne Walker | 15ce2350 | 2017-05-08 18:08:15 | [diff] [blame] | 148 | // Unlike SkCanvas::drawPicture, this only plays back the PaintRecord and does |
| 149 | // not add an additional clip. This is closer to SkPicture::playback. |
enne | dffda50 | 2017-03-23 20:46:43 | [diff] [blame] | 150 | virtual void drawPicture(sk_sp<const PaintRecord> record) = 0; |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 151 | |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 152 | virtual bool isClipEmpty() const = 0; |
| 153 | virtual bool isClipRect() const = 0; |
| 154 | virtual const SkMatrix& getTotalMatrix() const = 0; |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 155 | |
enne | 5fa117a | 2017-04-04 20:56:58 | [diff] [blame] | 156 | enum class AnnotationType { |
| 157 | URL, |
| 158 | NAMED_DESTINATION, |
| 159 | LINK_TO_DESTINATION, |
| 160 | }; |
| 161 | virtual void Annotate(AnnotationType type, |
| 162 | const SkRect& rect, |
| 163 | sk_sp<SkData> data) = 0; |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 164 | |
Wei Li | 2a9bfe4 | 2018-01-13 05:42:56 | [diff] [blame^] | 165 | // Subclasses can override to handle custom data. |
| 166 | virtual void recordCustomData(uint32_t id) {} |
| 167 | |
enne | 59df29de | 2017-05-02 03:23:37 | [diff] [blame] | 168 | private: |
| 169 | DISALLOW_COPY_AND_ASSIGN(PaintCanvas); |
enne | 34f6084c | 2017-02-02 22:39:08 | [diff] [blame] | 170 | }; |
| 171 | |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 172 | class CC_PAINT_EXPORT PaintCanvasAutoRestore { |
| 173 | public: |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 174 | PaintCanvasAutoRestore(PaintCanvas* canvas, bool save) : canvas_(canvas) { |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 175 | if (canvas_) { |
| 176 | save_count_ = canvas_->getSaveCount(); |
| 177 | if (save) { |
| 178 | canvas_->save(); |
| 179 | } |
| 180 | } |
| 181 | } |
| 182 | |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 183 | ~PaintCanvasAutoRestore() { |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 184 | if (canvas_) { |
| 185 | canvas_->restoreToCount(save_count_); |
| 186 | } |
| 187 | } |
| 188 | |
enne | 98c9f805 | 2017-03-15 19:38:22 | [diff] [blame] | 189 | void restore() { |
enne | d250157 | 2017-03-09 19:59:17 | [diff] [blame] | 190 | if (canvas_) { |
| 191 | canvas_->restoreToCount(save_count_); |
| 192 | canvas_ = nullptr; |
| 193 | } |
| 194 | } |
| 195 | |
| 196 | private: |
| 197 | PaintCanvas* canvas_ = nullptr; |
| 198 | int save_count_ = 0; |
| 199 | }; |
| 200 | |
enne | 34f6084c | 2017-02-02 22:39:08 | [diff] [blame] | 201 | } // namespace cc |
| 202 | |
| 203 | #endif // CC_PAINT_PAINT_CANVAS_H_ |