OLD | NEW |
1 | 1 |
2 /* | 2 /* |
3 * Copyright 2013 Google Inc. | 3 * Copyright 2013 Google Inc. |
4 * | 4 * |
5 * Use of this source code is governed by a BSD-style license that can be | 5 * Use of this source code is governed by a BSD-style license that can be |
6 * found in the LICENSE file. | 6 * found in the LICENSE file. |
7 */ | 7 */ |
8 | 8 |
9 #ifndef SkBitmapDevice_DEFINED | 9 #ifndef SkBitmapDevice_DEFINED |
10 #define SkBitmapDevice_DEFINED | 10 #define SkBitmapDevice_DEFINED |
11 | 11 |
12 #include "SkDevice.h" | 12 #include "SkDevice.h" |
13 | 13 |
14 typedef SkDevice SkBitmapDevice; | 14 /////////////////////////////////////////////////////////////////////////////// |
| 15 class SK_API SkBitmapDevice : public SkBaseDevice { |
| 16 public: |
| 17 SK_DECLARE_INST_COUNT(SkBitmapDevice) |
| 18 |
| 19 /** |
| 20 * Construct a new device with the specified bitmap as its backend. It is |
| 21 * valid for the bitmap to have no pixels associated with it. In that case, |
| 22 * any drawing to this device will have no effect. |
| 23 */ |
| 24 SkBitmapDevice(const SkBitmap& bitmap); |
| 25 |
| 26 /** |
| 27 * Construct a new device with the specified bitmap as its backend. It is |
| 28 * valid for the bitmap to have no pixels associated with it. In that case, |
| 29 * any drawing to this device will have no effect. |
| 30 */ |
| 31 SkBitmapDevice(const SkBitmap& bitmap, const SkDeviceProperties& devicePrope
rties); |
| 32 |
| 33 /** |
| 34 * Create a new raster device and have the pixels be automatically |
| 35 * allocated. The rowBytes of the device will be computed automatically |
| 36 * based on the config and the width. |
| 37 * |
| 38 * @param config The desired config for the pixels. If the request cannot |
| 39 * be met, the closest matching support config will be used
. |
| 40 * @param width width (in pixels) of the device |
| 41 * @param height height (in pixels) of the device |
| 42 * @param isOpaque Set to true if it is known that all of the pixels will |
| 43 * be drawn to opaquely. Used as an accelerator when drawin
g |
| 44 * these pixels to another device. |
| 45 */ |
| 46 SkBitmapDevice(SkBitmap::Config config, int width, int height, bool isOpaque
= false); |
| 47 |
| 48 /** |
| 49 * Create a new raster device and have the pixels be automatically |
| 50 * allocated. The rowBytes of the device will be computed automatically |
| 51 * based on the config and the width. |
| 52 * |
| 53 * @param config The desired config for the pixels. If the request cannot |
| 54 * be met, the closest matching support config will be used
. |
| 55 * @param width width (in pixels) of the device |
| 56 * @param height height (in pixels) of the device |
| 57 * @param isOpaque Set to true if it is known that all of the pixels will |
| 58 * be drawn to opaquely. Used as an accelerator when drawin
g |
| 59 * these pixels to another device. |
| 60 * @param deviceProperties Properties which affect compositing. |
| 61 */ |
| 62 SkBitmapDevice(SkBitmap::Config config, int width, int height, bool isOpaque
, |
| 63 const SkDeviceProperties& deviceProperties); |
| 64 |
| 65 virtual ~SkBitmapDevice(); |
| 66 |
| 67 virtual uint32_t getDeviceCapabilities() SK_OVERRIDE { return 0; } |
| 68 |
| 69 /** Return the width of the device (in pixels). |
| 70 */ |
| 71 virtual int width() const SK_OVERRIDE { return fBitmap.width(); } |
| 72 /** Return the height of the device (in pixels). |
| 73 */ |
| 74 virtual int height() const SK_OVERRIDE { return fBitmap.height(); } |
| 75 |
| 76 /** |
| 77 * Return the bounds of the device in the coordinate space of the root |
| 78 * canvas. The root device will have its top-left at 0,0, but other devices |
| 79 * such as those associated with saveLayer may have a non-zero origin. |
| 80 */ |
| 81 virtual void getGlobalBounds(SkIRect* bounds) const SK_OVERRIDE; |
| 82 |
| 83 /** Returns true if the device's bitmap's config treats every pixels as |
| 84 implicitly opaque. |
| 85 */ |
| 86 virtual bool isOpaque() const SK_OVERRIDE { return fBitmap.isOpaque(); } |
| 87 |
| 88 /** Return the bitmap config of the device's pixels |
| 89 */ |
| 90 virtual SkBitmap::Config config() const SK_OVERRIDE { return fBitmap.getConf
ig(); } |
| 91 |
| 92 /** |
| 93 * DEPRECATED: This will be made protected once WebKit stops using it. |
| 94 * Instead use Canvas' writePixels method. |
| 95 * |
| 96 * Similar to draw sprite, this method will copy the pixels in bitmap onto |
| 97 * the device, with the top/left corner specified by (x, y). The pixel |
| 98 * values in the device are completely replaced: there is no blending. |
| 99 * |
| 100 * Currently if bitmap is backed by a texture this is a no-op. This may be |
| 101 * relaxed in the future. |
| 102 * |
| 103 * If the bitmap has config kARGB_8888_Config then the config8888 param |
| 104 * will determines how the pixel valuess are intepreted. If the bitmap is |
| 105 * not kARGB_8888_Config then this parameter is ignored. |
| 106 */ |
| 107 virtual void writePixels(const SkBitmap& bitmap, int x, int y, |
| 108 SkCanvas::Config8888 config8888) SK_OVERRIDE; |
| 109 |
| 110 /** |
| 111 * Return the device's associated gpu render target, or NULL. |
| 112 */ |
| 113 virtual GrRenderTarget* accessRenderTarget() SK_OVERRIDE { return NULL; } |
| 114 |
| 115 protected: |
| 116 /** |
| 117 * Device may filter the text flags for drawing text here. If it wants to |
| 118 * make a change to the specified values, it should write them into the |
| 119 * textflags parameter (output) and return true. If the paint is fine as |
| 120 * is, then ignore the textflags parameter and return false. |
| 121 * |
| 122 * The baseclass SkDevice filters based on its depth and blitters. |
| 123 */ |
| 124 virtual bool filterTextFlags(const SkPaint& paint, TextFlags*) SK_OVERRIDE; |
| 125 |
| 126 /** Clears the entire device to the specified color (including alpha). |
| 127 * Ignores the clip. |
| 128 */ |
| 129 virtual void clear(SkColor color) SK_OVERRIDE; |
| 130 |
| 131 /** These are called inside the per-device-layer loop for each draw call. |
| 132 When these are called, we have already applied any saveLayer operations, |
| 133 and are handling any looping from the paint, and any effects from the |
| 134 DrawFilter. |
| 135 */ |
| 136 virtual void drawPaint(const SkDraw&, const SkPaint& paint) SK_OVERRIDE; |
| 137 virtual void drawPoints(const SkDraw&, SkCanvas::PointMode mode, size_t coun
t, |
| 138 const SkPoint[], const SkPaint& paint) SK_OVERRIDE; |
| 139 virtual void drawRect(const SkDraw&, const SkRect& r, |
| 140 const SkPaint& paint) SK_OVERRIDE; |
| 141 virtual void drawOval(const SkDraw&, const SkRect& oval, |
| 142 const SkPaint& paint) SK_OVERRIDE; |
| 143 virtual void drawRRect(const SkDraw&, const SkRRect& rr, |
| 144 const SkPaint& paint) SK_OVERRIDE; |
| 145 |
| 146 /** |
| 147 * If pathIsMutable, then the implementation is allowed to cast path to a |
| 148 * non-const pointer and modify it in place (as an optimization). Canvas |
| 149 * may do this to implement helpers such as drawOval, by placing a temp |
| 150 * path on the stack to hold the representation of the oval. |
| 151 * |
| 152 * If prePathMatrix is not null, it should logically be applied before any |
| 153 * stroking or other effects. If there are no effects on the paint that |
| 154 * affect the geometry/rasterization, then the pre matrix can just be |
| 155 * pre-concated with the current matrix. |
| 156 */ |
| 157 virtual void drawPath(const SkDraw&, const SkPath& path, |
| 158 const SkPaint& paint, |
| 159 const SkMatrix* prePathMatrix = NULL, |
| 160 bool pathIsMutable = false) SK_OVERRIDE; |
| 161 virtual void drawBitmap(const SkDraw&, const SkBitmap& bitmap, |
| 162 const SkMatrix& matrix, const SkPaint& paint) SK_OVE
RRIDE; |
| 163 virtual void drawSprite(const SkDraw&, const SkBitmap& bitmap, |
| 164 int x, int y, const SkPaint& paint) SK_OVERRIDE; |
| 165 |
| 166 /** |
| 167 * The default impl. will create a bitmap-shader from the bitmap, |
| 168 * and call drawRect with it. |
| 169 */ |
| 170 virtual void drawBitmapRect(const SkDraw&, const SkBitmap&, |
| 171 const SkRect* srcOrNull, const SkRect& dst, |
| 172 const SkPaint& paint, |
| 173 SkCanvas::DrawBitmapRectFlags flags) SK_OVERRIDE
; |
| 174 |
| 175 /** |
| 176 * Does not handle text decoration. |
| 177 * Decorations (underline and stike-thru) will be handled by SkCanvas. |
| 178 */ |
| 179 virtual void drawText(const SkDraw&, const void* text, size_t len, |
| 180 SkScalar x, SkScalar y, const SkPaint& paint) SK_OVERR
IDE; |
| 181 virtual void drawPosText(const SkDraw&, const void* text, size_t len, |
| 182 const SkScalar pos[], SkScalar constY, |
| 183 int scalarsPerPos, const SkPaint& paint) SK_OVERRID
E; |
| 184 virtual void drawTextOnPath(const SkDraw&, const void* text, size_t len, |
| 185 const SkPath& path, const SkMatrix* matrix, |
| 186 const SkPaint& paint) SK_OVERRIDE; |
| 187 #ifdef SK_BUILD_FOR_ANDROID |
| 188 virtual void drawPosTextOnPath(const SkDraw& draw, const void* text, size_t
len, |
| 189 const SkPoint pos[], const SkPaint& paint, |
| 190 const SkPath& path, const SkMatrix* matrix) S
K_OVERRIDE; |
| 191 #endif |
| 192 virtual void drawVertices(const SkDraw&, SkCanvas::VertexMode, int vertexCou
nt, |
| 193 const SkPoint verts[], const SkPoint texs[], |
| 194 const SkColor colors[], SkXfermode* xmode, |
| 195 const uint16_t indices[], int indexCount, |
| 196 const SkPaint& paint) SK_OVERRIDE; |
| 197 /** The SkBaseDevice passed will be an SkBaseDevice which was returned by a
call to |
| 198 onCreateCompatibleDevice on this device with kSaveLayer_Usage. |
| 199 */ |
| 200 virtual void drawDevice(const SkDraw&, SkBaseDevice*, int x, int y, |
| 201 const SkPaint&) SK_OVERRIDE; |
| 202 |
| 203 /////////////////////////////////////////////////////////////////////////// |
| 204 |
| 205 /** Update as needed the pixel value in the bitmap, so that the caller can |
| 206 access the pixels directly. Note: only the pixels field should be |
| 207 altered. The config/width/height/rowbytes must remain unchanged. |
| 208 @return the device contents as a bitmap |
| 209 */ |
| 210 virtual const SkBitmap& onAccessBitmap() SK_OVERRIDE; |
| 211 |
| 212 SkPixelRef* getPixelRef() const { return fBitmap.pixelRef(); } |
| 213 // just for subclasses, to assign a custom pixelref |
| 214 SkPixelRef* setPixelRef(SkPixelRef* pr, size_t offset) { |
| 215 fBitmap.setPixelRef(pr, offset); |
| 216 return pr; |
| 217 } |
| 218 |
| 219 /** |
| 220 * Implements readPixels API. The caller will ensure that: |
| 221 * 1. bitmap has pixel config kARGB_8888_Config. |
| 222 * 2. bitmap has pixels. |
| 223 * 3. The rectangle (x, y, x + bitmap->width(), y + bitmap->height()) is |
| 224 * contained in the device bounds. |
| 225 */ |
| 226 virtual bool onReadPixels(const SkBitmap& bitmap, |
| 227 int x, int y, |
| 228 SkCanvas::Config8888 config8888) SK_OVERRIDE; |
| 229 |
| 230 /** Called when this device is installed into a Canvas. Balanced by a call |
| 231 to unlockPixels() when the device is removed from a Canvas. |
| 232 */ |
| 233 virtual void lockPixels() SK_OVERRIDE; |
| 234 virtual void unlockPixels() SK_OVERRIDE; |
| 235 |
| 236 /** |
| 237 * Returns true if the device allows processing of this imagefilter. If |
| 238 * false is returned, then the filter is ignored. This may happen for |
| 239 * some subclasses that do not support pixel manipulations after drawing |
| 240 * has occurred (e.g. printing). The default implementation returns true. |
| 241 */ |
| 242 virtual bool allowImageFilter(SkImageFilter*) SK_OVERRIDE; |
| 243 |
| 244 /** |
| 245 * Override and return true for filters that the device can handle |
| 246 * intrinsically. Doing so means that SkCanvas will pass-through this |
| 247 * filter to drawSprite and drawDevice (and potentially filterImage). |
| 248 * Returning false means the SkCanvas will have apply the filter itself, |
| 249 * and just pass the resulting image to the device. |
| 250 */ |
| 251 virtual bool canHandleImageFilter(SkImageFilter*) SK_OVERRIDE; |
| 252 |
| 253 /** |
| 254 * Related (but not required) to canHandleImageFilter, this method returns |
| 255 * true if the device could apply the filter to the src bitmap and return |
| 256 * the result (and updates offset as needed). |
| 257 * If the device does not recognize or support this filter, |
| 258 * it just returns false and leaves result and offset unchanged. |
| 259 */ |
| 260 virtual bool filterImage(SkImageFilter*, const SkBitmap&, const SkMatrix&, |
| 261 SkBitmap* result, SkIPoint* offset) SK_OVERRIDE; |
| 262 |
| 263 private: |
| 264 friend class SkCanvas; |
| 265 friend struct DeviceCM; //for setMatrixClip |
| 266 friend class SkDraw; |
| 267 friend class SkDrawIter; |
| 268 friend class SkDeviceFilteredPaint; |
| 269 friend class SkDeviceImageFilterProxy; |
| 270 |
| 271 friend class SkSurface_Raster; |
| 272 |
| 273 // used to change the backend's pixels (and possibly config/rowbytes) |
| 274 // but cannot change the width/height, so there should be no change to |
| 275 // any clip information. |
| 276 virtual void replaceBitmapBackendForRasterSurface(const SkBitmap&) SK_OVERRI
DE; |
| 277 |
| 278 /** |
| 279 * Subclasses should override this to implement createCompatibleDevice. |
| 280 */ |
| 281 virtual SkBaseDevice* onCreateCompatibleDevice(SkBitmap::Config config, |
| 282 int width, int height, |
| 283 bool isOpaque, |
| 284 Usage usage) SK_OVERRIDE; |
| 285 |
| 286 /** Causes any deferred drawing to the device to be completed. |
| 287 */ |
| 288 virtual void flush() SK_OVERRIDE {} |
| 289 |
| 290 SkBitmap fBitmap; |
| 291 |
| 292 typedef SkBaseDevice INHERITED; |
| 293 }; |
15 | 294 |
16 #endif // SkBitmapDevice_DEFINED | 295 #endif // SkBitmapDevice_DEFINED |
OLD | NEW |