epoger@google.com | ec3ed6a | 2011-07-28 14:26:00 +0000 | [diff] [blame] | 1 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 2 | /* |
epoger@google.com | ec3ed6a | 2011-07-28 14:26:00 +0000 | [diff] [blame] | 3 | * Copyright 2007 The Android Open Source Project |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 4 | * |
epoger@google.com | ec3ed6a | 2011-07-28 14:26:00 +0000 | [diff] [blame] | 5 | * Use of this source code is governed by a BSD-style license that can be |
| 6 | * found in the LICENSE file. |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 7 | */ |
| 8 | |
epoger@google.com | ec3ed6a | 2011-07-28 14:26:00 +0000 | [diff] [blame] | 9 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 10 | #ifndef SkPicture_DEFINED |
| 11 | #define SkPicture_DEFINED |
| 12 | |
scroggo@google.com | f8d7d27 | 2013-02-22 21:38:35 +0000 | [diff] [blame] | 13 | #include "SkBitmap.h" |
Mike Klein | c11530e | 2014-06-24 11:29:06 -0400 | [diff] [blame] | 14 | #include "SkDrawPictureCallback.h" |
scroggo@google.com | f1754ec | 2013-06-28 21:32:00 +0000 | [diff] [blame] | 15 | #include "SkImageDecoder.h" |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 16 | #include "SkRefCnt.h" |
robertphillips | 3afef1f | 2014-07-08 06:12:22 -0700 | [diff] [blame] | 17 | #include "SkTDArray.h" |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 18 | |
commit-bot@chromium.org | eb9547c | 2014-03-19 21:24:25 +0000 | [diff] [blame] | 19 | #if SK_SUPPORT_GPU |
| 20 | class GrContext; |
| 21 | #endif |
| 22 | |
junov@chromium.org | 35ac048 | 2012-11-01 17:10:32 +0000 | [diff] [blame] | 23 | class SkBBoxHierarchy; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 24 | class SkCanvas; |
scroggo@google.com | 1b1bcc3 | 2013-05-21 20:31:23 +0000 | [diff] [blame] | 25 | class SkData; |
robertphillips | db53990 | 2014-07-01 08:47:04 -0700 | [diff] [blame] | 26 | class SkPictureData; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 27 | class SkPictureRecord; |
| 28 | class SkStream; |
| 29 | class SkWStream; |
| 30 | |
scroggo@google.com | f1754ec | 2013-06-28 21:32:00 +0000 | [diff] [blame] | 31 | struct SkPictInfo; |
| 32 | |
Mike Klein | 744fb73 | 2014-06-23 15:13:26 -0400 | [diff] [blame] | 33 | class SkRecord; |
| 34 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 35 | /** \class SkPicture |
| 36 | |
| 37 | The SkPicture class records the drawing commands made to a canvas, to |
| 38 | be played back at a later time. |
| 39 | */ |
reed@google.com | 1a32d4a | 2011-04-25 20:02:38 +0000 | [diff] [blame] | 40 | class SK_API SkPicture : public SkRefCnt { |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 41 | public: |
robertphillips@google.com | 15e9d3e | 2012-06-21 20:25:03 +0000 | [diff] [blame] | 42 | SK_DECLARE_INST_COUNT(SkPicture) |
| 43 | |
commit-bot@chromium.org | 145d1c0 | 2014-03-16 19:46:36 +0000 | [diff] [blame] | 44 | // AccelData provides a base class for device-specific acceleration |
skia.committer@gmail.com | eb849e5 | 2014-03-17 03:02:17 +0000 | [diff] [blame] | 45 | // data. It is added to the picture via a call to a device's optimize |
commit-bot@chromium.org | 145d1c0 | 2014-03-16 19:46:36 +0000 | [diff] [blame] | 46 | // method. |
| 47 | class AccelData : public SkRefCnt { |
| 48 | public: |
| 49 | typedef uint8_t Domain; |
| 50 | typedef uint32_t Key; |
| 51 | |
| 52 | AccelData(Key key) : fKey(key) { } |
| 53 | |
| 54 | const Key& getKey() const { return fKey; } |
| 55 | |
| 56 | // This entry point allows user's to get a unique domain prefix |
| 57 | // for their keys |
| 58 | static Domain GenerateDomain(); |
| 59 | private: |
| 60 | Key fKey; |
| 61 | |
| 62 | typedef SkRefCnt INHERITED; |
| 63 | }; |
| 64 | |
commit-bot@chromium.org | 145d1c0 | 2014-03-16 19:46:36 +0000 | [diff] [blame] | 65 | /** PRIVATE / EXPERIMENTAL -- do not call */ |
Mike Klein | 744fb73 | 2014-06-23 15:13:26 -0400 | [diff] [blame] | 66 | void EXPERIMENTAL_addAccelData(const AccelData*) const; |
| 67 | |
commit-bot@chromium.org | 145d1c0 | 2014-03-16 19:46:36 +0000 | [diff] [blame] | 68 | /** PRIVATE / EXPERIMENTAL -- do not call */ |
Mike Klein | 744fb73 | 2014-06-23 15:13:26 -0400 | [diff] [blame] | 69 | const AccelData* EXPERIMENTAL_getAccelData(AccelData::Key) const; |
commit-bot@chromium.org | 145d1c0 | 2014-03-16 19:46:36 +0000 | [diff] [blame] | 70 | |
reed@google.com | 34342f6 | 2012-06-25 14:36:28 +0000 | [diff] [blame] | 71 | /** |
scroggo@google.com | f8d7d27 | 2013-02-22 21:38:35 +0000 | [diff] [blame] | 72 | * Function signature defining a function that sets up an SkBitmap from encoded data. On |
| 73 | * success, the SkBitmap should have its Config, width, height, rowBytes and pixelref set. |
| 74 | * If the installed pixelref has decoded the data into pixels, then the src buffer need not be |
| 75 | * copied. If the pixelref defers the actual decode until its lockPixels() is called, then it |
| 76 | * must make a copy of the src buffer. |
| 77 | * @param src Encoded data. |
| 78 | * @param length Size of the encoded data, in bytes. |
| 79 | * @param dst SkBitmap to install the pixel ref on. |
| 80 | * @param bool Whether or not a pixel ref was successfully installed. |
| 81 | */ |
| 82 | typedef bool (*InstallPixelRefProc)(const void* src, size_t length, SkBitmap* dst); |
| 83 | |
| 84 | /** |
| 85 | * Recreate a picture that was serialized into a stream. |
| 86 | * @param SkStream Serialized picture data. |
scroggo@google.com | f8d7d27 | 2013-02-22 21:38:35 +0000 | [diff] [blame] | 87 | * @param proc Function pointer for installing pixelrefs on SkBitmaps representing the |
| 88 | * encoded bitmap data from the stream. |
scroggo@google.com | f1754ec | 2013-06-28 21:32:00 +0000 | [diff] [blame] | 89 | * @return A new SkPicture representing the serialized data, or NULL if the stream is |
| 90 | * invalid. |
scroggo@google.com | f8d7d27 | 2013-02-22 21:38:35 +0000 | [diff] [blame] | 91 | */ |
scroggo@google.com | f1754ec | 2013-06-28 21:32:00 +0000 | [diff] [blame] | 92 | static SkPicture* CreateFromStream(SkStream*, |
| 93 | InstallPixelRefProc proc = &SkImageDecoder::DecodeMemory); |
scroggo@google.com | f8d7d27 | 2013-02-22 21:38:35 +0000 | [diff] [blame] | 94 | |
commit-bot@chromium.org | 5e0995e | 2014-02-07 12:20:04 +0000 | [diff] [blame] | 95 | /** |
| 96 | * Recreate a picture that was serialized into a buffer. If the creation requires bitmap |
| 97 | * decoding, the decoder must be set on the SkReadBuffer parameter by calling |
| 98 | * SkReadBuffer::setBitmapDecoder() before calling SkPicture::CreateFromBuffer(). |
| 99 | * @param SkReadBuffer Serialized picture data. |
| 100 | * @return A new SkPicture representing the serialized data, or NULL if the buffer is |
| 101 | * invalid. |
| 102 | */ |
| 103 | static SkPicture* CreateFromBuffer(SkReadBuffer&); |
| 104 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 105 | virtual ~SkPicture(); |
rmistry@google.com | fbfcd56 | 2012-08-23 18:09:54 +0000 | [diff] [blame] | 106 | |
mtklein | d3e474e | 2014-06-27 12:34:44 -0700 | [diff] [blame] | 107 | #ifdef SK_SUPPORT_LEGACY_PICTURE_CLONE |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 108 | /** |
djsollen@google.com | c9ab987 | 2012-08-29 18:52:07 +0000 | [diff] [blame] | 109 | * Creates a thread-safe clone of the picture that is ready for playback. |
| 110 | */ |
| 111 | SkPicture* clone() const; |
mtklein | d3e474e | 2014-06-27 12:34:44 -0700 | [diff] [blame] | 112 | #endif |
rmistry@google.com | fbfcd56 | 2012-08-23 18:09:54 +0000 | [diff] [blame] | 113 | |
robertphillips | 643b8bd | 2014-06-08 05:55:05 -0700 | [diff] [blame] | 114 | /** Replays the drawing commands on the specified canvas. |
reed@google.com | 74babdf | 2013-05-20 17:02:41 +0000 | [diff] [blame] | 115 | @param canvas the canvas receiving the drawing commands. |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 116 | */ |
robertphillips | 9b14f26 | 2014-06-04 05:40:44 -0700 | [diff] [blame] | 117 | void draw(SkCanvas* canvas, SkDrawPictureCallback* = NULL) const; |
rmistry@google.com | fbfcd56 | 2012-08-23 18:09:54 +0000 | [diff] [blame] | 118 | |
robertphillips | a8d7f0b | 2014-08-29 08:03:56 -0700 | [diff] [blame] | 119 | #ifdef SK_LEGACY_PICTURE_SIZE_API |
| 120 | int width() const { return SkScalarCeilToInt(fCullWidth); } |
| 121 | int height() const { return SkScalarCeilToInt(fCullHeight); } |
| 122 | #endif |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 123 | |
robertphillips | a8d7f0b | 2014-08-29 08:03:56 -0700 | [diff] [blame] | 124 | /** Return the cull rect used when creating this picture: { 0, 0, cullWidth, cullHeight }. |
| 125 | It does not necessarily reflect the bounds of what has been recorded into the picture. |
| 126 | @return the cull rect used to create this picture |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 127 | */ |
robertphillips | a8d7f0b | 2014-08-29 08:03:56 -0700 | [diff] [blame] | 128 | const SkRect cullRect() const { return SkRect::MakeWH(fCullWidth, fCullHeight); } |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 129 | |
skia.committer@gmail.com | a915772 | 2014-04-03 03:04:26 +0000 | [diff] [blame] | 130 | /** Return a non-zero, unique value representing the picture. This call is |
| 131 | only valid when not recording. Between a beginRecording/endRecording |
commit-bot@chromium.org | 2b4e370 | 2014-04-07 18:26:22 +0000 | [diff] [blame] | 132 | pair it will just return 0 (the invalid ID). Each beginRecording/ |
robertphillips@google.com | d550088 | 2014-04-02 23:51:13 +0000 | [diff] [blame] | 133 | endRecording pair will cause a different generation ID to be returned. |
| 134 | */ |
commit-bot@chromium.org | 2b4e370 | 2014-04-07 18:26:22 +0000 | [diff] [blame] | 135 | uint32_t uniqueID() const; |
robertphillips@google.com | d550088 | 2014-04-02 23:51:13 +0000 | [diff] [blame] | 136 | |
scroggo@google.com | 5a7c6be | 2012-10-04 21:46:08 +0000 | [diff] [blame] | 137 | /** |
scroggo@google.com | 1b1bcc3 | 2013-05-21 20:31:23 +0000 | [diff] [blame] | 138 | * Function to encode an SkBitmap to an SkData. A function with this |
commit-bot@chromium.org | 8b0e8ac | 2014-01-30 18:58:24 +0000 | [diff] [blame] | 139 | * signature can be passed to serialize() and SkWriteBuffer. |
| 140 | * Returning NULL will tell the SkWriteBuffer to use |
scroggo@google.com | 1b1bcc3 | 2013-05-21 20:31:23 +0000 | [diff] [blame] | 141 | * SkBitmap::flatten() to store the bitmap. |
reed@google.com | 672588b | 2014-01-08 15:42:01 +0000 | [diff] [blame] | 142 | * |
| 143 | * @param pixelRefOffset DEPRECATED -- caller assumes it will return 0. |
scroggo@google.com | 1b1bcc3 | 2013-05-21 20:31:23 +0000 | [diff] [blame] | 144 | * @return SkData If non-NULL, holds encoded data representing the passed |
| 145 | * in bitmap. The caller is responsible for calling unref(). |
scroggo@google.com | 32ef131 | 2013-02-22 22:04:19 +0000 | [diff] [blame] | 146 | */ |
scroggo@google.com | 1b1bcc3 | 2013-05-21 20:31:23 +0000 | [diff] [blame] | 147 | typedef SkData* (*EncodeBitmap)(size_t* pixelRefOffset, const SkBitmap& bm); |
scroggo@google.com | 32ef131 | 2013-02-22 22:04:19 +0000 | [diff] [blame] | 148 | |
| 149 | /** |
scroggo@google.com | 5a7c6be | 2012-10-04 21:46:08 +0000 | [diff] [blame] | 150 | * Serialize to a stream. If non NULL, encoder will be used to encode |
| 151 | * any bitmaps in the picture. |
scroggo@google.com | 1b1bcc3 | 2013-05-21 20:31:23 +0000 | [diff] [blame] | 152 | * encoder will never be called with a NULL pixelRefOffset. |
scroggo@google.com | 5a7c6be | 2012-10-04 21:46:08 +0000 | [diff] [blame] | 153 | */ |
scroggo@google.com | 32ef131 | 2013-02-22 22:04:19 +0000 | [diff] [blame] | 154 | void serialize(SkWStream*, EncodeBitmap encoder = NULL) const; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 155 | |
tomhudson@google.com | 381010e | 2013-10-24 11:12:47 +0000 | [diff] [blame] | 156 | /** |
commit-bot@chromium.org | 5e0995e | 2014-02-07 12:20:04 +0000 | [diff] [blame] | 157 | * Serialize to a buffer. |
| 158 | */ |
| 159 | void flatten(SkWriteBuffer&) const; |
| 160 | |
| 161 | /** |
tomhudson@google.com | 381010e | 2013-10-24 11:12:47 +0000 | [diff] [blame] | 162 | * Returns true if any bitmaps may be produced when this SkPicture |
| 163 | * is replayed. |
tomhudson@google.com | 381010e | 2013-10-24 11:12:47 +0000 | [diff] [blame] | 164 | */ |
| 165 | bool willPlayBackBitmaps() const; |
| 166 | |
commit-bot@chromium.org | 6f4fb0f | 2014-03-03 19:18:39 +0000 | [diff] [blame] | 167 | /** Return true if the SkStream/Buffer represents a serialized picture, and |
| 168 | fills out SkPictInfo. After this function returns, the data source is not |
skia.committer@gmail.com | ade9a34 | 2014-03-04 03:02:32 +0000 | [diff] [blame] | 169 | rewound so it will have to be manually reset before passing to |
commit-bot@chromium.org | 6f4fb0f | 2014-03-03 19:18:39 +0000 | [diff] [blame] | 170 | CreateFromStream or CreateFromBuffer. Note, CreateFromStream and |
| 171 | CreateFromBuffer perform this check internally so these entry points are |
| 172 | intended for stand alone tools. |
| 173 | If false is returned, SkPictInfo is unmodified. |
| 174 | */ |
| 175 | static bool InternalOnly_StreamIsSKP(SkStream*, SkPictInfo*); |
robertphillips | a8d7f0b | 2014-08-29 08:03:56 -0700 | [diff] [blame] | 176 | static bool InternalOnly_BufferIsSKP(SkReadBuffer*, SkPictInfo*); |
commit-bot@chromium.org | 6f4fb0f | 2014-03-03 19:18:39 +0000 | [diff] [blame] | 177 | |
commit-bot@chromium.org | eb9547c | 2014-03-19 21:24:25 +0000 | [diff] [blame] | 178 | /** Return true if the picture is suitable for rendering on the GPU. |
| 179 | */ |
| 180 | |
| 181 | #if SK_SUPPORT_GPU |
commit-bot@chromium.org | a1ff26a | 2014-05-30 21:52:52 +0000 | [diff] [blame] | 182 | bool suitableForGpuRasterization(GrContext*, const char ** = NULL) const; |
commit-bot@chromium.org | eb9547c | 2014-03-19 21:24:25 +0000 | [diff] [blame] | 183 | #endif |
| 184 | |
robertphillips | d771f6b | 2014-07-22 10:18:06 -0700 | [diff] [blame] | 185 | class DeletionListener : public SkRefCnt { |
| 186 | public: |
| 187 | virtual void onDeletion(uint32_t pictureID) = 0; |
| 188 | }; |
| 189 | |
| 190 | // Takes ref on listener. |
| 191 | void addDeletionListener(DeletionListener* listener) const; |
| 192 | |
mtklein | 5a246bb | 2014-08-14 19:17:18 -0700 | [diff] [blame] | 193 | /** Return the approximate number of operations in this picture. This |
| 194 | * number may be greater or less than the number of SkCanvas calls |
| 195 | * recorded: some calls may be recorded as more than one operation, or some |
| 196 | * calls may be optimized away. |
| 197 | */ |
| 198 | int approximateOpCount() const; |
| 199 | |
ajuma | 750ae26 | 2014-08-18 12:59:55 -0700 | [diff] [blame] | 200 | /** Return true if this picture contains text. |
| 201 | */ |
| 202 | bool hasText() const; |
| 203 | |
robertphillips | 6daadc7 | 2014-07-08 08:38:18 -0700 | [diff] [blame] | 204 | private: |
robertphillips@google.com | 9a5b570 | 2012-11-13 20:41:18 +0000 | [diff] [blame] | 205 | // V2 : adds SkPixelRef's generation ID. |
| 206 | // V3 : PictInfo tag at beginning, and EOF tag at the end |
| 207 | // V4 : move SkPictInfo to be the header |
| 208 | // V5 : don't read/write FunctionPtr on cross-process (we can detect that) |
| 209 | // V6 : added serialization of SkPath's bounds (and packed its flags tighter) |
| 210 | // V7 : changed drawBitmapRect(IRect) to drawBitmapRectToRect(Rect) |
| 211 | // V8 : Add an option for encoding bitmaps |
| 212 | // V9 : Allow the reader and writer of an SKP disagree on whether to support |
| 213 | // SK_SUPPORT_HINTING_SCALE_FACTOR |
reed@google.com | 4ed0fb7 | 2012-12-12 20:48:18 +0000 | [diff] [blame] | 214 | // V10: add drawRRect, drawOval, clipRRect |
scroggo@google.com | 74b7ffd | 2013-04-30 02:32:41 +0000 | [diff] [blame] | 215 | // V11: modify how readBitmap and writeBitmap store their info. |
reed@google.com | 277c3f8 | 2013-05-31 15:17:50 +0000 | [diff] [blame] | 216 | // V12: add conics to SkPath, use new SkPathRef flattening |
commit-bot@chromium.org | eed779d | 2013-08-16 10:24:37 +0000 | [diff] [blame] | 217 | // V13: add flag to drawBitmapRectToRect |
robertphillips@google.com | 7ce661d | 2013-08-27 16:14:03 +0000 | [diff] [blame] | 218 | // parameterize blurs by sigma rather than radius |
robertphillips@google.com | ca0c838 | 2013-09-26 12:18:23 +0000 | [diff] [blame] | 219 | // V14: Add flags word to PathRef serialization |
robertphillips@google.com | d550088 | 2014-04-02 23:51:13 +0000 | [diff] [blame] | 220 | // V15: Remove A1 bitmap config (and renumber remaining configs) |
robertphillips@google.com | 466310d | 2013-12-03 16:43:54 +0000 | [diff] [blame] | 221 | // V16: Move SkPath's isOval flag to SkPathRef |
reed@google.com | e132f50 | 2013-12-13 19:58:46 +0000 | [diff] [blame] | 222 | // V17: SkPixelRef now writes SkImageInfo |
reed@google.com | 672588b | 2014-01-08 15:42:01 +0000 | [diff] [blame] | 223 | // V18: SkBitmap now records x,y for its pixelref origin, instead of offset. |
commit-bot@chromium.org | fed2ab6 | 2014-01-23 15:16:05 +0000 | [diff] [blame] | 224 | // V19: encode matrices and regions into the ops stream |
commit-bot@chromium.org | 5e0995e | 2014-02-07 12:20:04 +0000 | [diff] [blame] | 225 | // V20: added bool to SkPictureImageFilter's serialization (to allow SkPicture serialization) |
commit-bot@chromium.org | 210ae2a | 2014-02-27 17:40:13 +0000 | [diff] [blame] | 226 | // V21: add pushCull, popCull |
commit-bot@chromium.org | dcb8e54 | 2014-03-05 18:25:20 +0000 | [diff] [blame] | 227 | // V22: SK_PICT_FACTORY_TAG's size is now the chunk size in bytes |
commit-bot@chromium.org | 85faf50 | 2014-04-16 12:58:02 +0000 | [diff] [blame] | 228 | // V23: SkPaint::FilterLevel became a real enum |
commit-bot@chromium.org | 44d83c1 | 2014-04-21 13:10:25 +0000 | [diff] [blame] | 229 | // V24: SkTwoPointConicalGradient now has fFlipped flag for gradient flipping |
commit-bot@chromium.org | aec1438 | 2014-04-22 15:21:18 +0000 | [diff] [blame] | 230 | // V25: SkDashPathEffect now only writes phase and interval array when flattening |
commit-bot@chromium.org | 76a3b2a | 2014-04-24 16:54:46 +0000 | [diff] [blame] | 231 | // V26: Removed boolean from SkColorShader for inheriting color from SkPaint. |
commit-bot@chromium.org | 83f23d8 | 2014-05-22 12:27:41 +0000 | [diff] [blame] | 232 | // V27: Remove SkUnitMapper from gradients (and skia). |
commit-bot@chromium.org | 968edca | 2014-05-23 13:21:55 +0000 | [diff] [blame] | 233 | // V28: No longer call bitmap::flatten inside SkWriteBuffer::writeBitmap. |
Florin Malita | 5f6102d | 2014-06-30 10:13:28 -0400 | [diff] [blame] | 234 | // V29: Removed SaveFlags parameter from save(). |
scroggo | c870d49 | 2014-07-11 10:42:12 -0700 | [diff] [blame] | 235 | // V30: Remove redundant SkMatrix from SkLocalMatrixShader. |
senorblanco | 55b6d8b | 2014-07-30 11:26:46 -0700 | [diff] [blame] | 236 | // V31: Add a serialized UniqueID to SkImageFilter. |
djsollen | 3b62554 | 2014-08-14 06:29:02 -0700 | [diff] [blame] | 237 | // V32: Removed SkPaintOptionsAndroid from SkPaint |
fmalita | b742517 | 2014-08-26 07:56:44 -0700 | [diff] [blame] | 238 | // V33: Serialize only public API of effects. |
| 239 | // V34: Add SkTextBlob serialization. |
robertphillips | a8d7f0b | 2014-08-29 08:03:56 -0700 | [diff] [blame] | 240 | // V35: Store SkRect (rather then width & height) in header |
commit-bot@chromium.org | d281c92 | 2014-02-18 22:08:16 +0000 | [diff] [blame] | 241 | |
| 242 | // Note: If the picture version needs to be increased then please follow the |
| 243 | // steps to generate new SKPs in (only accessible to Googlers): http://goo.gl/qATVcw |
commit-bot@chromium.org | e8d9614 | 2014-02-25 02:16:10 +0000 | [diff] [blame] | 244 | |
| 245 | // Only SKPs within the min/current picture version range (inclusive) can be read. |
| 246 | static const uint32_t MIN_PICTURE_VERSION = 19; |
robertphillips | a8d7f0b | 2014-08-29 08:03:56 -0700 | [diff] [blame] | 247 | static const uint32_t CURRENT_PICTURE_VERSION = 35; |
robertphillips@google.com | 9a5b570 | 2012-11-13 20:41:18 +0000 | [diff] [blame] | 248 | |
commit-bot@chromium.org | 2b4e370 | 2014-04-07 18:26:22 +0000 | [diff] [blame] | 249 | mutable uint32_t fUniqueID; |
robertphillips@google.com | d550088 | 2014-04-02 23:51:13 +0000 | [diff] [blame] | 250 | |
Robert Phillips | 004522f | 2014-07-08 12:58:20 -0400 | [diff] [blame] | 251 | // TODO: make SkPictureData const when clone method goes away |
| 252 | SkAutoTDelete<SkPictureData> fData; |
robertphillips | a8d7f0b | 2014-08-29 08:03:56 -0700 | [diff] [blame] | 253 | const SkScalar fCullWidth; |
| 254 | const SkScalar fCullHeight; |
Mike Klein | 744fb73 | 2014-06-23 15:13:26 -0400 | [diff] [blame] | 255 | mutable SkAutoTUnref<const AccelData> fAccelData; |
robertphillips@google.com | 63f1127 | 2012-10-24 19:30:41 +0000 | [diff] [blame] | 256 | |
robertphillips | d771f6b | 2014-07-22 10:18:06 -0700 | [diff] [blame] | 257 | mutable SkTDArray<DeletionListener*> fDeletionListeners; // pointers are refed |
| 258 | |
commit-bot@chromium.org | 2b4e370 | 2014-04-07 18:26:22 +0000 | [diff] [blame] | 259 | void needsNewGenID() { fUniqueID = SK_InvalidGenID; } |
robertphillips | d771f6b | 2014-07-22 10:18:06 -0700 | [diff] [blame] | 260 | void callDeletionListeners(); |
robertphillips@google.com | d550088 | 2014-04-02 23:51:13 +0000 | [diff] [blame] | 261 | |
Robert Phillips | cfaeec4 | 2014-07-13 12:00:50 -0400 | [diff] [blame] | 262 | // Create a new SkPicture from an existing SkPictureData. The new picture |
| 263 | // takes ownership of 'data'. |
robertphillips | a8d7f0b | 2014-08-29 08:03:56 -0700 | [diff] [blame] | 264 | SkPicture(SkPictureData* data, SkScalar width, SkScalar height); |
scroggo@google.com | f1754ec | 2013-06-28 21:32:00 +0000 | [diff] [blame] | 265 | |
robertphillips | a8d7f0b | 2014-08-29 08:03:56 -0700 | [diff] [blame] | 266 | SkPicture(SkScalar width, SkScalar height, const SkPictureRecord& record, bool deepCopyOps); |
robertphillips | 0bdbea7 | 2014-06-11 11:37:55 -0700 | [diff] [blame] | 267 | |
commit-bot@chromium.org | 70512af | 2014-03-18 17:45:32 +0000 | [diff] [blame] | 268 | // An OperationList encapsulates a set of operation offsets into the picture byte |
| 269 | // stream along with the CTMs needed for those operation. |
commit-bot@chromium.org | e3beb6b | 2014-04-07 19:34:38 +0000 | [diff] [blame] | 270 | class OperationList : ::SkNoncopyable { |
commit-bot@chromium.org | 70512af | 2014-03-18 17:45:32 +0000 | [diff] [blame] | 271 | public: |
commit-bot@chromium.org | 70512af | 2014-03-18 17:45:32 +0000 | [diff] [blame] | 272 | // The following three entry points should only be accessed if |
| 273 | // 'valid' returns true. |
robertphillips | 3afef1f | 2014-07-08 06:12:22 -0700 | [diff] [blame] | 274 | int numOps() const { return fOps.count(); } |
commit-bot@chromium.org | 70512af | 2014-03-18 17:45:32 +0000 | [diff] [blame] | 275 | // The offset in the picture of the operation to execute. |
robertphillips | 3afef1f | 2014-07-08 06:12:22 -0700 | [diff] [blame] | 276 | uint32_t offset(int index) const; |
commit-bot@chromium.org | 70512af | 2014-03-18 17:45:32 +0000 | [diff] [blame] | 277 | // The CTM that must be installed for the operation to behave correctly |
robertphillips | 3afef1f | 2014-07-08 06:12:22 -0700 | [diff] [blame] | 278 | const SkMatrix& matrix(int index) const; |
| 279 | |
| 280 | SkTDArray<void*> fOps; |
commit-bot@chromium.org | 70512af | 2014-03-18 17:45:32 +0000 | [diff] [blame] | 281 | }; |
| 282 | |
| 283 | /** PRIVATE / EXPERIMENTAL -- do not call |
| 284 | Return the operations required to render the content inside 'queryRect'. |
| 285 | */ |
mtklein | 533eb78 | 2014-08-27 10:39:42 -0700 | [diff] [blame] | 286 | const OperationList* EXPERIMENTAL_getActiveOps(const SkRect& queryRect) const; |
commit-bot@chromium.org | 75cf29b | 2014-03-24 19:40:49 +0000 | [diff] [blame] | 287 | |
commit-bot@chromium.org | 9e5f85e | 2014-03-12 14:46:41 +0000 | [diff] [blame] | 288 | void createHeader(SkPictInfo* info) const; |
| 289 | static bool IsValidPictInfo(const SkPictInfo& info); |
commit-bot@chromium.org | 5e0995e | 2014-02-07 12:20:04 +0000 | [diff] [blame] | 290 | |
robertphillips | 6142609 | 2014-07-10 09:35:12 -0700 | [diff] [blame] | 291 | friend class SkPictureData; // to access OperationList |
| 292 | friend class SkPictureRecorder; // just for SkPicture-based constructor |
| 293 | friend class SkGpuDevice; // for EXPERIMENTAL_getActiveOps/OperationList |
robertphillips | 98d709b | 2014-09-02 10:20:50 -0700 | [diff] [blame] | 294 | friend class GrLayerHoister; // for EXPERIMENTAL_getActiveOps/OperationList |
robertphillips | d628330 | 2014-08-27 11:53:28 -0700 | [diff] [blame] | 295 | friend class CollectLayers; // access to fRecord |
robertphillips | 6142609 | 2014-07-10 09:35:12 -0700 | [diff] [blame] | 296 | friend class SkPicturePlayback; // to get fData & OperationList |
robertphillips | c26d991 | 2014-07-10 07:21:27 -0700 | [diff] [blame] | 297 | friend class SkPictureReplacementPlayback; // to access OperationList |
robertphillips@google.com | 15e9d3e | 2012-06-21 20:25:03 +0000 | [diff] [blame] | 298 | |
| 299 | typedef SkRefCnt INHERITED; |
Mike Klein | 744fb73 | 2014-06-23 15:13:26 -0400 | [diff] [blame] | 300 | |
mtklein | 5ad6ee1 | 2014-08-11 08:08:43 -0700 | [diff] [blame] | 301 | // Takes ownership of the SkRecord, refs the (optional) BBH. |
robertphillips | a8d7f0b | 2014-08-29 08:03:56 -0700 | [diff] [blame] | 302 | SkPicture(SkScalar width, SkScalar height, SkRecord*, SkBBoxHierarchy*); |
mtklein | 7b705bb | 2014-08-20 14:22:58 -0700 | [diff] [blame] | 303 | // Return as a new SkPicture that's backed by SkRecord. |
| 304 | static SkPicture* Forwardport(const SkPicture&); |
mtklein | 5ad6ee1 | 2014-08-11 08:08:43 -0700 | [diff] [blame] | 305 | |
| 306 | SkAutoTDelete<SkRecord> fRecord; |
| 307 | SkAutoTUnref<SkBBoxHierarchy> fBBH; |
tomhudson | 3a0f279 | 2014-08-20 05:29:41 -0700 | [diff] [blame] | 308 | |
mtklein | 53fecfb | 2014-08-21 09:11:37 -0700 | [diff] [blame] | 309 | struct PathCounter; |
| 310 | |
tomhudson | 3a0f279 | 2014-08-20 05:29:41 -0700 | [diff] [blame] | 311 | struct Analysis { |
mtklein | c551d9f | 2014-08-20 08:09:46 -0700 | [diff] [blame] | 312 | Analysis() {} // Only used by SkPictureData codepath. |
| 313 | explicit Analysis(const SkRecord&); |
tomhudson | 3a0f279 | 2014-08-20 05:29:41 -0700 | [diff] [blame] | 314 | |
| 315 | bool suitableForGpuRasterization(const char** reason, int sampleCount) const; |
| 316 | |
| 317 | bool fWillPlaybackBitmaps; |
mtklein | c551d9f | 2014-08-20 08:09:46 -0700 | [diff] [blame] | 318 | bool fHasText; |
tomhudson | 3a0f279 | 2014-08-20 05:29:41 -0700 | [diff] [blame] | 319 | int fNumPaintWithPathEffectUses; |
| 320 | int fNumFastPathDashEffects; |
| 321 | int fNumAAConcavePaths; |
| 322 | int fNumAAHairlineConcavePaths; |
mtklein | c551d9f | 2014-08-20 08:09:46 -0700 | [diff] [blame] | 323 | } fAnalysis; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 324 | }; |
| 325 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 326 | #endif |