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 2010 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 SkDevice_DEFINED |
| 11 | #define SkDevice_DEFINED |
| 12 | |
| 13 | #include "SkRefCnt.h" |
| 14 | #include "SkBitmap.h" |
| 15 | #include "SkCanvas.h" |
| 16 | #include "SkColor.h" |
bungeman@google.com | 532470f | 2013-01-22 19:25:14 +0000 | [diff] [blame] | 17 | #include "SkDeviceProperties.h" |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 18 | |
reed@google.com | 46799cd | 2011-02-22 20:56:26 +0000 | [diff] [blame] | 19 | class SkClipStack; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 20 | class SkDraw; |
| 21 | struct SkIRect; |
| 22 | class SkMatrix; |
reed@google.com | a7d9485 | 2011-03-30 21:23:07 +0000 | [diff] [blame] | 23 | class SkMetaData; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 24 | class SkRegion; |
| 25 | |
commit-bot@chromium.org | b8d00db | 2013-06-26 19:18:23 +0000 | [diff] [blame] | 26 | class GrRenderTarget; |
bsalomon@google.com | d9f826c | 2011-07-18 15:25:04 +0000 | [diff] [blame] | 27 | |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 28 | class SK_API SkBaseDevice : public SkRefCnt { |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 29 | public: |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 30 | SK_DECLARE_INST_COUNT(SkBaseDevice) |
robertphillips@google.com | 15e9d3e | 2012-06-21 20:25:03 +0000 | [diff] [blame] | 31 | |
reed@google.com | af951c9 | 2011-06-16 19:10:39 +0000 | [diff] [blame] | 32 | /** |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 33 | * Construct a new device. |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 34 | */ |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 35 | SkBaseDevice(); |
reed@google.com | af951c9 | 2011-06-16 19:10:39 +0000 | [diff] [blame] | 36 | |
| 37 | /** |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 38 | * Construct a new device. |
bungeman@google.com | 532470f | 2013-01-22 19:25:14 +0000 | [diff] [blame] | 39 | */ |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 40 | SkBaseDevice(const SkDeviceProperties& deviceProperties); |
bungeman@google.com | 532470f | 2013-01-22 19:25:14 +0000 | [diff] [blame] | 41 | |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 42 | virtual ~SkBaseDevice(); |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 43 | |
mike@reedtribe.org | ea4ac97 | 2011-04-26 11:48:33 +0000 | [diff] [blame] | 44 | /** |
reed@google.com | 2d54d06 | 2011-06-21 12:19:28 +0000 | [diff] [blame] | 45 | * Creates a device that is of the same type as this device (e.g. SW-raster, |
| 46 | * GPU, or PDF). The backing store for this device is created automatically |
| 47 | * (e.g. offscreen pixels or FBO or whatever is appropriate). |
bsalomon@google.com | e97f085 | 2011-06-17 13:10:25 +0000 | [diff] [blame] | 48 | * |
reed@google.com | 2d54d06 | 2011-06-21 12:19:28 +0000 | [diff] [blame] | 49 | * @param width width of the device to create |
| 50 | * @param height height of the device to create |
| 51 | * @param isOpaque performance hint, set to true if you know that you will |
| 52 | * draw into this device such that all of the pixels will |
| 53 | * be opaque. |
bsalomon@google.com | e97f085 | 2011-06-17 13:10:25 +0000 | [diff] [blame] | 54 | */ |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 55 | SkBaseDevice* createCompatibleDevice(SkBitmap::Config config, |
| 56 | int width, int height, |
| 57 | bool isOpaque); |
bsalomon@google.com | e97f085 | 2011-06-17 13:10:25 +0000 | [diff] [blame] | 58 | |
bungeman@google.com | 88edf1e | 2011-08-08 19:41:56 +0000 | [diff] [blame] | 59 | SkMetaData& getMetaData(); |
| 60 | |
vandebo@chromium.org | 35fc62b | 2010-10-26 19:47:30 +0000 | [diff] [blame] | 61 | enum Capabilities { |
reed@google.com | fdbd504 | 2014-02-04 17:49:52 +0000 | [diff] [blame] | 62 | kVector_Capability = 0x1, //!< mask indicating a vector representation |
vandebo@chromium.org | 35fc62b | 2010-10-26 19:47:30 +0000 | [diff] [blame] | 63 | }; |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 64 | virtual uint32_t getDeviceCapabilities() = 0; |
vandebo@chromium.org | 35fc62b | 2010-10-26 19:47:30 +0000 | [diff] [blame] | 65 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 66 | /** Return the width of the device (in pixels). |
| 67 | */ |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 68 | virtual int width() const = 0; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 69 | /** Return the height of the device (in pixels). |
| 70 | */ |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 71 | virtual int height() const = 0; |
reed@google.com | 6f8f292 | 2011-03-04 22:27:10 +0000 | [diff] [blame] | 72 | |
bungeman@google.com | 532470f | 2013-01-22 19:25:14 +0000 | [diff] [blame] | 73 | /** Return the image properties of the device. */ |
| 74 | virtual const SkDeviceProperties& getDeviceProperties() const { |
| 75 | //Currently, all the properties are leaky. |
| 76 | return fLeakyProperties; |
| 77 | } |
| 78 | |
reed@google.com | d51bfa0 | 2011-08-30 15:56:11 +0000 | [diff] [blame] | 79 | /** |
commit-bot@chromium.org | c3bd8af | 2014-02-13 17:14:46 +0000 | [diff] [blame^] | 80 | * Return ImageInfo for this device. If the canvas is not backed by pixels |
| 81 | * (cpu or gpu), then the info's ColorType will be kUnknown_SkColorType. |
| 82 | */ |
| 83 | virtual SkImageInfo imageInfo() const; |
| 84 | |
| 85 | /** |
reed@google.com | d51bfa0 | 2011-08-30 15:56:11 +0000 | [diff] [blame] | 86 | * Return the bounds of the device in the coordinate space of the root |
| 87 | * canvas. The root device will have its top-left at 0,0, but other devices |
| 88 | * such as those associated with saveLayer may have a non-zero origin. |
| 89 | */ |
reed@google.com | ec3ca87 | 2013-11-13 16:02:18 +0000 | [diff] [blame] | 90 | void getGlobalBounds(SkIRect* bounds) const { |
| 91 | SkASSERT(bounds); |
| 92 | const SkIPoint& origin = this->getOrigin(); |
| 93 | bounds->setXYWH(origin.x(), origin.y(), this->width(), this->height()); |
| 94 | } |
skia.committer@gmail.com | 73a5d53 | 2013-11-14 07:02:31 +0000 | [diff] [blame] | 95 | |
bungeman@google.com | 88edf1e | 2011-08-08 19:41:56 +0000 | [diff] [blame] | 96 | |
robertphillips@google.com | 07f81a5 | 2013-09-17 12:26:23 +0000 | [diff] [blame] | 97 | /** Returns true if the device's bitmap's config treats every pixel as |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 98 | implicitly opaque. |
| 99 | */ |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 100 | virtual bool isOpaque() const = 0; |
skia.committer@gmail.com | 772c4e6 | 2013-08-30 07:01:34 +0000 | [diff] [blame] | 101 | |
reed@google.com | 4469938 | 2013-10-31 17:28:30 +0000 | [diff] [blame] | 102 | /** Return the bitmap config of the device's pixels |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 103 | */ |
reed@google.com | 4469938 | 2013-10-31 17:28:30 +0000 | [diff] [blame] | 104 | SK_ATTR_DEPRECATED("want to hide configness of the device -- don't use") |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 105 | virtual SkBitmap::Config config() const = 0; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 106 | |
| 107 | /** Return the bitmap associated with this device. Call this each time you need |
| 108 | to access the bitmap, as it notifies the subclass to perform any flushing |
| 109 | etc. before you examine the pixels. |
| 110 | @param changePixels set to true if the caller plans to change the pixels |
| 111 | @return the device's bitmap |
| 112 | */ |
| 113 | const SkBitmap& accessBitmap(bool changePixels); |
| 114 | |
bungeman@google.com | 88edf1e | 2011-08-08 19:41:56 +0000 | [diff] [blame] | 115 | /** |
bsalomon@google.com | ae0fb05 | 2011-11-10 22:34:56 +0000 | [diff] [blame] | 116 | * DEPRECATED: This will be made protected once WebKit stops using it. |
bsalomon@google.com | 6850eab | 2011-11-03 20:29:47 +0000 | [diff] [blame] | 117 | * Instead use Canvas' writePixels method. |
bsalomon@google.com | d58a1cd | 2011-11-10 20:57:43 +0000 | [diff] [blame] | 118 | * |
bungeman@google.com | 88edf1e | 2011-08-08 19:41:56 +0000 | [diff] [blame] | 119 | * Similar to draw sprite, this method will copy the pixels in bitmap onto |
| 120 | * the device, with the top/left corner specified by (x, y). The pixel |
| 121 | * values in the device are completely replaced: there is no blending. |
bsalomon@google.com | d58a1cd | 2011-11-10 20:57:43 +0000 | [diff] [blame] | 122 | * |
| 123 | * Currently if bitmap is backed by a texture this is a no-op. This may be |
| 124 | * relaxed in the future. |
| 125 | * |
| 126 | * If the bitmap has config kARGB_8888_Config then the config8888 param |
| 127 | * will determines how the pixel valuess are intepreted. If the bitmap is |
| 128 | * not kARGB_8888_Config then this parameter is ignored. |
bsalomon@google.com | 398109c | 2011-04-14 18:40:27 +0000 | [diff] [blame] | 129 | */ |
bsalomon@google.com | d58a1cd | 2011-11-10 20:57:43 +0000 | [diff] [blame] | 130 | virtual void writePixels(const SkBitmap& bitmap, int x, int y, |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 131 | SkCanvas::Config8888 config8888 = SkCanvas::kNative_Premul_Config8888) = 0; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 132 | |
bsalomon@google.com | d9f826c | 2011-07-18 15:25:04 +0000 | [diff] [blame] | 133 | /** |
| 134 | * Return the device's associated gpu render target, or NULL. |
reed@android.com | f2b98d6 | 2010-12-20 18:26:13 +0000 | [diff] [blame] | 135 | */ |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 136 | virtual GrRenderTarget* accessRenderTarget() = 0; |
reed@android.com | f2b98d6 | 2010-12-20 18:26:13 +0000 | [diff] [blame] | 137 | |
bungeman@google.com | 88edf1e | 2011-08-08 19:41:56 +0000 | [diff] [blame] | 138 | |
| 139 | /** |
| 140 | * Return the device's origin: its offset in device coordinates from |
| 141 | * the default origin in its canvas' matrix/clip |
| 142 | */ |
| 143 | const SkIPoint& getOrigin() const { return fOrigin; } |
| 144 | |
rmistry@google.com | fbfcd56 | 2012-08-23 18:09:54 +0000 | [diff] [blame] | 145 | /** |
robertphillips@google.com | 40a1ae4 | 2012-07-13 15:36:15 +0000 | [diff] [blame] | 146 | * onAttachToCanvas is invoked whenever a device is installed in a canvas |
| 147 | * (i.e., setDevice, saveLayer (for the new device created by the save), |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 148 | * and SkCanvas' SkBaseDevice & SkBitmap -taking ctors). It allows the |
robertphillips@google.com | 40a1ae4 | 2012-07-13 15:36:15 +0000 | [diff] [blame] | 149 | * devices to prepare for drawing (e.g., locking their pixels, etc.) |
| 150 | */ |
sugoi@google.com | e0e385c | 2013-03-11 18:50:03 +0000 | [diff] [blame] | 151 | virtual void onAttachToCanvas(SkCanvas*) { |
bsalomon@google.com | 405d0f4 | 2012-08-29 21:26:13 +0000 | [diff] [blame] | 152 | SkASSERT(!fAttachedToCanvas); |
robertphillips@google.com | 40a1ae4 | 2012-07-13 15:36:15 +0000 | [diff] [blame] | 153 | this->lockPixels(); |
| 154 | #ifdef SK_DEBUG |
| 155 | fAttachedToCanvas = true; |
| 156 | #endif |
| 157 | }; |
| 158 | |
| 159 | /** |
| 160 | * onDetachFromCanvas notifies a device that it will no longer be drawn to. |
| 161 | * It gives the device a chance to clean up (e.g., unlock its pixels). It |
rmistry@google.com | fbfcd56 | 2012-08-23 18:09:54 +0000 | [diff] [blame] | 162 | * is invoked from setDevice (for the displaced device), restore and |
robertphillips@google.com | 40a1ae4 | 2012-07-13 15:36:15 +0000 | [diff] [blame] | 163 | * possibly from SkCanvas' dtor. |
| 164 | */ |
| 165 | virtual void onDetachFromCanvas() { |
bsalomon@google.com | 405d0f4 | 2012-08-29 21:26:13 +0000 | [diff] [blame] | 166 | SkASSERT(fAttachedToCanvas); |
robertphillips@google.com | 40a1ae4 | 2012-07-13 15:36:15 +0000 | [diff] [blame] | 167 | this->unlockPixels(); |
| 168 | #ifdef SK_DEBUG |
| 169 | fAttachedToCanvas = false; |
| 170 | #endif |
| 171 | }; |
| 172 | |
caryclark@google.com | d53f7c2 | 2012-01-05 17:05:05 +0000 | [diff] [blame] | 173 | protected: |
| 174 | enum Usage { |
| 175 | kGeneral_Usage, |
tomhudson@google.com | 1f90287 | 2012-06-01 13:15:47 +0000 | [diff] [blame] | 176 | kSaveLayer_Usage // <! internal use only |
caryclark@google.com | d53f7c2 | 2012-01-05 17:05:05 +0000 | [diff] [blame] | 177 | }; |
| 178 | |
bungeman@google.com | 88edf1e | 2011-08-08 19:41:56 +0000 | [diff] [blame] | 179 | struct TextFlags { |
| 180 | uint32_t fFlags; // SkPaint::getFlags() |
| 181 | SkPaint::Hinting fHinting; |
| 182 | }; |
| 183 | |
| 184 | /** |
| 185 | * Device may filter the text flags for drawing text here. If it wants to |
| 186 | * make a change to the specified values, it should write them into the |
| 187 | * textflags parameter (output) and return true. If the paint is fine as |
| 188 | * is, then ignore the textflags parameter and return false. |
| 189 | * |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 190 | * The baseclass SkBaseDevice filters based on its depth and blitters. |
bungeman@google.com | 88edf1e | 2011-08-08 19:41:56 +0000 | [diff] [blame] | 191 | */ |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 192 | virtual bool filterTextFlags(const SkPaint& paint, TextFlags*) = 0; |
bungeman@google.com | 88edf1e | 2011-08-08 19:41:56 +0000 | [diff] [blame] | 193 | |
robertphillips@google.com | 3fffb2e | 2012-10-09 22:30:18 +0000 | [diff] [blame] | 194 | /** |
bsalomon@google.com | a6926b1 | 2012-10-10 15:25:50 +0000 | [diff] [blame] | 195 | * |
| 196 | * DEPRECATED: This will be removed in a future change. Device subclasses |
| 197 | * should use the matrix and clip from the SkDraw passed to draw functions. |
| 198 | * |
robertphillips@google.com | 3fffb2e | 2012-10-09 22:30:18 +0000 | [diff] [blame] | 199 | * Called with the correct matrix and clip before this device is drawn |
| 200 | * to using those settings. If your subclass overrides this, be sure to |
| 201 | * call through to the base class as well. |
| 202 | * |
| 203 | * The clipstack is another view of the clip. It records the actual |
| 204 | * geometry that went into building the region. It is present for devices |
| 205 | * that want to parse it, but is not required: the region is a complete |
| 206 | * picture of the current clip. (i.e. if you regionize all of the geometry |
| 207 | * in the clipstack, you will arrive at an equivalent region to the one |
| 208 | * passed in). |
bsalomon@google.com | a6926b1 | 2012-10-10 15:25:50 +0000 | [diff] [blame] | 209 | */ |
| 210 | virtual void setMatrixClip(const SkMatrix&, const SkRegion&, |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 211 | const SkClipStack&) {}; |
robertphillips@google.com | 3fffb2e | 2012-10-09 22:30:18 +0000 | [diff] [blame] | 212 | |
bungeman@google.com | 88edf1e | 2011-08-08 19:41:56 +0000 | [diff] [blame] | 213 | /** Clears the entire device to the specified color (including alpha). |
| 214 | * Ignores the clip. |
reed@android.com | f2b98d6 | 2010-12-20 18:26:13 +0000 | [diff] [blame] | 215 | */ |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 216 | virtual void clear(SkColor color) = 0; |
reed@android.com | f2b98d6 | 2010-12-20 18:26:13 +0000 | [diff] [blame] | 217 | |
tfarina@chromium.org | 62f1048 | 2014-01-15 00:19:21 +0000 | [diff] [blame] | 218 | SK_ATTR_DEPRECATED("use clear() instead") |
bungeman@google.com | 88edf1e | 2011-08-08 19:41:56 +0000 | [diff] [blame] | 219 | void eraseColor(SkColor eraseColor) { this->clear(eraseColor); } |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 220 | |
| 221 | /** These are called inside the per-device-layer loop for each draw call. |
| 222 | When these are called, we have already applied any saveLayer operations, |
| 223 | and are handling any looping from the paint, and any effects from the |
| 224 | DrawFilter. |
| 225 | */ |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 226 | virtual void drawPaint(const SkDraw&, const SkPaint& paint) = 0; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 227 | virtual void drawPoints(const SkDraw&, SkCanvas::PointMode mode, size_t count, |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 228 | const SkPoint[], const SkPaint& paint) = 0; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 229 | virtual void drawRect(const SkDraw&, const SkRect& r, |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 230 | const SkPaint& paint) = 0; |
jvanverth@google.com | 46d3d39 | 2013-01-22 13:34:01 +0000 | [diff] [blame] | 231 | virtual void drawOval(const SkDraw&, const SkRect& oval, |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 232 | const SkPaint& paint) = 0; |
commit-bot@chromium.org | f2bfd54 | 2013-04-25 15:27:00 +0000 | [diff] [blame] | 233 | virtual void drawRRect(const SkDraw&, const SkRRect& rr, |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 234 | const SkPaint& paint) = 0; |
commit-bot@chromium.org | f2bfd54 | 2013-04-25 15:27:00 +0000 | [diff] [blame] | 235 | |
reed@google.com | 7ff8d81 | 2011-03-25 15:08:16 +0000 | [diff] [blame] | 236 | /** |
| 237 | * If pathIsMutable, then the implementation is allowed to cast path to a |
| 238 | * non-const pointer and modify it in place (as an optimization). Canvas |
| 239 | * may do this to implement helpers such as drawOval, by placing a temp |
| 240 | * path on the stack to hold the representation of the oval. |
| 241 | * |
| 242 | * If prePathMatrix is not null, it should logically be applied before any |
| 243 | * stroking or other effects. If there are no effects on the paint that |
| 244 | * affect the geometry/rasterization, then the pre matrix can just be |
| 245 | * pre-concated with the current matrix. |
| 246 | */ |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 247 | virtual void drawPath(const SkDraw&, const SkPath& path, |
reed@android.com | f2b98d6 | 2010-12-20 18:26:13 +0000 | [diff] [blame] | 248 | const SkPaint& paint, |
| 249 | const SkMatrix* prePathMatrix = NULL, |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 250 | bool pathIsMutable = false) = 0; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 251 | virtual void drawBitmap(const SkDraw&, const SkBitmap& bitmap, |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 252 | const SkMatrix& matrix, const SkPaint& paint) = 0; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 253 | virtual void drawSprite(const SkDraw&, const SkBitmap& bitmap, |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 254 | int x, int y, const SkPaint& paint) = 0; |
reed@google.com | 33535f3 | 2012-09-25 15:37:50 +0000 | [diff] [blame] | 255 | |
| 256 | /** |
| 257 | * The default impl. will create a bitmap-shader from the bitmap, |
| 258 | * and call drawRect with it. |
| 259 | */ |
| 260 | virtual void drawBitmapRect(const SkDraw&, const SkBitmap&, |
| 261 | const SkRect* srcOrNull, const SkRect& dst, |
commit-bot@chromium.org | eed779d | 2013-08-16 10:24:37 +0000 | [diff] [blame] | 262 | const SkPaint& paint, |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 263 | SkCanvas::DrawBitmapRectFlags flags) = 0; |
reed@google.com | 33535f3 | 2012-09-25 15:37:50 +0000 | [diff] [blame] | 264 | |
bungeman@google.com | 52c748b | 2011-08-22 21:30:43 +0000 | [diff] [blame] | 265 | /** |
| 266 | * Does not handle text decoration. |
| 267 | * Decorations (underline and stike-thru) will be handled by SkCanvas. |
| 268 | */ |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 269 | virtual void drawText(const SkDraw&, const void* text, size_t len, |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 270 | SkScalar x, SkScalar y, const SkPaint& paint) = 0; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 271 | virtual void drawPosText(const SkDraw&, const void* text, size_t len, |
| 272 | const SkScalar pos[], SkScalar constY, |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 273 | int scalarsPerPos, const SkPaint& paint) = 0; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 274 | virtual void drawTextOnPath(const SkDraw&, const void* text, size_t len, |
| 275 | const SkPath& path, const SkMatrix* matrix, |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 276 | const SkPaint& paint) = 0; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 277 | virtual void drawVertices(const SkDraw&, SkCanvas::VertexMode, int vertexCount, |
| 278 | const SkPoint verts[], const SkPoint texs[], |
| 279 | const SkColor colors[], SkXfermode* xmode, |
| 280 | const uint16_t indices[], int indexCount, |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 281 | const SkPaint& paint) = 0; |
robertphillips@google.com | 9b051a3 | 2013-08-20 20:06:40 +0000 | [diff] [blame] | 282 | /** The SkDevice passed will be an SkDevice which was returned by a call to |
bungeman@google.com | 88edf1e | 2011-08-08 19:41:56 +0000 | [diff] [blame] | 283 | onCreateCompatibleDevice on this device with kSaveLayer_Usage. |
| 284 | */ |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 285 | virtual void drawDevice(const SkDraw&, SkBaseDevice*, int x, int y, |
| 286 | const SkPaint&) = 0; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 287 | |
bsalomon@google.com | 6850eab | 2011-11-03 20:29:47 +0000 | [diff] [blame] | 288 | /** |
| 289 | * On success (returns true), copy the device pixels into the bitmap. |
| 290 | * On failure, the bitmap parameter is left unchanged and false is |
| 291 | * returned. |
| 292 | * |
| 293 | * The device's pixels are converted to the bitmap's config. The only |
| 294 | * supported config is kARGB_8888_Config, though this is likely to be |
| 295 | * relaxed in the future. The meaning of config kARGB_8888_Config is |
| 296 | * modified by the enum param config8888. The default value interprets |
| 297 | * kARGB_8888_Config as SkPMColor |
| 298 | * |
| 299 | * If the bitmap has pixels already allocated, the device pixels will be |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 300 | * written there. If not, bitmap->allocPixels() will be called |
bsalomon@google.com | 6850eab | 2011-11-03 20:29:47 +0000 | [diff] [blame] | 301 | * automatically. If the bitmap is backed by a texture readPixels will |
| 302 | * fail. |
| 303 | * |
| 304 | * The actual pixels written is the intersection of the device's bounds, |
| 305 | * and the rectangle formed by the bitmap's width,height and the specified |
| 306 | * x,y. If bitmap pixels extend outside of that intersection, they will not |
| 307 | * be modified. |
| 308 | * |
| 309 | * Other failure conditions: |
| 310 | * * If the device is not a raster device (e.g. PDF) then readPixels will |
| 311 | * fail. |
| 312 | * * If bitmap is texture-backed then readPixels will fail. (This may be |
| 313 | * relaxed in the future.) |
| 314 | */ |
| 315 | bool readPixels(SkBitmap* bitmap, |
| 316 | int x, int y, |
| 317 | SkCanvas::Config8888 config8888); |
| 318 | |
reed@google.com | 3636ed5 | 2011-01-25 23:50:57 +0000 | [diff] [blame] | 319 | /////////////////////////////////////////////////////////////////////////// |
| 320 | |
junov@chromium.org | 1f9767c | 2012-02-07 16:27:57 +0000 | [diff] [blame] | 321 | /** Update as needed the pixel value in the bitmap, so that the caller can |
skia.committer@gmail.com | 772c4e6 | 2013-08-30 07:01:34 +0000 | [diff] [blame] | 322 | access the pixels directly. |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 323 | @return The device contents as a bitmap |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 324 | */ |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 325 | virtual const SkBitmap& onAccessBitmap() = 0; |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 326 | |
bsalomon@google.com | c698097 | 2011-11-02 19:57:21 +0000 | [diff] [blame] | 327 | /** |
| 328 | * Implements readPixels API. The caller will ensure that: |
| 329 | * 1. bitmap has pixel config kARGB_8888_Config. |
| 330 | * 2. bitmap has pixels. |
| 331 | * 3. The rectangle (x, y, x + bitmap->width(), y + bitmap->height()) is |
| 332 | * contained in the device bounds. |
bsalomon@google.com | c698097 | 2011-11-02 19:57:21 +0000 | [diff] [blame] | 333 | */ |
bsalomon@google.com | 6850eab | 2011-11-03 20:29:47 +0000 | [diff] [blame] | 334 | virtual bool onReadPixels(const SkBitmap& bitmap, |
| 335 | int x, int y, |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 336 | SkCanvas::Config8888 config8888) = 0; |
reed@android.com | f2b98d6 | 2010-12-20 18:26:13 +0000 | [diff] [blame] | 337 | |
robertphillips@google.com | 07f81a5 | 2013-09-17 12:26:23 +0000 | [diff] [blame] | 338 | /** Called when this device is installed into a Canvas. Balanced by a call |
bungeman@google.com | 88edf1e | 2011-08-08 19:41:56 +0000 | [diff] [blame] | 339 | to unlockPixels() when the device is removed from a Canvas. |
| 340 | */ |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 341 | virtual void lockPixels() = 0; |
| 342 | virtual void unlockPixels() = 0; |
bungeman@google.com | 88edf1e | 2011-08-08 19:41:56 +0000 | [diff] [blame] | 343 | |
reed@google.com | 76dd277 | 2012-01-05 21:15:07 +0000 | [diff] [blame] | 344 | /** |
reed@google.com | b55deeb | 2012-01-06 14:43:09 +0000 | [diff] [blame] | 345 | * Returns true if the device allows processing of this imagefilter. If |
| 346 | * false is returned, then the filter is ignored. This may happen for |
| 347 | * some subclasses that do not support pixel manipulations after drawing |
| 348 | * has occurred (e.g. printing). The default implementation returns true. |
| 349 | */ |
commit-bot@chromium.org | ae761f7 | 2014-02-05 22:32:02 +0000 | [diff] [blame] | 350 | virtual bool allowImageFilter(const SkImageFilter*) = 0; |
reed@google.com | b55deeb | 2012-01-06 14:43:09 +0000 | [diff] [blame] | 351 | |
| 352 | /** |
reed@google.com | 8926b16 | 2012-03-23 15:36:36 +0000 | [diff] [blame] | 353 | * Override and return true for filters that the device can handle |
| 354 | * intrinsically. Doing so means that SkCanvas will pass-through this |
| 355 | * filter to drawSprite and drawDevice (and potentially filterImage). |
| 356 | * Returning false means the SkCanvas will have apply the filter itself, |
| 357 | * and just pass the resulting image to the device. |
reed@google.com | 76dd277 | 2012-01-05 21:15:07 +0000 | [diff] [blame] | 358 | */ |
commit-bot@chromium.org | ae761f7 | 2014-02-05 22:32:02 +0000 | [diff] [blame] | 359 | virtual bool canHandleImageFilter(const SkImageFilter*) = 0; |
reed@google.com | 8926b16 | 2012-03-23 15:36:36 +0000 | [diff] [blame] | 360 | |
| 361 | /** |
| 362 | * Related (but not required) to canHandleImageFilter, this method returns |
| 363 | * true if the device could apply the filter to the src bitmap and return |
| 364 | * the result (and updates offset as needed). |
| 365 | * If the device does not recognize or support this filter, |
| 366 | * it just returns false and leaves result and offset unchanged. |
| 367 | */ |
commit-bot@chromium.org | ae761f7 | 2014-02-05 22:32:02 +0000 | [diff] [blame] | 368 | virtual bool filterImage(const SkImageFilter*, const SkBitmap&, const SkMatrix&, |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 369 | SkBitmap* result, SkIPoint* offset) = 0; |
robertphillips@google.com | 9b051a3 | 2013-08-20 20:06:40 +0000 | [diff] [blame] | 370 | |
| 371 | // This is equal kBGRA_Premul_Config8888 or kRGBA_Premul_Config8888 if |
| 372 | // either is identical to kNative_Premul_Config8888. Otherwise, -1. |
| 373 | static const SkCanvas::Config8888 kPMColorAlias; |
bsalomon@google.com | 6850eab | 2011-11-03 20:29:47 +0000 | [diff] [blame] | 374 | |
commit-bot@chromium.org | 8128d8c | 2013-12-19 16:12:25 +0000 | [diff] [blame] | 375 | protected: |
reed@google.com | 76f10a3 | 2014-02-05 15:32:21 +0000 | [diff] [blame] | 376 | // default impl returns NULL |
| 377 | virtual SkSurface* newSurface(const SkImageInfo&); |
commit-bot@chromium.org | c3bd8af | 2014-02-13 17:14:46 +0000 | [diff] [blame^] | 378 | |
| 379 | // default impl returns NULL |
| 380 | virtual const void* peekPixels(SkImageInfo*, size_t* rowBytes); |
| 381 | |
commit-bot@chromium.org | 8128d8c | 2013-12-19 16:12:25 +0000 | [diff] [blame] | 382 | /** |
| 383 | * Leaky properties are those which the device should be applying but it isn't. |
| 384 | * These properties will be applied by the draw, when and as it can. |
| 385 | * If the device does handle a property, that property should be set to the identity value |
| 386 | * for that property, effectively making it non-leaky. |
| 387 | */ |
| 388 | SkDeviceProperties fLeakyProperties; |
| 389 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 390 | private: |
reed@google.com | 6f8f292 | 2011-03-04 22:27:10 +0000 | [diff] [blame] | 391 | friend class SkCanvas; |
robertphillips@google.com | 3fffb2e | 2012-10-09 22:30:18 +0000 | [diff] [blame] | 392 | friend struct DeviceCM; //for setMatrixClip |
bungeman@google.com | 88edf1e | 2011-08-08 19:41:56 +0000 | [diff] [blame] | 393 | friend class SkDraw; |
| 394 | friend class SkDrawIter; |
| 395 | friend class SkDeviceFilteredPaint; |
senorblanco@chromium.org | 9c39744 | 2012-09-27 21:57:45 +0000 | [diff] [blame] | 396 | friend class SkDeviceImageFilterProxy; |
reed@google.com | 76f10a3 | 2014-02-05 15:32:21 +0000 | [diff] [blame] | 397 | friend class DeferredDevice; // for newSurface |
bungeman@google.com | 88edf1e | 2011-08-08 19:41:56 +0000 | [diff] [blame] | 398 | |
reed@google.com | 97af1a6 | 2012-08-28 12:19:02 +0000 | [diff] [blame] | 399 | friend class SkSurface_Raster; |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 400 | |
reed@google.com | 97af1a6 | 2012-08-28 12:19:02 +0000 | [diff] [blame] | 401 | // used to change the backend's pixels (and possibly config/rowbytes) |
| 402 | // but cannot change the width/height, so there should be no change to |
| 403 | // any clip information. |
reed@google.com | ec3ca87 | 2013-11-13 16:02:18 +0000 | [diff] [blame] | 404 | // TODO: move to SkBitmapDevice |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 405 | virtual void replaceBitmapBackendForRasterSurface(const SkBitmap&) = 0; |
robertphillips@google.com | 9b051a3 | 2013-08-20 20:06:40 +0000 | [diff] [blame] | 406 | |
| 407 | // just called by SkCanvas when built as a layer |
| 408 | void setOrigin(int x, int y) { fOrigin.set(x, y); } |
| 409 | // just called by SkCanvas for saveLayer |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 410 | SkBaseDevice* createCompatibleDeviceForSaveLayer(SkBitmap::Config config, |
| 411 | int width, int height, |
| 412 | bool isOpaque); |
reed@google.com | 6f8f292 | 2011-03-04 22:27:10 +0000 | [diff] [blame] | 413 | |
bungeman@google.com | 88edf1e | 2011-08-08 19:41:56 +0000 | [diff] [blame] | 414 | /** |
| 415 | * Subclasses should override this to implement createCompatibleDevice. |
| 416 | */ |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 417 | virtual SkBaseDevice* onCreateCompatibleDevice(SkBitmap::Config config, |
| 418 | int width, int height, |
| 419 | bool isOpaque, |
| 420 | Usage usage) = 0; |
bungeman@google.com | 88edf1e | 2011-08-08 19:41:56 +0000 | [diff] [blame] | 421 | |
| 422 | /** Causes any deferred drawing to the device to be completed. |
| 423 | */ |
robertphillips@google.com | 1f2f338 | 2013-08-29 11:54:56 +0000 | [diff] [blame] | 424 | virtual void flush() = 0; |
bungeman@google.com | 88edf1e | 2011-08-08 19:41:56 +0000 | [diff] [blame] | 425 | |
robertphillips@google.com | 9b051a3 | 2013-08-20 20:06:40 +0000 | [diff] [blame] | 426 | SkIPoint fOrigin; |
| 427 | SkMetaData* fMetaData; |
robertphillips@google.com | 15e9d3e | 2012-06-21 20:25:03 +0000 | [diff] [blame] | 428 | |
robertphillips@google.com | 9b051a3 | 2013-08-20 20:06:40 +0000 | [diff] [blame] | 429 | #ifdef SK_DEBUG |
| 430 | bool fAttachedToCanvas; |
| 431 | #endif |
| 432 | |
| 433 | typedef SkRefCnt INHERITED; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 434 | }; |
| 435 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 436 | #endif |