Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1 | #Topic Canvas |
Cary Clark | 137b874 | 2018-05-30 09:21:49 -0400 | [diff] [blame] | 2 | #Alias Canvas_Reference ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3 | |
Cary Clark | e4aa371 | 2017-09-15 02:56:12 -0400 | [diff] [blame] | 4 | #Class SkCanvas |
| 5 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 6 | #Code |
| 7 | #Populate |
| 8 | ## |
| 9 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 10 | Canvas provides an interface for drawing, and how the drawing is clipped and transformed. |
| 11 | Canvas contains a stack of Matrix and Clip values. |
| 12 | |
| 13 | Canvas and Paint together provide the state to draw into Surface or Device. |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 14 | Each Canvas draw call transforms the geometry of the object by the concatenation of all |
| 15 | Matrix values in the stack. The transformed geometry is clipped by the intersection |
| 16 | of all of Clip values in the stack. The Canvas draw calls use Paint to supply drawing |
| 17 | state such as Color, Typeface, text size, stroke width, Shader and so on. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 18 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 19 | To draw to a pixel-based destination, create Raster_Surface or GPU_Surface. |
| 20 | Request Canvas from Surface to obtain the interface to draw. |
| 21 | Canvas generated by Raster_Surface draws to memory visible to the CPU. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 22 | Canvas generated by GPU_Surface uses Vulkan or OpenGL to draw to the GPU. |
| 23 | |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 24 | To draw to a document, obtain Canvas from SVG_Canvas, Document_PDF, or Picture_Recorder. |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 25 | Document based Canvas and other Canvas subclasses reference Device describing the |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 26 | destination. |
| 27 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 28 | Canvas can be constructed to draw to Bitmap without first creating Raster_Surface. |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 29 | This approach may be deprecated in the future. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 30 | |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 31 | Canvas may be created directly when no Surface is required; some Canvas methods |
| 32 | implicitly create Raster_Surface. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 33 | |
| 34 | # ------------------------------------------------------------------------------ |
| 35 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 36 | #Method static std::unique_ptr<SkCanvas> MakeRasterDirect(const SkImageInfo& info, void* pixels, |
| 37 | size_t rowBytes, |
| 38 | const SkSurfaceProps* props = nullptr) |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 39 | #In Constructors |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 40 | #Line # creates from SkImageInfo and Pixel_Storage ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 41 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 42 | |
| 43 | #Example |
| 44 | #Description |
| 45 | Allocates a three by three bitmap, clears it to white, and draws a black pixel |
| 46 | in the center. |
| 47 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 48 | void draw(SkCanvas* ) { |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 49 | SkImageInfo info = SkImageInfo::MakeN32Premul(3, 3); // device aligned, 32 bpp, Premultiplied |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 50 | const size_t minRowBytes = info.minRowBytes(); // bytes used by one bitmap row |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 51 | const size_t size = info.computeMinByteSize(); // bytes used by all rows |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 52 | SkAutoTMalloc<SkPMColor> storage(size); // allocate storage for pixels |
| 53 | SkPMColor* pixels = storage.get(); // get pointer to allocated storage |
| 54 | // create a SkCanvas backed by a raster device, and delete it when the |
| 55 | // function goes out of scope. |
| 56 | std::unique_ptr<SkCanvas> canvas = SkCanvas::MakeRasterDirect(info, pixels, minRowBytes); |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 57 | canvas->clear(SK_ColorWHITE); // white is Unpremultiplied, in ARGB order |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 58 | canvas->flush(); // ensure that pixels are cleared |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 59 | SkPMColor pmWhite = pixels[0]; // the Premultiplied format may vary |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 60 | SkPaint paint; // by default, draws black |
| 61 | canvas->drawPoint(1, 1, paint); // draw in the center |
| 62 | canvas->flush(); // ensure that point was drawn |
| 63 | for (int y = 0; y < info.height(); ++y) { |
| 64 | for (int x = 0; x < info.width(); ++x) { |
| 65 | SkDebugf("%c", *pixels++ == pmWhite ? '-' : 'x'); |
| 66 | } |
| 67 | SkDebugf("\n"); |
| 68 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 69 | } |
| 70 | #StdOut |
| 71 | --- |
| 72 | -x- |
| 73 | --- |
| 74 | ## |
| 75 | ## |
| 76 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 77 | #SeeAlso MakeRasterDirectN32 SkSurface::MakeRasterDirect |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 78 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 79 | ## |
| 80 | |
| 81 | # ------------------------------------------------------------------------------ |
| 82 | |
| 83 | #Method static std::unique_ptr<SkCanvas> MakeRasterDirectN32(int width, int height, SkPMColor* pixels, |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 84 | size_t rowBytes) |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 85 | #In Constructors |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 86 | #Line # creates from image data and Pixel_Storage ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 87 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 88 | |
| 89 | #Example |
| 90 | #Description |
| 91 | Allocates a three by three bitmap, clears it to white, and draws a black pixel |
| 92 | in the center. |
| 93 | ## |
| 94 | void draw(SkCanvas* ) { |
| 95 | const int width = 3; |
| 96 | const int height = 3; |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 97 | SkPMColor pixels[height][width]; // allocate a 3 by 3 Premultiplied bitmap on the stack |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 98 | // create a SkCanvas backed by a raster device, and delete it when the |
| 99 | // function goes out of scope. |
| 100 | std::unique_ptr<SkCanvas> canvas = SkCanvas::MakeRasterDirectN32( |
| 101 | width, |
| 102 | height, |
Cary Clark | bc5697d | 2017-10-04 14:31:33 -0400 | [diff] [blame] | 103 | pixels[0], // top-left of the bitmap |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 104 | sizeof(pixels[0])); // byte width of the each row |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 105 | // write a Premultiplied value for white into all pixels in the bitmap |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 106 | canvas->clear(SK_ColorWHITE); |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 107 | SkPMColor pmWhite = pixels[0][0]; // the Premultiplied format may vary |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 108 | SkPaint paint; // by default, draws black |
| 109 | canvas->drawPoint(1, 1, paint); // draw in the center |
| 110 | canvas->flush(); // ensure that pixels is ready to be read |
| 111 | for (int y = 0; y < height; ++y) { |
| 112 | for (int x = 0; x < width; ++x) { |
| 113 | SkDebugf("%c", pixels[y][x] == pmWhite ? '-' : 'x'); |
| 114 | } |
| 115 | SkDebugf("\n"); |
| 116 | } |
| 117 | } |
| 118 | #StdOut |
| 119 | --- |
| 120 | -x- |
| 121 | --- |
| 122 | ## |
| 123 | ## |
| 124 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 125 | #SeeAlso MakeRasterDirect SkSurface::MakeRasterDirect SkImageInfo::MakeN32Premul |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 126 | |
| 127 | ## |
| 128 | |
| 129 | # ------------------------------------------------------------------------------ |
| 130 | |
| 131 | #Method SkCanvas() |
| 132 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 133 | #Line # creates with no Surface, no dimensions ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 134 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 135 | |
| 136 | #Example |
| 137 | |
| 138 | #Description |
| 139 | Passes a placeholder to a function that requires one. |
| 140 | ## |
| 141 | |
| 142 | #Function |
Mike Reed | 07055a3 | 2018-10-23 13:57:46 -0400 | [diff] [blame] | 143 | static void check_for_rotated_ctm(const SkCanvas* canvas) { |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 144 | const SkMatrix& matrix = canvas->getTotalMatrix(); |
Mike Reed | 07055a3 | 2018-10-23 13:57:46 -0400 | [diff] [blame] | 145 | SkDebugf("rect stays rect is %s\n", matrix.rectStaysRect() ? "true" : "false"); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 146 | } |
| 147 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 148 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 149 | void draw(SkCanvas* canvas) { |
Mike Reed | 07055a3 | 2018-10-23 13:57:46 -0400 | [diff] [blame] | 150 | check_for_rotated_ctm(canvas); |
| 151 | canvas->rotate(30); |
| 152 | check_for_rotated_ctm(canvas); |
| 153 | |
| 154 | SkCanvas defaultCanvas; |
| 155 | check_for_rotated_ctm(&defaultCanvas); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 156 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 157 | |
| 158 | #StdOut |
Mike Reed | 07055a3 | 2018-10-23 13:57:46 -0400 | [diff] [blame] | 159 | rect stays rect is true |
| 160 | rect stays rect is false |
| 161 | rect stays rect is true |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 162 | ## |
| 163 | ## |
| 164 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 165 | #SeeAlso MakeRasterDirect SkRasterHandleAllocator::MakeCanvas SkSurface::getCanvas SkCreateColorSpaceXformCanvas |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 166 | |
| 167 | ## |
| 168 | |
| 169 | # ------------------------------------------------------------------------------ |
| 170 | |
Cary Clark | 73fa972 | 2017-08-29 17:36:51 -0400 | [diff] [blame] | 171 | #Method SkCanvas(int width, int height, const SkSurfaceProps* props = nullptr) |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 172 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 173 | #Line # creates with no Surface, set dimensions, Surface_Properties ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 174 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 175 | |
| 176 | #Example |
| 177 | SkCanvas canvas(10, 20); // 10 units wide, 20 units high |
| 178 | canvas.clipRect(SkRect::MakeXYWH(30, 40, 5, 10)); // clip is outside canvas' device |
| 179 | SkDebugf("canvas %s empty\n", canvas.getDeviceClipBounds().isEmpty() ? "is" : "is not"); |
| 180 | |
| 181 | #StdOut |
| 182 | canvas is empty |
| 183 | ## |
| 184 | ## |
| 185 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 186 | #SeeAlso MakeRasterDirect SkSurfaceProps SkPixelGeometry SkCreateColorSpaceXformCanvas |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 187 | |
| 188 | ## |
| 189 | |
| 190 | # ------------------------------------------------------------------------------ |
| 191 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 192 | #Method explicit SkCanvas(const SkBitmap& bitmap) |
| 193 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 194 | #Line # uses existing Bitmap ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 195 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 196 | |
| 197 | #Example |
| 198 | #Description |
| 199 | The actual output depends on the installed fonts. |
| 200 | ## |
| 201 | SkBitmap bitmap; |
| 202 | // create a bitmap 5 wide and 11 high |
| 203 | bitmap.allocPixels(SkImageInfo::MakeN32Premul(5, 11)); |
| 204 | SkCanvas canvas(bitmap); |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 205 | canvas.clear(SK_ColorWHITE); // white is Unpremultiplied, in ARGB order |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 206 | SkPixmap pixmap; // provides guaranteed access to the drawn pixels |
| 207 | if (!canvas.peekPixels(&pixmap)) { |
| 208 | SkDebugf("peekPixels should never fail.\n"); |
| 209 | } |
Cary Clark | bc5697d | 2017-10-04 14:31:33 -0400 | [diff] [blame] | 210 | const SkPMColor* pixels = pixmap.addr32(); // points to top-left of bitmap |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 211 | SkPMColor pmWhite = pixels[0]; // the Premultiplied format may vary |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 212 | SkPaint paint; // by default, draws black, 12 point text |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 213 | canvas.drawString("!", 1, 10, SkFont(), paint); // 1 char at baseline (1, 10) |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 214 | for (int y = 0; y < bitmap.height(); ++y) { |
| 215 | for (int x = 0; x < bitmap.width(); ++x) { |
| 216 | SkDebugf("%c", *pixels++ == pmWhite ? '-' : 'x'); |
| 217 | } |
| 218 | SkDebugf("\n"); |
| 219 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 220 | ## |
| 221 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 222 | #SeeAlso MakeRasterDirect SkRasterHandleAllocator::MakeCanvas SkSurface::getCanvas SkCreateColorSpaceXformCanvas |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 223 | |
| 224 | ## |
| 225 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 226 | # ------------------------------------------------------------------------------ |
| 227 | |
| 228 | #Method SkCanvas(const SkBitmap& bitmap, const SkSurfaceProps& props) |
| 229 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 230 | #Line # uses existing Bitmap and Surface_Properties ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 231 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 232 | |
| 233 | #Example |
| 234 | #Description |
| 235 | The actual output depends on the installed fonts. |
| 236 | ## |
| 237 | SkBitmap bitmap; |
| 238 | // create a bitmap 5 wide and 11 high |
| 239 | bitmap.allocPixels(SkImageInfo::MakeN32Premul(5, 11)); |
| 240 | SkCanvas canvas(bitmap, SkSurfaceProps(0, kUnknown_SkPixelGeometry)); |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 241 | canvas.clear(SK_ColorWHITE); // white is Unpremultiplied, in ARGB order |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 242 | SkPixmap pixmap; // provides guaranteed access to the drawn pixels |
| 243 | if (!canvas.peekPixels(&pixmap)) { |
| 244 | SkDebugf("peekPixels should never fail.\n"); |
| 245 | } |
Cary Clark | bc5697d | 2017-10-04 14:31:33 -0400 | [diff] [blame] | 246 | const SkPMColor* pixels = pixmap.addr32(); // points to top-left of bitmap |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 247 | SkPMColor pmWhite = pixels[0]; // the Premultiplied format may vary |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 248 | SkPaint paint; // by default, draws black, 12 point text |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 249 | canvas.drawString("!", 1, 10, SkFont(), paint); // 1 char at baseline (1, 10) |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 250 | for (int y = 0; y < bitmap.height(); ++y) { |
| 251 | for (int x = 0; x < bitmap.width(); ++x) { |
| 252 | SkDebugf("%c", *pixels++ == pmWhite ? '-' : 'x'); |
| 253 | } |
| 254 | SkDebugf("\n"); |
| 255 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 256 | ## |
| 257 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 258 | #SeeAlso MakeRasterDirect SkRasterHandleAllocator::MakeCanvas SkSurface::getCanvas SkCreateColorSpaceXformCanvas |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 259 | |
| 260 | ## |
| 261 | |
| 262 | # ------------------------------------------------------------------------------ |
| 263 | |
| 264 | #Method virtual ~SkCanvas() |
| 265 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 266 | #Line # draws saved Layers, frees resources ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 267 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 268 | |
| 269 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 270 | #Description |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 271 | Canvas Layer draws into bitmap. saveLayerAlpha sets up an additional |
| 272 | drawing surface that blends with the bitmap. When Layer goes out of |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 273 | scope, Layer destructor is called. The saved Layer is restored, drawing |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 274 | transparent letters. |
| 275 | ## |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 276 | void draw(SkCanvas* canvas) { |
| 277 | SkBitmap bitmap; |
| 278 | bitmap.allocPixels(SkImageInfo::MakeN32Premul(200, 200)); |
| 279 | { |
| 280 | SkCanvas offscreen(bitmap); |
| 281 | SkPaint paint; |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 282 | SkFont font(nullptr, 100); |
| 283 | offscreen.drawString("ABC", 20, 160, font, paint); |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 284 | SkRect layerBounds = SkRect::MakeXYWH(32, 32, 192, 192); |
| 285 | offscreen.saveLayerAlpha(&layerBounds, 128); |
| 286 | offscreen.clear(SK_ColorWHITE); |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 287 | offscreen.drawString("DEF", 20, 160, font, paint); |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 288 | } |
| 289 | canvas->drawBitmap(bitmap, 0, 0, nullptr); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 290 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 291 | ## |
| 292 | |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 293 | #SeeAlso State_Stack |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 294 | |
| 295 | ## |
| 296 | |
| 297 | # ------------------------------------------------------------------------------ |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 298 | #Subtopic Property |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 299 | #Line # metrics and attributes ## |
| 300 | ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 301 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 302 | #Method SkImageInfo imageInfo() const |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 303 | #In Property |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 304 | #Line # returns Image_Info for Canvas ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 305 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 306 | |
| 307 | #Example |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 308 | SkCanvas emptyCanvas; |
| 309 | SkImageInfo canvasInfo = emptyCanvas.imageInfo(); |
| 310 | SkImageInfo emptyInfo; |
| 311 | SkDebugf("emptyInfo %c= canvasInfo\n", emptyInfo == canvasInfo ? '=' : '!'); |
| 312 | |
| 313 | #StdOut |
| 314 | emptyInfo == canvasInfo |
| 315 | ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 316 | ## |
| 317 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 318 | #SeeAlso SkImageInfo MakeRasterDirect makeSurface |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 319 | |
| 320 | ## |
| 321 | |
| 322 | # ------------------------------------------------------------------------------ |
| 323 | |
| 324 | #Method bool getProps(SkSurfaceProps* props) const |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 325 | #In Property |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 326 | #Line # copies Surface_Properties if available ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 327 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 328 | |
| 329 | #Example |
| 330 | SkBitmap bitmap; |
| 331 | SkCanvas canvas(bitmap, SkSurfaceProps(0, kRGB_V_SkPixelGeometry)); |
| 332 | SkSurfaceProps surfaceProps(0, kUnknown_SkPixelGeometry); |
| 333 | SkDebugf("isRGB:%d\n", SkPixelGeometryIsRGB(surfaceProps.pixelGeometry())); |
| 334 | if (!canvas.getProps(&surfaceProps)) { |
| 335 | SkDebugf("getProps failed unexpectedly.\n"); |
| 336 | } |
| 337 | SkDebugf("isRGB:%d\n", SkPixelGeometryIsRGB(surfaceProps.pixelGeometry())); |
| 338 | |
| 339 | #StdOut |
| 340 | isRGB:0 |
| 341 | isRGB:1 |
| 342 | #StdOut ## |
| 343 | ## |
| 344 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 345 | #SeeAlso SkSurfaceProps makeSurface |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 346 | |
| 347 | ## |
| 348 | |
| 349 | # ------------------------------------------------------------------------------ |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 350 | #Subtopic Utility |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 351 | #Line # rarely called management functions ## |
| 352 | ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 353 | |
| 354 | #Method void flush() |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 355 | #In Utility |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 356 | #Line # triggers execution of all pending draw operations ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 357 | #Populate |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 358 | |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 359 | #NoExample |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 360 | ## |
| 361 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 362 | #SeeAlso peekPixels SkSurface::flush GrContext::flush GrContext::abandonContext |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 363 | |
| 364 | ## |
| 365 | |
| 366 | # ------------------------------------------------------------------------------ |
| 367 | |
| 368 | #Method virtual SkISize getBaseLayerSize() const |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 369 | #In Property |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 370 | #Line # returns size of base Layer in global coordinates ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 371 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 372 | |
| 373 | #Example |
| 374 | SkBitmap bitmap; |
| 375 | bitmap.allocPixels(SkImageInfo::MakeN32Premul(20, 30)); |
| 376 | SkCanvas canvas(bitmap, SkSurfaceProps(0, kUnknown_SkPixelGeometry)); |
| 377 | canvas.clipRect(SkRect::MakeWH(10, 40)); |
| 378 | SkIRect clipDeviceBounds = canvas.getDeviceClipBounds(); |
| 379 | if (clipDeviceBounds.isEmpty()) { |
| 380 | SkDebugf("Empty clip bounds is unexpected!\n"); |
| 381 | } |
| 382 | SkDebugf("clip=%d,%d\n", clipDeviceBounds.width(), clipDeviceBounds.height()); |
| 383 | SkISize baseLayerSize = canvas.getBaseLayerSize(); |
| 384 | SkDebugf("size=%d,%d\n", baseLayerSize.width(), baseLayerSize.height()); |
| 385 | |
| 386 | #StdOut |
| 387 | clip=10,30 |
| 388 | size=20,30 |
| 389 | ## |
| 390 | ## |
| 391 | |
| 392 | #ToDo is this the same as the width and height of surface? ## |
| 393 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 394 | #SeeAlso getDeviceClipBounds |
| 395 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 396 | ## |
| 397 | |
| 398 | # ------------------------------------------------------------------------------ |
| 399 | |
| 400 | #Method sk_sp<SkSurface> makeSurface(const SkImageInfo& info, const SkSurfaceProps* props = nullptr) |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 401 | #In Constructors |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 402 | #Line # creates Surface matching SkImageInfo and SkSurfaceProps ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 403 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 404 | |
| 405 | #Example |
| 406 | sk_sp<SkSurface> surface = SkSurface::MakeRasterN32Premul(5, 6); |
| 407 | SkCanvas* smallCanvas = surface->getCanvas(); |
| 408 | SkImageInfo imageInfo = SkImageInfo::MakeN32Premul(3, 4); |
| 409 | sk_sp<SkSurface> compatible = smallCanvas->makeSurface(imageInfo); |
| 410 | SkDebugf("compatible %c= nullptr\n", compatible == nullptr ? '=' : '!'); |
| 411 | SkDebugf("size = %d, %d\n", compatible->width(), compatible->height()); |
| 412 | |
| 413 | #StdOut |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 414 | compatible != nullptr |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 415 | size = 3, 4 |
| 416 | ## |
| 417 | ## |
| 418 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 419 | #SeeAlso SkSurface SkSurface::makeSurface SkImageInfo SkSurfaceProps |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 420 | |
| 421 | ## |
| 422 | |
| 423 | # ------------------------------------------------------------------------------ |
| 424 | |
| 425 | #Method virtual GrContext* getGrContext() |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 426 | #In Property |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 427 | #Line # returns GPU_Context of the GPU_Surface ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 428 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 429 | |
| 430 | #Example |
| 431 | void draw(SkCanvas* canvas) { |
| 432 | if (canvas->getGrContext()) { |
| 433 | canvas->clear(SK_ColorRED); |
| 434 | } else { |
| 435 | canvas->clear(SK_ColorBLUE); |
| 436 | } |
| 437 | } |
| 438 | ## |
| 439 | |
| 440 | #ToDo fiddle should show both CPU and GPU out ## |
| 441 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 442 | #SeeAlso GrContext |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 443 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 444 | ## |
| 445 | |
| 446 | # ------------------------------------------------------------------------------ |
| 447 | |
Cary Clark | 73fa972 | 2017-08-29 17:36:51 -0400 | [diff] [blame] | 448 | #Method void* accessTopLayerPixels(SkImageInfo* info, size_t* rowBytes, SkIPoint* origin = nullptr) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 449 | #In Utility |
| 450 | #In Property |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 451 | #Line # returns writable pixel access if available ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 452 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 453 | |
| 454 | #Example |
| 455 | void draw(SkCanvas* canvas) { |
| 456 | if (canvas->accessTopLayerPixels(nullptr, nullptr)) { |
| 457 | canvas->clear(SK_ColorRED); |
| 458 | } else { |
| 459 | canvas->clear(SK_ColorBLUE); |
| 460 | } |
| 461 | } |
| 462 | ## |
| 463 | |
| 464 | #Example |
| 465 | #Description |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 466 | Draws "ABC" on the device. Then draws "DEF" in Layer, and reads |
| 467 | Layer to add a large dotted "DEF". Finally blends Layer with the |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 468 | device. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 469 | |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 470 | The Layer and blended result appear on the CPU and GPU but the large dotted |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 471 | "DEF" appear only on the CPU. |
| 472 | ## |
| 473 | void draw(SkCanvas* canvas) { |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 474 | SkPaint paint; |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 475 | SkFont font(nullptr, 100); |
| 476 | canvas->drawString("ABC", 20, 160, font, paint); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 477 | SkRect layerBounds = SkRect::MakeXYWH(32, 32, 192, 192); |
| 478 | canvas->saveLayerAlpha(&layerBounds, 128); |
| 479 | canvas->clear(SK_ColorWHITE); |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 480 | canvas->drawString("DEF", 20, 160, font, paint); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 481 | SkImageInfo imageInfo; |
| 482 | size_t rowBytes; |
| 483 | SkIPoint origin; |
| 484 | uint32_t* access = (uint32_t*) canvas->accessTopLayerPixels(&imageInfo, &rowBytes, &origin); |
| 485 | if (access) { |
| 486 | int h = imageInfo.height(); |
| 487 | int v = imageInfo.width(); |
| 488 | int rowWords = rowBytes / sizeof(uint32_t); |
| 489 | for (int y = 0; y < h; ++y) { |
| 490 | int newY = (y - h / 2) * 2 + h / 2; |
| 491 | if (newY < 0 || newY >= h) { |
| 492 | continue; |
| 493 | } |
| 494 | for (int x = 0; x < v; ++x) { |
| 495 | int newX = (x - v / 2) * 2 + v / 2; |
| 496 | if (newX < 0 || newX >= v) { |
| 497 | continue; |
| 498 | } |
| 499 | if (access[y * rowWords + x] == SK_ColorBLACK) { |
| 500 | access[newY * rowWords + newX] = SK_ColorGRAY; |
| 501 | } |
| 502 | } |
| 503 | } |
| 504 | |
| 505 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 506 | canvas->restore(); |
| 507 | } |
| 508 | ## |
| 509 | |
| 510 | #ToDo there are no callers of this that I can find. Deprecate? ## |
| 511 | #ToDo fiddle should show both CPU and GPU out ## |
| 512 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 513 | #SeeAlso SkImageInfo SkPixmap |
| 514 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 515 | ## |
| 516 | |
| 517 | # ------------------------------------------------------------------------------ |
| 518 | |
| 519 | #Method SkRasterHandleAllocator::Handle accessTopRasterHandle() const |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 520 | #In Utility |
| 521 | #In Property |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 522 | #Line # returns context that tracks Clip and Matrix ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 523 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 524 | |
| 525 | #Example |
| 526 | #Description |
| 527 | #ToDo ## |
| 528 | ## |
| 529 | #Function |
| 530 | static void DeleteCallback(void*, void* context) { |
| 531 | delete (char*) context; |
| 532 | } |
| 533 | |
| 534 | class CustomAllocator : public SkRasterHandleAllocator { |
| 535 | public: |
| 536 | bool allocHandle(const SkImageInfo& info, Rec* rec) override { |
| 537 | char* context = new char[4]{'s', 'k', 'i', 'a'}; |
| 538 | rec->fReleaseProc = DeleteCallback; |
| 539 | rec->fReleaseCtx = context; |
| 540 | rec->fHandle = context; |
| 541 | rec->fPixels = context; |
| 542 | rec->fRowBytes = 4; |
| 543 | return true; |
| 544 | } |
| 545 | |
| 546 | void updateHandle(Handle handle, const SkMatrix& ctm, const SkIRect& clip_bounds) override { |
| 547 | // apply canvas matrix and clip to custom environment |
| 548 | } |
| 549 | }; |
| 550 | |
| 551 | ## |
| 552 | void draw(SkCanvas* canvas) { |
| 553 | const SkImageInfo info = SkImageInfo::MakeN32Premul(1, 1); |
| 554 | std::unique_ptr<SkCanvas> c2 = |
| 555 | SkRasterHandleAllocator::MakeCanvas(std::unique_ptr<CustomAllocator>( |
| 556 | new CustomAllocator()), info); |
| 557 | char* context = (char*) c2->accessTopRasterHandle(); |
| 558 | SkDebugf("context = %.4s\n", context); |
| 559 | |
| 560 | } |
| 561 | #StdOut |
| 562 | context = skia |
| 563 | ## |
| 564 | #ToDo skstd::make_unique could not be used because def is private -- note to fix in c++14? ## |
| 565 | ## |
| 566 | |
| 567 | #SeeAlso SkRasterHandleAllocator |
| 568 | |
| 569 | ## |
| 570 | |
| 571 | # ------------------------------------------------------------------------------ |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 572 | #Subtopic Pixels |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 573 | #Line # read and write pixel values ## |
| 574 | ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 575 | |
| 576 | #Method bool peekPixels(SkPixmap* pixmap) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 577 | #In Pixels |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 578 | #Line # returns if Canvas has direct access to its pixels ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 579 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 580 | |
| 581 | #Example |
| 582 | SkPixmap pixmap; |
| 583 | if (canvas->peekPixels(&pixmap)) { |
| 584 | SkDebugf("width=%d height=%d\n", pixmap.bounds().width(), pixmap.bounds().height()); |
| 585 | } |
| 586 | #StdOut |
| 587 | width=256 height=256 |
| 588 | ## |
| 589 | ## |
| 590 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 591 | #SeeAlso readPixels SkBitmap::peekPixels SkImage::peekPixels SkSurface::peekPixels |
| 592 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 593 | ## |
| 594 | |
| 595 | # ------------------------------------------------------------------------------ |
| 596 | |
| 597 | #Method bool readPixels(const SkImageInfo& dstInfo, void* dstPixels, size_t dstRowBytes, |
| 598 | int srcX, int srcY) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 599 | #In Pixels |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 600 | #Line # copies and converts rectangle of pixels from Canvas ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 601 | |
Cary Clark | 154beea | 2017-10-26 07:58:48 -0400 | [diff] [blame] | 602 | Copies Rect of pixels from Canvas into dstPixels. Matrix and Clip are |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 603 | ignored. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 604 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 605 | Source Rect corners are (srcX, srcY) and (imageInfo().width(), imageInfo().height()). |
| 606 | Destination Rect corners are (0, 0) and (dstInfo.width(), dstInfo.height()). |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 607 | Copies each readable pixel intersecting both rectangles, without scaling, |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 608 | converting to dstInfo.colorType() and dstInfo.alphaType() if required. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 609 | |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 610 | Pixels are readable when Device is raster, or backed by a GPU. |
| 611 | Pixels are not readable when SkCanvas is returned by SkDocument::beginPage, |
| 612 | returned by SkPictureRecorder::beginRecording, or Canvas is the base of a utility |
Brian Osman | 46fe9c7 | 2018-03-09 15:44:34 -0500 | [diff] [blame] | 613 | class like SkDebugCanvas. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 614 | |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 615 | The destination pixel storage must be allocated by the caller. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 616 | |
Cary Clark | 2dc84ad | 2018-01-26 12:56:22 -0500 | [diff] [blame] | 617 | Pixel values are converted only if Color_Type and Alpha_Type |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 618 | do not match. Only pixels within both source and destination rectangles |
Cary Clark | 154beea | 2017-10-26 07:58:48 -0400 | [diff] [blame] | 619 | are copied. dstPixels contents outside Rect intersection are unchanged. |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 620 | |
| 621 | Pass negative values for srcX or srcY to offset pixels across or down destination. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 622 | |
| 623 | Does not copy, and returns false if: |
| 624 | |
| 625 | #List |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 626 | # Source and destination rectangles do not intersect. ## |
| 627 | # Canvas pixels could not be converted to dstInfo.colorType() or dstInfo.alphaType(). ## |
| 628 | # Canvas pixels are not readable; for instance, Canvas is document-based. ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 629 | # dstRowBytes is too small to contain one row of pixels. ## |
| 630 | ## |
| 631 | |
Cary Clark | 2dc84ad | 2018-01-26 12:56:22 -0500 | [diff] [blame] | 632 | #Param dstInfo width, height, Color_Type, and Alpha_Type of dstPixels ## |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 633 | #Param dstPixels storage for pixels; dstInfo.height() times dstRowBytes, or larger ## |
| 634 | #Param dstRowBytes size of one destination row; dstInfo.width() times pixel size, or larger ## |
Cary Clark | 5538c13 | 2018-06-14 12:28:14 -0400 | [diff] [blame] | 635 | #Param srcX offset into readable pixels on x-axis; may be negative ## |
| 636 | #Param srcY offset into readable pixels on y-axis; may be negative ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 637 | |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 638 | #Return true if pixels were copied ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 639 | |
| 640 | #Example |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 641 | #Width 64 |
| 642 | #Height 64 |
| 643 | #Description |
| 644 | A black circle drawn on a blue background provides an image to copy. |
| 645 | readPixels copies one quarter of the canvas into each of the four corners. |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 646 | The copied quarter circles overdraw the original circle. |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 647 | ## |
| 648 | canvas->clear(SK_ColorBLUE); |
| 649 | SkPaint paint; |
| 650 | canvas->drawCircle(32, 32, 28, paint); |
| 651 | SkImageInfo info = SkImageInfo::Make(64, 64, kBGRA_8888_SkColorType, kPremul_SkAlphaType); |
| 652 | sk_sp<SkData> data(SkData::MakeUninitialized(info.minRowBytes() * info.height())); |
| 653 | sk_bzero(data->writable_data(), info.minRowBytes() * info.height()); |
| 654 | for (int x : { 32, -32 } ) { |
| 655 | for (int y : { 32, -32 } ) { |
| 656 | canvas->readPixels(info, data->writable_data(), info.minRowBytes(), x, y); |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 657 | } |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 658 | } |
| 659 | sk_sp<SkImage> image = SkImage::MakeRasterData(info, data, info.minRowBytes()); |
| 660 | canvas->drawImage(image, 0, 0); |
| 661 | ## |
| 662 | |
| 663 | #Example |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 664 | #Description |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 665 | Canvas returned by Raster_Surface has Premultiplied pixel values. |
| 666 | clear() takes Unpremultiplied input with Color_Alpha equal 0x80 |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 667 | and RGB equal 0x55, 0xAA, 0xFF. RGB is multiplied by Color_Alpha |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 668 | to generate Premultiplied value 0x802B5580. readPixels converts pixel back |
| 669 | to Unpremultiplied value 0x8056A9FF, introducing error. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 670 | ## |
| 671 | canvas->clear(0x8055aaff); |
| 672 | for (SkAlphaType alphaType : { kPremul_SkAlphaType, kUnpremul_SkAlphaType } ) { |
| 673 | uint32_t pixel = 0; |
| 674 | SkImageInfo info = SkImageInfo::Make(1, 1, kBGRA_8888_SkColorType, alphaType); |
| 675 | if (canvas->readPixels(info, &pixel, 4, 0, 0)) { |
| 676 | SkDebugf("pixel = %08x\n", pixel); |
| 677 | } |
| 678 | } |
| 679 | |
| 680 | #StdOut |
| 681 | pixel = 802b5580 |
| 682 | pixel = 8056a9ff |
| 683 | ## |
| 684 | ## |
| 685 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 686 | #SeeAlso peekPixels writePixels drawBitmap drawImage SkBitmap::readPixels SkPixmap::readPixels SkImage::readPixels SkSurface::readPixels |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 687 | |
| 688 | ## |
| 689 | |
| 690 | # ------------------------------------------------------------------------------ |
| 691 | |
| 692 | #Method bool readPixels(const SkPixmap& pixmap, int srcX, int srcY) |
| 693 | |
Cary Clark | 154beea | 2017-10-26 07:58:48 -0400 | [diff] [blame] | 694 | Copies Rect of pixels from Canvas into pixmap. Matrix and Clip are |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 695 | ignored. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 696 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 697 | Source Rect corners are (srcX, srcY) and (imageInfo().width(), imageInfo().height()). |
| 698 | Destination Rect corners are (0, 0) and (pixmap.width(), pixmap.height()). |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 699 | Copies each readable pixel intersecting both rectangles, without scaling, |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 700 | converting to pixmap.colorType() and pixmap.alphaType() if required. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 701 | |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 702 | Pixels are readable when Device is raster, or backed by a GPU. |
| 703 | Pixels are not readable when SkCanvas is returned by SkDocument::beginPage, |
| 704 | returned by SkPictureRecorder::beginRecording, or Canvas is the base of a utility |
Brian Osman | 46fe9c7 | 2018-03-09 15:44:34 -0500 | [diff] [blame] | 705 | class like SkDebugCanvas. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 706 | |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 707 | Caller must allocate pixel storage in pixmap if needed. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 708 | |
Cary Clark | 2dc84ad | 2018-01-26 12:56:22 -0500 | [diff] [blame] | 709 | Pixel values are converted only if Color_Type and Alpha_Type |
Cary Clark | 154beea | 2017-10-26 07:58:48 -0400 | [diff] [blame] | 710 | do not match. Only pixels within both source and destination Rects |
| 711 | are copied. pixmap pixels contents outside Rect intersection are unchanged. |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 712 | |
| 713 | Pass negative values for srcX or srcY to offset pixels across or down pixmap. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 714 | |
| 715 | Does not copy, and returns false if: |
| 716 | |
| 717 | #List |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 718 | # Source and destination rectangles do not intersect. ## |
| 719 | # Canvas pixels could not be converted to pixmap.colorType() or pixmap.alphaType(). ## |
| 720 | # Canvas pixels are not readable; for instance, Canvas is document-based. ## |
| 721 | # Pixmap pixels could not be allocated. ## |
| 722 | # pixmap.rowBytes() is too small to contain one row of pixels. ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 723 | ## |
| 724 | |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 725 | #Param pixmap storage for pixels copied from Canvas ## |
Cary Clark | 5538c13 | 2018-06-14 12:28:14 -0400 | [diff] [blame] | 726 | #Param srcX offset into readable pixels on x-axis; may be negative ## |
| 727 | #Param srcY offset into readable pixels on y-axis; may be negative ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 728 | |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 729 | #Return true if pixels were copied ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 730 | |
| 731 | #Example |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 732 | #Description |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 733 | clear() takes Unpremultiplied input with Color_Alpha equal 0x80 |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 734 | and RGB equal 0x55, 0xAA, 0xFF. RGB is multiplied by Color_Alpha |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 735 | to generate Premultiplied value 0x802B5580. |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 736 | ## |
| 737 | void draw(SkCanvas* canvas) { |
| 738 | canvas->clear(0x8055aaff); |
| 739 | uint32_t pixels[1] = { 0 }; |
| 740 | SkPixmap pixmap(SkImageInfo::MakeN32Premul(1, 1), pixels, 4); |
| 741 | canvas->readPixels(pixmap, 0, 0); |
| 742 | SkDebugf("pixel = %08x\n", pixels[0]); |
| 743 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 744 | #StdOut |
| 745 | pixel = 802b5580 |
| 746 | ## |
| 747 | ## |
| 748 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 749 | #SeeAlso peekPixels writePixels drawBitmap drawImage SkBitmap::readPixels SkPixmap::readPixels SkImage::readPixels SkSurface::readPixels |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 750 | |
| 751 | ## |
| 752 | |
| 753 | # ------------------------------------------------------------------------------ |
| 754 | |
| 755 | #Method bool readPixels(const SkBitmap& bitmap, int srcX, int srcY) |
| 756 | |
Cary Clark | 154beea | 2017-10-26 07:58:48 -0400 | [diff] [blame] | 757 | Copies Rect of pixels from Canvas into bitmap. Matrix and Clip are |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 758 | ignored. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 759 | |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 760 | Source Rect corners are (srcX, srcY) and (imageInfo().width(), imageInfo().height()). |
Cary Clark | 154beea | 2017-10-26 07:58:48 -0400 | [diff] [blame] | 761 | Destination Rect corners are (0, 0) and (bitmap.width(), bitmap.height()). |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 762 | Copies each readable pixel intersecting both rectangles, without scaling, |
| 763 | converting to bitmap.colorType() and bitmap.alphaType() if required. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 764 | |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 765 | Pixels are readable when Device is raster, or backed by a GPU. |
| 766 | Pixels are not readable when SkCanvas is returned by SkDocument::beginPage, |
| 767 | returned by SkPictureRecorder::beginRecording, or Canvas is the base of a utility |
Brian Osman | 46fe9c7 | 2018-03-09 15:44:34 -0500 | [diff] [blame] | 768 | class like SkDebugCanvas. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 769 | |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 770 | Caller must allocate pixel storage in bitmap if needed. |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 771 | |
Cary Clark | 2dc84ad | 2018-01-26 12:56:22 -0500 | [diff] [blame] | 772 | Bitmap values are converted only if Color_Type and Alpha_Type |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 773 | do not match. Only pixels within both source and destination rectangles |
Cary Clark | 154beea | 2017-10-26 07:58:48 -0400 | [diff] [blame] | 774 | are copied. Bitmap pixels outside Rect intersection are unchanged. |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 775 | |
| 776 | Pass negative values for srcX or srcY to offset pixels across or down bitmap. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 777 | |
| 778 | Does not copy, and returns false if: |
| 779 | |
| 780 | #List |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 781 | # Source and destination rectangles do not intersect. ## |
| 782 | # Canvas pixels could not be converted to bitmap.colorType() or bitmap.alphaType(). ## |
| 783 | # Canvas pixels are not readable; for instance, Canvas is document-based. ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 784 | # bitmap pixels could not be allocated. ## |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 785 | # bitmap.rowBytes() is too small to contain one row of pixels. ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 786 | ## |
| 787 | |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 788 | #Param bitmap storage for pixels copied from Canvas ## |
Cary Clark | 5538c13 | 2018-06-14 12:28:14 -0400 | [diff] [blame] | 789 | #Param srcX offset into readable pixels on x-axis; may be negative ## |
| 790 | #Param srcY offset into readable pixels on y-axis; may be negative ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 791 | |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 792 | #Return true if pixels were copied ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 793 | |
| 794 | #Example |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 795 | #Description |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 796 | clear() takes Unpremultiplied input with Color_Alpha equal 0x80 |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 797 | and RGB equal 0x55, 0xAA, 0xFF. RGB is multiplied by Color_Alpha |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 798 | to generate Premultiplied value 0x802B5580. |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 799 | ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 800 | void draw(SkCanvas* canvas) { |
| 801 | canvas->clear(0x8055aaff); |
| 802 | SkBitmap bitmap; |
| 803 | bitmap.allocPixels(SkImageInfo::MakeN32Premul(1, 1)); |
| 804 | canvas->readPixels(bitmap, 0, 0); |
| 805 | SkDebugf("pixel = %08x\n", bitmap.getAddr32(0, 0)[0]); |
| 806 | } |
| 807 | #StdOut |
| 808 | pixel = 802b5580 |
| 809 | ## |
| 810 | ## |
| 811 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 812 | #SeeAlso peekPixels writePixels drawBitmap drawImage SkBitmap::readPixels SkPixmap::readPixels SkImage::readPixels SkSurface::readPixels |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 813 | |
| 814 | ## |
| 815 | |
| 816 | # ------------------------------------------------------------------------------ |
| 817 | |
| 818 | #Method bool writePixels(const SkImageInfo& info, const void* pixels, size_t rowBytes, int x, int y) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 819 | #In Pixels |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 820 | #Line # copies and converts rectangle of pixels to Canvas ## |
Cary Clark | 154beea | 2017-10-26 07:58:48 -0400 | [diff] [blame] | 821 | Copies Rect from pixels to Canvas. Matrix and Clip are ignored. |
| 822 | Source Rect corners are (0, 0) and (info.width(), info.height()). |
| 823 | Destination Rect corners are (x, y) and |
| 824 | (imageInfo().width(), imageInfo().height()). |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 825 | |
| 826 | Copies each readable pixel intersecting both rectangles, without scaling, |
Cary Clark | 154beea | 2017-10-26 07:58:48 -0400 | [diff] [blame] | 827 | converting to imageInfo().colorType() and imageInfo().alphaType() if required. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 828 | |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 829 | Pixels are writable when Device is raster, or backed by a GPU. |
| 830 | Pixels are not writable when SkCanvas is returned by SkDocument::beginPage, |
| 831 | returned by SkPictureRecorder::beginRecording, or Canvas is the base of a utility |
Brian Osman | 46fe9c7 | 2018-03-09 15:44:34 -0500 | [diff] [blame] | 832 | class like SkDebugCanvas. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 833 | |
Cary Clark | 2dc84ad | 2018-01-26 12:56:22 -0500 | [diff] [blame] | 834 | Pixel values are converted only if Color_Type and Alpha_Type |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 835 | do not match. Only pixels within both source and destination rectangles |
Cary Clark | 154beea | 2017-10-26 07:58:48 -0400 | [diff] [blame] | 836 | are copied. Canvas pixels outside Rect intersection are unchanged. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 837 | |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 838 | Pass negative values for x or y to offset pixels to the left or |
| 839 | above Canvas pixels. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 840 | |
| 841 | Does not copy, and returns false if: |
| 842 | |
| 843 | #List |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 844 | # Source and destination rectangles do not intersect. ## |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 845 | # pixels could not be converted to Canvas imageInfo().colorType() or |
| 846 | imageInfo().alphaType(). ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 847 | # Canvas pixels are not writable; for instance, Canvas is document-based. ## |
| 848 | # rowBytes is too small to contain one row of pixels. ## |
| 849 | ## |
| 850 | |
Cary Clark | 2dc84ad | 2018-01-26 12:56:22 -0500 | [diff] [blame] | 851 | #Param info width, height, Color_Type, and Alpha_Type of pixels ## |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 852 | #Param pixels pixels to copy, of size info.height() times rowBytes, or larger ## |
Cary Clark | d0530ba | 2017-09-14 11:25:39 -0400 | [diff] [blame] | 853 | #Param rowBytes size of one row of pixels; info.width() times pixel size, or larger ## |
Cary Clark | 5538c13 | 2018-06-14 12:28:14 -0400 | [diff] [blame] | 854 | #Param x offset into Canvas writable pixels on x-axis; may be negative ## |
| 855 | #Param y offset into Canvas writable pixels on y-axis; may be negative ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 856 | |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 857 | #Return true if pixels were written to Canvas ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 858 | |
| 859 | #Example |
| 860 | SkImageInfo imageInfo = SkImageInfo::MakeN32(256, 1, kPremul_SkAlphaType); |
| 861 | for (int y = 0; y < 256; ++y) { |
| 862 | uint32_t pixels[256]; |
| 863 | for (int x = 0; x < 256; ++x) { |
| 864 | pixels[x] = SkColorSetARGB(x, x + y, x, x - y); |
| 865 | } |
| 866 | canvas->writePixels(imageInfo, &pixels, sizeof(pixels), 0, y); |
| 867 | } |
| 868 | ## |
| 869 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 870 | #SeeAlso readPixels drawBitmap drawImage SkBitmap::writePixels |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 871 | |
| 872 | ## |
| 873 | |
| 874 | # ------------------------------------------------------------------------------ |
| 875 | |
| 876 | #Method bool writePixels(const SkBitmap& bitmap, int x, int y) |
| 877 | |
Cary Clark | 154beea | 2017-10-26 07:58:48 -0400 | [diff] [blame] | 878 | Copies Rect from pixels to Canvas. Matrix and Clip are ignored. |
| 879 | Source Rect corners are (0, 0) and (bitmap.width(), bitmap.height()). |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 880 | |
Cary Clark | 154beea | 2017-10-26 07:58:48 -0400 | [diff] [blame] | 881 | Destination Rect corners are (x, y) and |
| 882 | (imageInfo().width(), imageInfo().height()). |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 883 | |
| 884 | Copies each readable pixel intersecting both rectangles, without scaling, |
Cary Clark | 154beea | 2017-10-26 07:58:48 -0400 | [diff] [blame] | 885 | converting to imageInfo().colorType() and imageInfo().alphaType() if required. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 886 | |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 887 | Pixels are writable when Device is raster, or backed by a GPU. |
| 888 | Pixels are not writable when SkCanvas is returned by SkDocument::beginPage, |
| 889 | returned by SkPictureRecorder::beginRecording, or Canvas is the base of a utility |
Brian Osman | 46fe9c7 | 2018-03-09 15:44:34 -0500 | [diff] [blame] | 890 | class like SkDebugCanvas. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 891 | |
Cary Clark | 2dc84ad | 2018-01-26 12:56:22 -0500 | [diff] [blame] | 892 | Pixel values are converted only if Color_Type and Alpha_Type |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 893 | do not match. Only pixels within both source and destination rectangles |
Cary Clark | 154beea | 2017-10-26 07:58:48 -0400 | [diff] [blame] | 894 | are copied. Canvas pixels outside Rect intersection are unchanged. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 895 | |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 896 | Pass negative values for x or y to offset pixels to the left or |
| 897 | above Canvas pixels. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 898 | |
| 899 | Does not copy, and returns false if: |
| 900 | |
| 901 | #List |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 902 | # Source and destination rectangles do not intersect. ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 903 | # bitmap does not have allocated pixels. ## |
Cary Clark | ac47b88 | 2018-01-11 10:35:44 -0500 | [diff] [blame] | 904 | # bitmap pixels could not be converted to Canvas imageInfo().colorType() or |
| 905 | imageInfo().alphaType(). ## |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 906 | # Canvas pixels are not writable; for instance, Canvas is document based. ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 907 | # bitmap pixels are inaccessible; for instance, bitmap wraps a texture. ## |
| 908 | ## |
| 909 | |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 910 | #Param bitmap contains pixels copied to Canvas ## |
Cary Clark | f05bdda | 2017-08-24 12:59:48 -0400 | [diff] [blame] | 911 | #Param x offset into Canvas writable pixels in x; may be negative ## |
| 912 | #Param y offset into Canvas writable pixels in y; may be negative ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 913 | |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 914 | #Return true if pixels were written to Canvas ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 915 | |
| 916 | #Example |
| 917 | void draw(SkCanvas* canvas) { |
| 918 | SkImageInfo imageInfo = SkImageInfo::MakeN32Premul(2, 2); |
| 919 | SkBitmap bitmap; |
| 920 | bitmap.setInfo(imageInfo); |
| 921 | uint32_t pixels[4]; |
| 922 | bitmap.setPixels(pixels); |
| 923 | for (int y = 0; y < 256; y += 2) { |
| 924 | for (int x = 0; x < 256; x += 2) { |
| 925 | pixels[0] = SkColorSetRGB(x, y, x | y); |
| 926 | pixels[1] = SkColorSetRGB(x ^ y, y, x); |
| 927 | pixels[2] = SkColorSetRGB(x, x & y, y); |
| 928 | pixels[3] = SkColorSetRGB(~x, ~y, x); |
| 929 | canvas->writePixels(bitmap, x, y); |
| 930 | } |
| 931 | } |
| 932 | } |
| 933 | ## |
| 934 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 935 | #SeeAlso readPixels drawBitmap drawImage SkBitmap::writePixels |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 936 | |
| 937 | ## |
| 938 | |
| 939 | # ------------------------------------------------------------------------------ |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 940 | #Subtopic State_Stack |
| 941 | #Line # stack of state for hierarchical drawing ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 942 | |
| 943 | Canvas maintains a stack of state that allows hierarchical drawing, commonly used |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 944 | to implement windows and views. The initial state has an identity matrix and and |
| 945 | an infinite clip. Even with a wide-open clip, drawing is constrained by the |
| 946 | bounds of the Canvas Surface or Device. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 947 | |
Cary Clark | 939fd6c | 2018-07-12 08:40:13 -0400 | [diff] [blame] | 948 | Canvas savable state consists of Clip and Matrix. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 949 | Clip describes the area that may be drawn to. |
| 950 | Matrix transforms the geometry. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 951 | |
Mike Reed | 9a229e9 | 2019-01-08 10:52:52 -0500 | [diff] [blame] | 952 | save(), saveLayer, and saveLayerAlpha |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 953 | save state and return the depth of the stack. |
| 954 | |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 955 | restore(), restoreToCount, and ~SkCanvas() revert state to its value when saved. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 956 | |
| 957 | Each state on the stack intersects Clip with the previous Clip, |
| 958 | and concatenates Matrix with the previous Matrix. |
| 959 | The intersected Clip makes the drawing area the same or smaller; |
| 960 | the concatenated Matrix may move the origin and potentially scale or rotate |
| 961 | the coordinate space. |
| 962 | |
| 963 | Canvas does not require balancing the state stack but it is a good idea |
| 964 | to do so. Calling save() without restore() will eventually cause Skia to fail; |
| 965 | mismatched save() and restore() create hard to find bugs. |
| 966 | |
| 967 | It is not possible to use state to draw outside of the clip defined by the |
| 968 | previous state. |
| 969 | |
| 970 | #Example |
| 971 | #Description |
| 972 | Draw to ever smaller clips; then restore drawing to full canvas. |
| 973 | Note that the second clipRect is not permitted to enlarge Clip. |
| 974 | ## |
| 975 | #Height 160 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 976 | void draw(SkCanvas* canvas) { |
| 977 | SkPaint paint; |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 978 | canvas->save(); // records stack depth to restore |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 979 | canvas->clipRect(SkRect::MakeWH(100, 100)); // constrains drawing to clip |
| 980 | canvas->clear(SK_ColorRED); // draws to limit of clip |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 981 | canvas->save(); // records stack depth to restore |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 982 | canvas->clipRect(SkRect::MakeWH(50, 150)); // Rect below 100 is ignored |
| 983 | canvas->clear(SK_ColorBLUE); // draws to smaller clip |
| 984 | canvas->restore(); // enlarges clip |
| 985 | canvas->drawLine(20, 20, 150, 150, paint); // line below 100 is not drawn |
| 986 | canvas->restore(); // enlarges clip |
| 987 | canvas->drawLine(150, 20, 50, 120, paint); // line below 100 is drawn |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 988 | } |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 989 | ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 990 | |
| 991 | Each Clip uses the current Matrix for its coordinates. |
| 992 | |
| 993 | #Example |
| 994 | #Description |
| 995 | While clipRect is given the same rectangle twice, Matrix makes the second |
| 996 | clipRect draw at half the size of the first. |
| 997 | ## |
| 998 | #Height 128 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 999 | void draw(SkCanvas* canvas) { |
| 1000 | canvas->clipRect(SkRect::MakeWH(100, 100)); |
| 1001 | canvas->clear(SK_ColorRED); |
| 1002 | canvas->scale(.5, .5); |
| 1003 | canvas->clipRect(SkRect::MakeWH(100, 100)); |
| 1004 | canvas->clear(SK_ColorBLUE); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1005 | } |
| 1006 | ## |
| 1007 | |
Mike Reed | 9a229e9 | 2019-01-08 10:52:52 -0500 | [diff] [blame] | 1008 | #SeeAlso save saveLayer saveLayerAlpha restore() restoreToCount |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1009 | |
| 1010 | #Method int save() |
| 1011 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1012 | #In State_Stack |
| 1013 | #Line # saves Clip and Matrix on stack ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1014 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1015 | |
| 1016 | #Example |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1017 | #Description |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1018 | The black square is translated 50 pixels down and to the right. |
| 1019 | Restoring Canvas state removes translate() from Canvas stack; |
| 1020 | the red square is not translated, and is drawn at the origin. |
| 1021 | ## |
| 1022 | #Height 100 |
| 1023 | void draw(SkCanvas* canvas) { |
| 1024 | SkPaint paint; |
| 1025 | SkRect rect = { 0, 0, 25, 25 }; |
| 1026 | canvas->drawRect(rect, paint); |
| 1027 | canvas->save(); |
| 1028 | canvas->translate(50, 50); |
| 1029 | canvas->drawRect(rect, paint); |
| 1030 | canvas->restore(); |
| 1031 | paint.setColor(SK_ColorRED); |
| 1032 | canvas->drawRect(rect, paint); |
| 1033 | } |
| 1034 | ## |
| 1035 | |
Mike Reed | 9a229e9 | 2019-01-08 10:52:52 -0500 | [diff] [blame] | 1036 | #SeeAlso saveLayer saveLayerAlpha restore restoreToCount |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1037 | |
| 1038 | ## |
| 1039 | |
| 1040 | # ------------------------------------------------------------------------------ |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1041 | |
| 1042 | #Method void restore() |
| 1043 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1044 | #In State_Stack |
| 1045 | #Line # restores changes to Clip and Matrix, pops save stack ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1046 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1047 | |
| 1048 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1049 | void draw(SkCanvas* canvas) { |
| 1050 | SkCanvas simple; |
| 1051 | SkDebugf("depth = %d\n", simple.getSaveCount()); |
| 1052 | simple.restore(); |
| 1053 | SkDebugf("depth = %d\n", simple.getSaveCount()); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1054 | } |
| 1055 | ## |
| 1056 | |
Mike Reed | 9a229e9 | 2019-01-08 10:52:52 -0500 | [diff] [blame] | 1057 | #SeeAlso save saveLayer saveLayerAlpha restoreToCount |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1058 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1059 | ## |
| 1060 | |
| 1061 | # ------------------------------------------------------------------------------ |
| 1062 | |
| 1063 | #Method int getSaveCount() const |
| 1064 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1065 | #In State_Stack |
| 1066 | #Line # returns depth of stack containing Clip and Matrix ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1067 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1068 | |
| 1069 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1070 | void draw(SkCanvas* canvas) { |
| 1071 | SkCanvas simple; |
| 1072 | SkDebugf("depth = %d\n", simple.getSaveCount()); |
| 1073 | simple.save(); |
| 1074 | SkDebugf("depth = %d\n", simple.getSaveCount()); |
| 1075 | simple.restore(); |
| 1076 | SkDebugf("depth = %d\n", simple.getSaveCount()); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1077 | } |
| 1078 | #StdOut |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1079 | depth = 1 |
| 1080 | depth = 2 |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1081 | depth = 1 |
| 1082 | ## |
| 1083 | ## |
| 1084 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1085 | #SeeAlso save restore restoreToCount |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1086 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1087 | ## |
| 1088 | |
| 1089 | # ------------------------------------------------------------------------------ |
| 1090 | |
| 1091 | #Method void restoreToCount(int saveCount) |
| 1092 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1093 | #In State_Stack |
| 1094 | #Line # restores changes to Clip and Matrix to given depth ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1095 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1096 | |
| 1097 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1098 | void draw(SkCanvas* canvas) { |
| 1099 | SkDebugf("depth = %d\n", canvas->getSaveCount()); |
| 1100 | canvas->save(); |
| 1101 | canvas->save(); |
| 1102 | SkDebugf("depth = %d\n", canvas->getSaveCount()); |
| 1103 | canvas->restoreToCount(0); |
| 1104 | SkDebugf("depth = %d\n", canvas->getSaveCount()); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1105 | } |
| 1106 | #StdOut |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1107 | depth = 1 |
| 1108 | depth = 3 |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1109 | depth = 1 |
| 1110 | ## |
| 1111 | ## |
| 1112 | |
Cary Clark | a90ea22 | 2018-10-16 10:30:28 -0400 | [diff] [blame] | 1113 | #SeeAlso restore getSaveCount save |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1114 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1115 | ## |
| 1116 | |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1117 | #Subtopic State_Stack ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1118 | |
| 1119 | # ------------------------------------------------------------------------------ |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1120 | |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1121 | #Subtopic Layer |
Cary Clark | d0530ba | 2017-09-14 11:25:39 -0400 | [diff] [blame] | 1122 | #Substitute layer |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1123 | #Alias Layers |
Cary Clark | 137b874 | 2018-05-30 09:21:49 -0400 | [diff] [blame] | 1124 | #Substitute layers |
| 1125 | ## |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1126 | #Line # temporary Bitmap to draw into ## |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1127 | |
| 1128 | Layer allocates a temporary Bitmap to draw into. When the drawing is |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1129 | complete, the Bitmap is drawn into the Canvas. |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1130 | |
| 1131 | Layer is saved in a stack along with other saved state. When state with a Layer |
| 1132 | is restored, the Bitmap is drawn into the previous Layer. |
| 1133 | |
| 1134 | Layer may be initialized with the contents of the previous Layer. When Layer is |
| 1135 | restored, its Bitmap can be modified by Paint passed to Layer to apply |
| 1136 | Color_Alpha, Color_Filter, Image_Filter, and Blend_Mode. |
| 1137 | |
| 1138 | #Method int saveLayer(const SkRect* bounds, const SkPaint* paint) |
| 1139 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1140 | #In Layer |
| 1141 | #Line # saves Clip and Matrix on stack; creates Layer ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1142 | #Populate |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1143 | |
| 1144 | #Example |
| 1145 | #Description |
| 1146 | Rectangles are blurred by Image_Filter when restore() draws Layer to main |
| 1147 | Canvas. |
| 1148 | ## |
| 1149 | #Height 128 |
Cary Clark | 81abc43 | 2018-06-25 16:30:08 -0400 | [diff] [blame] | 1150 | #Function |
| 1151 | ###$ |
| 1152 | #include "SkBlurImageFilter.h" |
| 1153 | $$$# |
| 1154 | ## |
| 1155 | |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1156 | void draw(SkCanvas* canvas) { |
| 1157 | SkPaint paint, blur; |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1158 | blur.setImageFilter(SkBlurImageFilter::Make(3, 3, nullptr)); |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1159 | canvas->saveLayer(nullptr, &blur); |
| 1160 | SkRect rect = { 25, 25, 50, 50}; |
| 1161 | canvas->drawRect(rect, paint); |
| 1162 | canvas->translate(50, 50); |
| 1163 | paint.setColor(SK_ColorRED); |
| 1164 | canvas->drawRect(rect, paint); |
| 1165 | canvas->restore(); |
| 1166 | } |
| 1167 | ## |
| 1168 | |
Mike Reed | 9a229e9 | 2019-01-08 10:52:52 -0500 | [diff] [blame] | 1169 | #SeeAlso save restore saveLayer saveLayerAlpha SaveLayerRec |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1170 | |
| 1171 | ## |
| 1172 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1173 | #Method int saveLayer(const SkRect& bounds, const SkPaint* paint) |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1174 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1175 | #In Layer |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1176 | #Populate |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1177 | |
| 1178 | #Example |
| 1179 | #Description |
| 1180 | Rectangles are blurred by Image_Filter when restore() draws Layer to main Canvas. |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1181 | The red rectangle is clipped; it does not fully fit on Layer. |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1182 | Image_Filter blurs past edge of Layer so red rectangle is blurred on all sides. |
| 1183 | ## |
| 1184 | #Height 128 |
Cary Clark | 81abc43 | 2018-06-25 16:30:08 -0400 | [diff] [blame] | 1185 | #Function |
| 1186 | ###$ |
| 1187 | #include "SkBlurImageFilter.h" |
| 1188 | $$$# |
| 1189 | ## |
| 1190 | |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1191 | void draw(SkCanvas* canvas) { |
| 1192 | SkPaint paint, blur; |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1193 | blur.setImageFilter(SkBlurImageFilter::Make(3, 3, nullptr)); |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1194 | canvas->saveLayer(SkRect::MakeWH(90, 90), &blur); |
| 1195 | SkRect rect = { 25, 25, 50, 50}; |
| 1196 | canvas->drawRect(rect, paint); |
| 1197 | canvas->translate(50, 50); |
| 1198 | paint.setColor(SK_ColorRED); |
| 1199 | canvas->drawRect(rect, paint); |
| 1200 | canvas->restore(); |
| 1201 | } |
| 1202 | ## |
| 1203 | |
Mike Reed | 9a229e9 | 2019-01-08 10:52:52 -0500 | [diff] [blame] | 1204 | #SeeAlso save restore saveLayerAlpha SaveLayerRec |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1205 | |
| 1206 | ## |
| 1207 | |
| 1208 | #Method int saveLayerAlpha(const SkRect* bounds, U8CPU alpha) |
| 1209 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1210 | #In Layer |
| 1211 | #Line # saves Clip and Matrix on stack; creates Layer; sets opacity ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1212 | #Populate |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1213 | |
| 1214 | #Example |
| 1215 | SkPaint paint; |
| 1216 | paint.setColor(SK_ColorRED); |
| 1217 | canvas->drawCircle(50, 50, 50, paint); |
| 1218 | canvas->saveLayerAlpha(nullptr, 128); |
| 1219 | paint.setColor(SK_ColorBLUE); |
| 1220 | canvas->drawCircle(100, 50, 50, paint); |
| 1221 | paint.setColor(SK_ColorGREEN); |
| 1222 | paint.setAlpha(128); |
| 1223 | canvas->drawCircle(75, 90, 50, paint); |
| 1224 | canvas->restore(); |
| 1225 | ## |
| 1226 | |
Mike Reed | 9a229e9 | 2019-01-08 10:52:52 -0500 | [diff] [blame] | 1227 | #SeeAlso save restore saveLayer SaveLayerRec |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1228 | |
| 1229 | ## |
| 1230 | |
Cary Clark | d98f78c | 2018-04-26 08:32:37 -0400 | [diff] [blame] | 1231 | #Enum SaveLayerFlagsSet |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1232 | #Line # sets SaveLayerRec options ## |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1233 | #Code |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 1234 | #Populate |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1235 | ## |
| 1236 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1237 | |
| 1238 | #Typedef uint32_t SaveLayerFlags |
| 1239 | #Line # options for SaveLayerRec ## |
Cary Clark | 137b874 | 2018-05-30 09:21:49 -0400 | [diff] [blame] | 1240 | ## |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1241 | |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1242 | SaveLayerFlags provides options that may be used in any combination in SaveLayerRec, |
Mike Reed | 9a229e9 | 2019-01-08 10:52:52 -0500 | [diff] [blame] | 1243 | defining how Layer allocated by saveLayer operates. It may be set to zero or |
| 1244 | kInitWithPrevious_SaveLayerFlag. |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1245 | |
| 1246 | #Const kInitWithPrevious_SaveLayerFlag 4 |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1247 | #Line # initializes with previous contents ## |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1248 | Initializes Layer with the contents of the previous Layer. |
| 1249 | ## |
| 1250 | |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1251 | #Example |
| 1252 | #Height 160 |
| 1253 | #Description |
| 1254 | Canvas Layer captures red and blue circles scaled up by four. |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1255 | scalePaint blends Layer back with transparency. |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1256 | ## |
| 1257 | void draw(SkCanvas* canvas) { |
| 1258 | SkPaint redPaint, bluePaint, scalePaint; |
| 1259 | redPaint.setColor(SK_ColorRED); |
| 1260 | canvas->drawCircle(21, 21, 8, redPaint); |
| 1261 | bluePaint.setColor(SK_ColorBLUE); |
| 1262 | canvas->drawCircle(31, 21, 8, bluePaint); |
| 1263 | SkMatrix matrix; |
| 1264 | matrix.setScale(4, 4); |
| 1265 | scalePaint.setAlpha(0x40); |
| 1266 | scalePaint.setImageFilter( |
| 1267 | SkImageFilter::MakeMatrixFilter(matrix, kNone_SkFilterQuality, nullptr)); |
| 1268 | SkCanvas::SaveLayerRec saveLayerRec(nullptr, &scalePaint, |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1269 | SkCanvas::kInitWithPrevious_SaveLayerFlag); |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1270 | canvas->saveLayer(saveLayerRec); |
| 1271 | canvas->restore(); |
| 1272 | } |
| 1273 | ## |
| 1274 | |
Mike Reed | 9a229e9 | 2019-01-08 10:52:52 -0500 | [diff] [blame] | 1275 | #SeeAlso save restore saveLayer saveLayerAlpha SaveLayerRec |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1276 | |
| 1277 | #Enum ## |
| 1278 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1279 | #Subtopic SaveLayerRec |
| 1280 | #Line # contains the state used to create the Layer ## |
Cary Clark | a560c47 | 2017-11-27 10:44:06 -0500 | [diff] [blame] | 1281 | |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1282 | #Struct SaveLayerRec |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1283 | #Line # contains the state used to create the Layer ## |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1284 | |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1285 | #Code |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 1286 | #Populate |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1287 | ## |
| 1288 | |
Cary Clark | 137b874 | 2018-05-30 09:21:49 -0400 | [diff] [blame] | 1289 | SaveLayerRec contains the state used to create the Layer. |
| 1290 | |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1291 | #Member const SkRect* fBounds |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1292 | #Line # hints at Layer size limit ## |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1293 | fBounds is used as a hint to limit the size of Layer; may be nullptr. |
| 1294 | fBounds suggests but does not define Layer size. To clip drawing to |
| 1295 | a specific rectangle, use clipRect. |
| 1296 | ## |
| 1297 | |
| 1298 | #Member const SkPaint* fPaint |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1299 | #Line # modifies overlay ## |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1300 | fPaint modifies how Layer overlays the prior Layer; may be nullptr. |
| 1301 | Color_Alpha, Blend_Mode, Color_Filter, Draw_Looper, Image_Filter, and |
| 1302 | Mask_Filter affect Layer draw. |
| 1303 | ## |
| 1304 | |
| 1305 | #Member const SkImageFilter* fBackdrop |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1306 | #Line # applies Image_Filter to prior Layer ## |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1307 | fBackdrop applies Image_Filter to the prior Layer when copying to the Layer; |
| 1308 | may be nullptr. Use kInitWithPrevious_SaveLayerFlag to copy the |
| 1309 | prior Layer without an Image_Filter. |
| 1310 | ## |
| 1311 | |
| 1312 | #Member const SkImage* fClipMask |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1313 | #Line # clips Layer with Mask_Alpha ## |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1314 | restore() clips Layer by the Color_Alpha channel of fClipMask when |
| 1315 | Layer is copied to Device. fClipMask may be nullptr. . |
| 1316 | ## |
| 1317 | |
| 1318 | #Member const SkMatrix* fClipMatrix |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1319 | #Line # transforms Mask_Alpha used to clip ## |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1320 | fClipMatrix transforms fClipMask before it clips Layer. If |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1321 | fClipMask describes a translucent gradient, it may be scaled and rotated |
| 1322 | without introducing artifacts. fClipMatrix may be nullptr. |
| 1323 | ## |
| 1324 | |
| 1325 | #Member SaveLayerFlags fSaveLayerFlags |
Mike Reed | 9a229e9 | 2019-01-08 10:52:52 -0500 | [diff] [blame] | 1326 | #Line # creates with prior Layer contents ## |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1327 | fSaveLayerFlags are used to create Layer without transparency, |
Mike Reed | 186669c | 2019-02-13 14:26:37 -0500 | [diff] [blame] | 1328 | and to create Layer with the contents of the previous Layer. |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1329 | ## |
| 1330 | |
| 1331 | #Example |
| 1332 | #Height 160 |
| 1333 | #Description |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1334 | Canvas Layer captures a red Anti_Aliased circle and a blue Aliased circle scaled |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1335 | up by four. After drawing another red circle without scaling on top, the Layer is |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1336 | transferred to the main canvas. |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1337 | ## |
| 1338 | void draw(SkCanvas* canvas) { |
| 1339 | SkPaint redPaint, bluePaint; |
| 1340 | redPaint.setAntiAlias(true); |
| 1341 | redPaint.setColor(SK_ColorRED); |
| 1342 | canvas->drawCircle(21, 21, 8, redPaint); |
| 1343 | bluePaint.setColor(SK_ColorBLUE); |
| 1344 | canvas->drawCircle(31, 21, 8, bluePaint); |
| 1345 | SkMatrix matrix; |
| 1346 | matrix.setScale(4, 4); |
| 1347 | auto scaler = SkImageFilter::MakeMatrixFilter(matrix, kNone_SkFilterQuality, nullptr); |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1348 | SkCanvas::SaveLayerRec saveLayerRec(nullptr, nullptr, scaler.get(), 0); |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1349 | canvas->saveLayer(saveLayerRec); |
| 1350 | canvas->drawCircle(125, 85, 8, redPaint); |
| 1351 | canvas->restore(); |
| 1352 | } |
| 1353 | ## |
| 1354 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 1355 | #Subtopic Constructors |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1356 | ## |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1357 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1358 | #Method SaveLayerRec() |
| 1359 | #Line # constructs SaveLayerRec ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1360 | #Populate |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1361 | |
| 1362 | #Example |
| 1363 | SkCanvas::SaveLayerRec rec1; |
Mike Reed | 9a229e9 | 2019-01-08 10:52:52 -0500 | [diff] [blame] | 1364 | rec1.fSaveLayerFlags = SkCanvas::kInitWithPrevious_SaveLayerFlag; |
| 1365 | SkCanvas::SaveLayerRec rec2(nullptr, nullptr, SkCanvas::kInitWithPrevious_SaveLayerFlag); |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1366 | SkDebugf("rec1 %c= rec2\n", rec1.fBounds == rec2.fBounds |
| 1367 | && rec1.fPaint == rec2.fPaint |
| 1368 | && rec1.fBackdrop == rec2.fBackdrop |
| 1369 | && rec1.fSaveLayerFlags == rec2.fSaveLayerFlags ? '=' : '!'); |
| 1370 | #StdOut |
| 1371 | rec1 == rec2 |
| 1372 | ## |
| 1373 | ## |
| 1374 | |
Mike Reed | 9a229e9 | 2019-01-08 10:52:52 -0500 | [diff] [blame] | 1375 | #SeeAlso save restore saveLayer saveLayerAlpha |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1376 | |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1377 | ## |
| 1378 | |
Cary Clark | 224c700 | 2018-06-27 11:00:21 -0400 | [diff] [blame] | 1379 | #Method SaveLayerRec(const SkRect* bounds, const SkPaint* paint, SaveLayerFlags saveLayerFlags = 0) |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1380 | #Populate |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1381 | |
| 1382 | #Example |
| 1383 | SkCanvas::SaveLayerRec rec1; |
| 1384 | SkCanvas::SaveLayerRec rec2(nullptr, nullptr); |
| 1385 | SkDebugf("rec1 %c= rec2\n", rec1.fBounds == rec2.fBounds |
| 1386 | && rec1.fPaint == rec2.fPaint |
| 1387 | && rec1.fBackdrop == rec2.fBackdrop |
| 1388 | && rec1.fSaveLayerFlags == rec2.fSaveLayerFlags ? '=' : '!'); |
| 1389 | #StdOut |
| 1390 | rec1 == rec2 |
| 1391 | ## |
| 1392 | ## |
| 1393 | |
Mike Reed | 9a229e9 | 2019-01-08 10:52:52 -0500 | [diff] [blame] | 1394 | #SeeAlso save restore saveLayer saveLayerAlpha |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1395 | |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1396 | ## |
| 1397 | |
| 1398 | #Method SaveLayerRec(const SkRect* bounds, const SkPaint* paint, const SkImageFilter* backdrop, |
| 1399 | SaveLayerFlags saveLayerFlags) |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1400 | #Populate |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1401 | |
| 1402 | #Example |
| 1403 | SkCanvas::SaveLayerRec rec1; |
| 1404 | SkCanvas::SaveLayerRec rec2(nullptr, nullptr, nullptr, 0); |
| 1405 | SkDebugf("rec1 %c= rec2\n", rec1.fBounds == rec2.fBounds |
| 1406 | && rec1.fPaint == rec2.fPaint |
| 1407 | && rec1.fBackdrop == rec2.fBackdrop |
| 1408 | && rec1.fSaveLayerFlags == rec2.fSaveLayerFlags ? '=' : '!'); |
| 1409 | #StdOut |
| 1410 | rec1 == rec2 |
| 1411 | ## |
| 1412 | ## |
| 1413 | |
Mike Reed | 9a229e9 | 2019-01-08 10:52:52 -0500 | [diff] [blame] | 1414 | #SeeAlso save restore saveLayer saveLayerAlpha |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1415 | |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1416 | ## |
| 1417 | |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1418 | #Struct ## |
| 1419 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 1420 | #Subtopic ## |
| 1421 | |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1422 | #Method int saveLayer(const SaveLayerRec& layerRec) |
| 1423 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1424 | #In Layer |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1425 | #Populate |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1426 | |
| 1427 | #Example |
| 1428 | #Description |
| 1429 | The example draws an image, and saves it into a Layer with kInitWithPrevious_SaveLayerFlag. |
| 1430 | Next it punches a hole in Layer and restore with SkBlendMode::kPlus. |
| 1431 | Where Layer was cleared, the original image will draw unchanged. |
| 1432 | Outside of the circle the mandrill is brightened. |
| 1433 | ## |
| 1434 | #Image 3 |
Hal Canary | c465d13 | 2017-12-08 10:21:31 -0500 | [diff] [blame] | 1435 | // sk_sp<SkImage> image = GetResourceAsImage("images/mandrill_256.png"); |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1436 | canvas->drawImage(image, 0, 0, nullptr); |
| 1437 | SkCanvas::SaveLayerRec rec; |
| 1438 | SkPaint paint; |
| 1439 | paint.setBlendMode(SkBlendMode::kPlus); |
| 1440 | rec.fSaveLayerFlags = SkCanvas::kInitWithPrevious_SaveLayerFlag; |
| 1441 | rec.fPaint = &paint; |
| 1442 | canvas->saveLayer(rec); |
| 1443 | paint.setBlendMode(SkBlendMode::kClear); |
| 1444 | canvas->drawCircle(128, 128, 96, paint); |
| 1445 | canvas->restore(); |
| 1446 | ## |
| 1447 | |
| 1448 | #ToDo above example needs to replace GetResourceAsImage with way to select image in fiddle ## |
| 1449 | |
Mike Reed | 9a229e9 | 2019-01-08 10:52:52 -0500 | [diff] [blame] | 1450 | #SeeAlso save restore saveLayer saveLayerAlpha |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1451 | |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1452 | ## |
| 1453 | |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1454 | #Subtopic Layer ## |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1455 | |
| 1456 | # ------------------------------------------------------------------------------ |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1457 | #Subtopic Matrix |
| 1458 | #Line # coordinate transformation ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1459 | |
| 1460 | #Method void translate(SkScalar dx, SkScalar dy) |
| 1461 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1462 | #In Matrix |
| 1463 | #Line # translates Matrix ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1464 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1465 | |
| 1466 | #Example |
| 1467 | #Height 128 |
| 1468 | #Description |
| 1469 | scale() followed by translate() produces different results from translate() followed |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1470 | by scale(). |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1471 | |
| 1472 | The blue stroke follows translate of (50, 50); a black |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1473 | fill follows scale of (2, 1/2.f). After restoring the clip, which resets |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1474 | Matrix, a red frame follows the same scale of (2, 1/2.f); a gray fill |
| 1475 | follows translate of (50, 50). |
| 1476 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1477 | void draw(SkCanvas* canvas) { |
| 1478 | SkPaint filledPaint; |
| 1479 | SkPaint outlinePaint; |
| 1480 | outlinePaint.setStyle(SkPaint::kStroke_Style); |
| 1481 | outlinePaint.setColor(SK_ColorBLUE); |
| 1482 | canvas->save(); |
| 1483 | canvas->translate(50, 50); |
| 1484 | canvas->drawCircle(28, 28, 15, outlinePaint); // blue center: (50+28, 50+28) |
| 1485 | canvas->scale(2, 1/2.f); |
| 1486 | canvas->drawCircle(28, 28, 15, filledPaint); // black center: (50+(28*2), 50+(28/2)) |
| 1487 | canvas->restore(); |
| 1488 | filledPaint.setColor(SK_ColorGRAY); |
| 1489 | outlinePaint.setColor(SK_ColorRED); |
| 1490 | canvas->scale(2, 1/2.f); |
| 1491 | canvas->drawCircle(28, 28, 15, outlinePaint); // red center: (28*2, 28/2) |
| 1492 | canvas->translate(50, 50); |
| 1493 | canvas->drawCircle(28, 28, 15, filledPaint); // gray center: ((50+28)*2, (50+28)/2) |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1494 | } |
| 1495 | ## |
| 1496 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1497 | #SeeAlso concat() scale() skew() rotate() setMatrix |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1498 | |
| 1499 | ## |
| 1500 | |
| 1501 | # ------------------------------------------------------------------------------ |
| 1502 | |
| 1503 | #Method void scale(SkScalar sx, SkScalar sy) |
| 1504 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1505 | #In Matrix |
| 1506 | #Line # scales Matrix ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1507 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1508 | |
| 1509 | #Example |
| 1510 | #Height 160 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1511 | void draw(SkCanvas* canvas) { |
| 1512 | SkPaint paint; |
| 1513 | SkRect rect = { 10, 20, 60, 120 }; |
| 1514 | canvas->translate(20, 20); |
| 1515 | canvas->drawRect(rect, paint); |
| 1516 | canvas->scale(2, .5f); |
| 1517 | paint.setColor(SK_ColorGRAY); |
| 1518 | canvas->drawRect(rect, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1519 | } |
| 1520 | ## |
| 1521 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1522 | #SeeAlso concat() translate() skew() rotate() setMatrix |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1523 | |
| 1524 | ## |
| 1525 | |
| 1526 | # ------------------------------------------------------------------------------ |
| 1527 | |
| 1528 | #Method void rotate(SkScalar degrees) |
| 1529 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1530 | #In Matrix |
| 1531 | #Line # rotates Matrix ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1532 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1533 | |
| 1534 | #Example |
| 1535 | #Description |
| 1536 | Draw clock hands at time 5:10. The hour hand and minute hand point up and |
| 1537 | are rotated clockwise. |
| 1538 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1539 | void draw(SkCanvas* canvas) { |
| 1540 | SkPaint paint; |
| 1541 | paint.setStyle(SkPaint::kStroke_Style); |
| 1542 | canvas->translate(128, 128); |
| 1543 | canvas->drawCircle(0, 0, 60, paint); |
| 1544 | canvas->save(); |
| 1545 | canvas->rotate(10 * 360 / 60); // 10 minutes of 60 scaled to 360 degrees |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1546 | canvas->drawLine(0, 0, 0, -50, paint); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1547 | canvas->restore(); |
| 1548 | canvas->rotate((5 + 10.f/60) * 360 / 12); // 5 and 10/60 hours of 12 scaled to 360 degrees |
| 1549 | canvas->drawLine(0, 0, 0, -30, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1550 | } |
| 1551 | ## |
| 1552 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1553 | #SeeAlso concat() translate() skew() scale() setMatrix |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1554 | |
| 1555 | ## |
| 1556 | |
| 1557 | # ------------------------------------------------------------------------------ |
| 1558 | |
| 1559 | #Method void rotate(SkScalar degrees, SkScalar px, SkScalar py) |
| 1560 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1561 | #In Matrix |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1562 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1563 | |
| 1564 | #Example |
| 1565 | #Height 192 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1566 | void draw(SkCanvas* canvas) { |
| 1567 | SkPaint paint; |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 1568 | SkFont font(nullptr, 96); |
| 1569 | canvas->drawString("A1", 130, 100, font, paint); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1570 | canvas->rotate(180, 130, 100); |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 1571 | canvas->drawString("A1", 130, 100, font, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1572 | } |
| 1573 | ## |
| 1574 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1575 | #SeeAlso concat() translate() skew() scale() setMatrix |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1576 | |
| 1577 | ## |
| 1578 | |
| 1579 | # ------------------------------------------------------------------------------ |
| 1580 | |
| 1581 | #Method void skew(SkScalar sx, SkScalar sy) |
| 1582 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1583 | #In Matrix |
| 1584 | #Line # skews Matrix ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1585 | #Populate |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1586 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1587 | #Example |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1588 | #Description |
Cary Clark | 5538c13 | 2018-06-14 12:28:14 -0400 | [diff] [blame] | 1589 | Black text mimics an oblique text style by using a negative skew on x-axis |
| 1590 | that shifts the geometry to the right as the y-axis values decrease. |
| 1591 | Red text uses a positive skew on y-axis to shift the geometry down |
| 1592 | as the x-axis values increase. |
| 1593 | Blue text combines sx and sy skew to rotate and scale. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1594 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1595 | SkPaint paint; |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 1596 | SkFont font(nullptr, 128); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1597 | canvas->translate(30, 130); |
| 1598 | canvas->save(); |
| 1599 | canvas->skew(-.5, 0); |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 1600 | canvas->drawString("A1", 0, 0, font, paint); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1601 | canvas->restore(); |
| 1602 | canvas->save(); |
| 1603 | canvas->skew(0, .5); |
| 1604 | paint.setColor(SK_ColorRED); |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 1605 | canvas->drawString("A1", 0, 0, font, paint); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1606 | canvas->restore(); |
| 1607 | canvas->skew(-.5, .5); |
| 1608 | paint.setColor(SK_ColorBLUE); |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 1609 | canvas->drawString("A1", 0, 0, font, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1610 | ## |
| 1611 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1612 | #SeeAlso concat() translate() rotate() scale() setMatrix |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1613 | |
| 1614 | ## |
| 1615 | |
| 1616 | # ------------------------------------------------------------------------------ |
| 1617 | |
| 1618 | #Method void concat(const SkMatrix& matrix) |
| 1619 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1620 | #In Matrix |
| 1621 | #Line # multiplies Matrix by Matrix ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1622 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1623 | |
| 1624 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1625 | void draw(SkCanvas* canvas) { |
| 1626 | SkPaint paint; |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 1627 | SkFont font(nullptr, 80); |
| 1628 | font.setScaleX(.3); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1629 | SkMatrix matrix; |
| 1630 | SkRect rect[2] = {{ 10, 20, 90, 110 }, { 40, 130, 140, 180 }}; |
| 1631 | matrix.setRectToRect(rect[0], rect[1], SkMatrix::kFill_ScaleToFit); |
| 1632 | canvas->drawRect(rect[0], paint); |
| 1633 | canvas->drawRect(rect[1], paint); |
| 1634 | paint.setColor(SK_ColorWHITE); |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 1635 | canvas->drawString("Here", rect[0].fLeft + 10, rect[0].fBottom - 10, font, paint); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1636 | canvas->concat(matrix); |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 1637 | canvas->drawString("There", rect[0].fLeft + 10, rect[0].fBottom - 10, font, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1638 | } |
| 1639 | ## |
| 1640 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1641 | #SeeAlso translate() rotate() scale() skew() setMatrix |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1642 | |
| 1643 | ## |
| 1644 | |
| 1645 | # ------------------------------------------------------------------------------ |
| 1646 | |
| 1647 | #Method void setMatrix(const SkMatrix& matrix) |
| 1648 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1649 | #In Matrix |
| 1650 | #Line # sets Matrix ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1651 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1652 | |
| 1653 | #Example |
| 1654 | #Height 128 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1655 | void draw(SkCanvas* canvas) { |
| 1656 | SkPaint paint; |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 1657 | SkFont font; |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1658 | canvas->scale(4, 6); |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 1659 | canvas->drawString("truth", 2, 10, font, paint); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1660 | SkMatrix matrix; |
| 1661 | matrix.setScale(2.8f, 6); |
| 1662 | canvas->setMatrix(matrix); |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 1663 | canvas->drawString("consequences", 2, 20, font, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1664 | } |
| 1665 | ## |
| 1666 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1667 | #SeeAlso resetMatrix concat() translate() rotate() scale() skew() |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1668 | |
| 1669 | ## |
| 1670 | |
| 1671 | # ------------------------------------------------------------------------------ |
| 1672 | |
| 1673 | #Method void resetMatrix() |
| 1674 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1675 | #In Matrix |
| 1676 | #Line # resets Matrix to identity ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1677 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1678 | |
| 1679 | #Example |
| 1680 | #Height 128 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1681 | void draw(SkCanvas* canvas) { |
| 1682 | SkPaint paint; |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 1683 | SkFont font; |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1684 | canvas->scale(4, 6); |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 1685 | canvas->drawString("truth", 2, 10, font, paint); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1686 | canvas->resetMatrix(); |
| 1687 | canvas->scale(2.8f, 6); |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 1688 | canvas->drawString("consequences", 2, 20, font, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1689 | } |
| 1690 | ## |
| 1691 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1692 | #SeeAlso setMatrix concat() translate() rotate() scale() skew() |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1693 | |
| 1694 | ## |
| 1695 | |
| 1696 | # ------------------------------------------------------------------------------ |
| 1697 | |
| 1698 | #Method const SkMatrix& getTotalMatrix() const |
| 1699 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1700 | #In Matrix |
| 1701 | #Line # returns Matrix ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1702 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1703 | |
| 1704 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1705 | SkDebugf("isIdentity %s\n", canvas->getTotalMatrix().isIdentity() ? "true" : "false"); |
| 1706 | #StdOut |
| 1707 | isIdentity true |
| 1708 | ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1709 | ## |
| 1710 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1711 | #SeeAlso setMatrix resetMatrix concat() |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1712 | |
| 1713 | ## |
| 1714 | |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1715 | #Subtopic Matrix ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1716 | |
| 1717 | # ------------------------------------------------------------------------------ |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 1718 | #Subtopic Clip |
| 1719 | #Line # stack of clipping Paths ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1720 | |
| 1721 | Clip is built from a stack of clipping paths. Each Path in the |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1722 | stack can be constructed from one or more Path_Contour elements. The |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1723 | Path_Contour may be composed of any number of Path_Verb segments. Each |
| 1724 | Path_Contour forms a closed area; Path_Fill_Type defines the area enclosed |
| 1725 | by Path_Contour. |
| 1726 | |
| 1727 | Clip stack of Path elements successfully restrict the Path area. Each |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1728 | Path is transformed by Matrix, then intersected with or subtracted from the |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1729 | prior Clip to form the replacement Clip. Use SkClipOp::kDifference |
| 1730 | to subtract Path from Clip; use SkClipOp::kIntersect to intersect Path |
| 1731 | with Clip. |
| 1732 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1733 | A clipping Path may be Anti_Aliased; if Path, after transformation, is |
| 1734 | composed of horizontal and vertical lines, clearing Anti_Alias allows whole pixels |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1735 | to either be inside or outside the clip. The fastest drawing has a Aliased, |
| 1736 | rectangular clip. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1737 | |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1738 | If clipping Path has Anti_Alias set, clip may partially clip a pixel, requiring |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1739 | that drawing blend partially with the destination along the edge. A rotated |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1740 | rectangular Anti_Aliased clip looks smoother but draws slower. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1741 | |
| 1742 | Clip can combine with Rect and Round_Rect primitives; like |
| 1743 | Path, these are transformed by Matrix before they are combined with Clip. |
| 1744 | |
| 1745 | Clip can combine with Region. Region is assumed to be in Device coordinates |
| 1746 | and is unaffected by Matrix. |
| 1747 | |
| 1748 | #Example |
| 1749 | #Height 90 |
| 1750 | #Description |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1751 | Draw a red circle with an Aliased clip and an Anti_Aliased clip. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1752 | Use an image filter to zoom into the pixels drawn. |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1753 | The edge of the Aliased clip fully draws pixels in the red circle. |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1754 | The edge of the Anti_Aliased clip partially draws pixels in the red circle. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1755 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1756 | SkPaint redPaint, scalePaint; |
| 1757 | redPaint.setAntiAlias(true); |
| 1758 | redPaint.setColor(SK_ColorRED); |
| 1759 | canvas->save(); |
| 1760 | for (bool antialias : { false, true } ) { |
| 1761 | canvas->save(); |
| 1762 | canvas->clipRect(SkRect::MakeWH(19.5f, 11.5f), antialias); |
| 1763 | canvas->drawCircle(17, 11, 8, redPaint); |
| 1764 | canvas->restore(); |
| 1765 | canvas->translate(16, 0); |
| 1766 | } |
| 1767 | canvas->restore(); |
| 1768 | SkMatrix matrix; |
| 1769 | matrix.setScale(6, 6); |
| 1770 | scalePaint.setImageFilter( |
| 1771 | SkImageFilter::MakeMatrixFilter(matrix, kNone_SkFilterQuality, nullptr)); |
| 1772 | SkCanvas::SaveLayerRec saveLayerRec( |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1773 | nullptr, &scalePaint, SkCanvas::kInitWithPrevious_SaveLayerFlag); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1774 | canvas->saveLayer(saveLayerRec); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1775 | canvas->restore(); |
| 1776 | ## |
| 1777 | |
| 1778 | #Method void clipRect(const SkRect& rect, SkClipOp op, bool doAntiAlias) |
| 1779 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1780 | #In Clip |
| 1781 | #Line # combines Clip with Rect ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1782 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1783 | |
| 1784 | #Example |
| 1785 | #Height 128 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1786 | void draw(SkCanvas* canvas) { |
| 1787 | canvas->rotate(10); |
| 1788 | SkPaint paint; |
| 1789 | paint.setAntiAlias(true); |
| 1790 | for (auto alias: { false, true } ) { |
| 1791 | canvas->save(); |
| 1792 | canvas->clipRect(SkRect::MakeWH(90, 80), SkClipOp::kIntersect, alias); |
| 1793 | canvas->drawCircle(100, 60, 60, paint); |
| 1794 | canvas->restore(); |
| 1795 | canvas->translate(80, 0); |
| 1796 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1797 | } |
| 1798 | ## |
| 1799 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1800 | #SeeAlso clipRRect clipPath clipRegion |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1801 | |
| 1802 | ## |
| 1803 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1804 | #Method void clipRect(const SkRect& rect, SkClipOp op) |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1805 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1806 | #In Clip |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1807 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1808 | |
| 1809 | #Example |
| 1810 | #Height 192 |
| 1811 | #Width 280 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1812 | void draw(SkCanvas* canvas) { |
| 1813 | SkPaint paint; |
| 1814 | for (SkClipOp op: { SkClipOp::kIntersect, SkClipOp::kDifference } ) { |
| 1815 | canvas->save(); |
| 1816 | canvas->clipRect(SkRect::MakeWH(90, 120), op, false); |
| 1817 | canvas->drawCircle(100, 100, 60, paint); |
| 1818 | canvas->restore(); |
| 1819 | canvas->translate(80, 0); |
| 1820 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1821 | } |
| 1822 | ## |
| 1823 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1824 | #SeeAlso clipRRect clipPath clipRegion |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1825 | |
| 1826 | ## |
| 1827 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1828 | #Method void clipRect(const SkRect& rect, bool doAntiAlias = false) |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1829 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1830 | #In Clip |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1831 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1832 | |
| 1833 | #Example |
| 1834 | #Height 133 |
| 1835 | #Description |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 1836 | A circle drawn in pieces looks uniform when drawn Aliased. |
Cary Clark | ffb3d68 | 2018-05-17 12:17:28 -0400 | [diff] [blame] | 1837 | The same circle pieces blend with pixels more than once when Anti_Aliased, |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1838 | visible as a thin pair of lines through the right circle. |
| 1839 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1840 | void draw(SkCanvas* canvas) { |
| 1841 | canvas->clear(SK_ColorWHITE); |
| 1842 | SkPaint paint; |
| 1843 | paint.setAntiAlias(true); |
| 1844 | paint.setColor(0x8055aaff); |
| 1845 | SkRect clipRect = { 0, 0, 87.4f, 87.4f }; |
| 1846 | for (auto alias: { false, true } ) { |
| 1847 | canvas->save(); |
| 1848 | canvas->clipRect(clipRect, SkClipOp::kIntersect, alias); |
| 1849 | canvas->drawCircle(67, 67, 60, paint); |
| 1850 | canvas->restore(); |
| 1851 | canvas->save(); |
| 1852 | canvas->clipRect(clipRect, SkClipOp::kDifference, alias); |
| 1853 | canvas->drawCircle(67, 67, 60, paint); |
| 1854 | canvas->restore(); |
| 1855 | canvas->translate(120, 0); |
| 1856 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1857 | } |
| 1858 | ## |
| 1859 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1860 | #SeeAlso clipRRect clipPath clipRegion |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1861 | |
| 1862 | ## |
| 1863 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1864 | #Method void clipRRect(const SkRRect& rrect, SkClipOp op, bool doAntiAlias) |
| 1865 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1866 | #In Clip |
| 1867 | #Line # combines Clip with Round_Rect ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1868 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1869 | |
| 1870 | #Example |
| 1871 | #Height 128 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1872 | void draw(SkCanvas* canvas) { |
| 1873 | canvas->clear(SK_ColorWHITE); |
| 1874 | SkPaint paint; |
| 1875 | paint.setAntiAlias(true); |
| 1876 | paint.setColor(0x8055aaff); |
| 1877 | SkRRect oval; |
| 1878 | oval.setOval({10, 20, 90, 100}); |
| 1879 | canvas->clipRRect(oval, SkClipOp::kIntersect, true); |
| 1880 | canvas->drawCircle(70, 100, 60, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1881 | } |
| 1882 | ## |
| 1883 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1884 | #SeeAlso clipRect clipPath clipRegion |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1885 | |
| 1886 | ## |
| 1887 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1888 | #Method void clipRRect(const SkRRect& rrect, SkClipOp op) |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1889 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1890 | #In Clip |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1891 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1892 | |
| 1893 | #Example |
| 1894 | #Height 128 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1895 | void draw(SkCanvas* canvas) { |
| 1896 | SkPaint paint; |
| 1897 | paint.setColor(0x8055aaff); |
| 1898 | auto oval = SkRRect::MakeOval({10, 20, 90, 100}); |
| 1899 | canvas->clipRRect(oval, SkClipOp::kIntersect); |
| 1900 | canvas->drawCircle(70, 100, 60, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1901 | } |
| 1902 | ## |
| 1903 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1904 | #SeeAlso clipRect clipPath clipRegion |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1905 | |
| 1906 | ## |
| 1907 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1908 | #Method void clipRRect(const SkRRect& rrect, bool doAntiAlias = false) |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1909 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1910 | #In Clip |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1911 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1912 | |
| 1913 | #Example |
| 1914 | #Height 128 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1915 | void draw(SkCanvas* canvas) { |
| 1916 | SkPaint paint; |
| 1917 | paint.setAntiAlias(true); |
| 1918 | auto oval = SkRRect::MakeRectXY({10, 20, 90, 100}, 9, 13); |
| 1919 | canvas->clipRRect(oval, true); |
| 1920 | canvas->drawCircle(70, 100, 60, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1921 | } |
| 1922 | ## |
| 1923 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1924 | #SeeAlso clipRect clipPath clipRegion |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1925 | |
| 1926 | ## |
| 1927 | |
| 1928 | #Method void clipPath(const SkPath& path, SkClipOp op, bool doAntiAlias) |
| 1929 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1930 | #In Clip |
| 1931 | #Line # combines Clip with Path ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1932 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1933 | |
| 1934 | #Example |
| 1935 | #Description |
| 1936 | Top figure uses SkPath::kInverseWinding_FillType and SkClipOp::kDifference; |
| 1937 | area outside clip is subtracted from circle. |
| 1938 | |
| 1939 | Bottom figure uses SkPath::kWinding_FillType and SkClipOp::kIntersect; |
| 1940 | area inside clip is intersected with circle. |
| 1941 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1942 | void draw(SkCanvas* canvas) { |
| 1943 | SkPaint paint; |
| 1944 | paint.setAntiAlias(true); |
| 1945 | SkPath path; |
| 1946 | path.addRect({20, 30, 100, 110}); |
| 1947 | path.setFillType(SkPath::kInverseWinding_FillType); |
| 1948 | canvas->save(); |
| 1949 | canvas->clipPath(path, SkClipOp::kDifference, false); |
| 1950 | canvas->drawCircle(70, 100, 60, paint); |
| 1951 | canvas->restore(); |
| 1952 | canvas->translate(100, 100); |
| 1953 | path.setFillType(SkPath::kWinding_FillType); |
| 1954 | canvas->clipPath(path, SkClipOp::kIntersect, false); |
| 1955 | canvas->drawCircle(70, 100, 60, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1956 | } |
| 1957 | ## |
| 1958 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1959 | #SeeAlso clipRect clipRRect clipRegion |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1960 | |
| 1961 | ## |
| 1962 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1963 | #Method void clipPath(const SkPath& path, SkClipOp op) |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1964 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1965 | #In Clip |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1966 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1967 | |
| 1968 | #Example |
| 1969 | #Description |
Cary Clark | bc5697d | 2017-10-04 14:31:33 -0400 | [diff] [blame] | 1970 | Overlapping Rects form a clip. When clip Path_Fill_Type is set to |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1971 | SkPath::kWinding_FillType, the overlap is included. Set to |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1972 | SkPath::kEvenOdd_FillType, the overlap is excluded and forms a hole. |
| 1973 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 1974 | void draw(SkCanvas* canvas) { |
| 1975 | SkPaint paint; |
| 1976 | paint.setAntiAlias(true); |
| 1977 | SkPath path; |
| 1978 | path.addRect({20, 15, 100, 95}); |
| 1979 | path.addRect({50, 65, 130, 135}); |
| 1980 | path.setFillType(SkPath::kWinding_FillType); |
| 1981 | canvas->save(); |
| 1982 | canvas->clipPath(path, SkClipOp::kIntersect); |
| 1983 | canvas->drawCircle(70, 85, 60, paint); |
| 1984 | canvas->restore(); |
| 1985 | canvas->translate(100, 100); |
| 1986 | path.setFillType(SkPath::kEvenOdd_FillType); |
| 1987 | canvas->clipPath(path, SkClipOp::kIntersect); |
| 1988 | canvas->drawCircle(70, 85, 60, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1989 | } |
| 1990 | ## |
| 1991 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 1992 | #SeeAlso clipRect clipRRect clipRegion |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1993 | |
| 1994 | ## |
| 1995 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 1996 | #Method void clipPath(const SkPath& path, bool doAntiAlias = false) |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 1997 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 1998 | #In Clip |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 1999 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2000 | |
| 2001 | #Example |
| 2002 | #Height 212 |
| 2003 | #Description |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2004 | Clip loops over itself covering its center twice. When clip Path_Fill_Type |
| 2005 | is set to SkPath::kWinding_FillType, the overlap is included. Set to |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2006 | SkPath::kEvenOdd_FillType, the overlap is excluded and forms a hole. |
| 2007 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2008 | void draw(SkCanvas* canvas) { |
| 2009 | SkPaint paint; |
| 2010 | paint.setAntiAlias(true); |
| 2011 | SkPath path; |
| 2012 | SkPoint poly[] = {{20, 20}, { 80, 20}, { 80, 80}, {40, 80}, |
| 2013 | {40, 40}, {100, 40}, {100, 100}, {20, 100}}; |
| 2014 | path.addPoly(poly, SK_ARRAY_COUNT(poly), true); |
| 2015 | path.setFillType(SkPath::kWinding_FillType); |
| 2016 | canvas->save(); |
| 2017 | canvas->clipPath(path, SkClipOp::kIntersect); |
| 2018 | canvas->drawCircle(50, 50, 45, paint); |
| 2019 | canvas->restore(); |
| 2020 | canvas->translate(100, 100); |
| 2021 | path.setFillType(SkPath::kEvenOdd_FillType); |
| 2022 | canvas->clipPath(path, SkClipOp::kIntersect); |
| 2023 | canvas->drawCircle(50, 50, 45, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2024 | } |
| 2025 | ## |
| 2026 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2027 | #SeeAlso clipRect clipRRect clipRegion |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2028 | |
| 2029 | ## |
| 2030 | |
| 2031 | # ------------------------------------------------------------------------------ |
| 2032 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2033 | #Method void clipRegion(const SkRegion& deviceRgn, SkClipOp op = SkClipOp::kIntersect) |
| 2034 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2035 | #In Clip |
| 2036 | #Line # combines Clip with Region ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2037 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2038 | |
| 2039 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2040 | #Description |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 2041 | region is unaffected by canvas rotation; iRect is affected by canvas rotation. |
| 2042 | Both clips are Aliased; this is not noticeable on Region clip because it |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2043 | aligns to pixel boundaries. |
| 2044 | ## |
| 2045 | void draw(SkCanvas* canvas) { |
| 2046 | SkPaint paint; |
| 2047 | paint.setAntiAlias(true); |
| 2048 | SkIRect iRect = {30, 40, 120, 130 }; |
| 2049 | SkRegion region(iRect); |
| 2050 | canvas->rotate(10); |
| 2051 | canvas->save(); |
| 2052 | canvas->clipRegion(region, SkClipOp::kIntersect); |
| 2053 | canvas->drawCircle(50, 50, 45, paint); |
| 2054 | canvas->restore(); |
| 2055 | canvas->translate(100, 100); |
| 2056 | canvas->clipRect(SkRect::Make(iRect), SkClipOp::kIntersect); |
| 2057 | canvas->drawCircle(50, 50, 45, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2058 | } |
| 2059 | ## |
| 2060 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2061 | #SeeAlso clipRect clipRRect clipPath |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2062 | |
| 2063 | ## |
| 2064 | |
| 2065 | #Method bool quickReject(const SkRect& rect) const |
| 2066 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2067 | #In Clip |
| 2068 | #Line # returns if Rect is outside Clip ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2069 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2070 | |
| 2071 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2072 | void draw(SkCanvas* canvas) { |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2073 | SkRect testRect = {30, 30, 120, 129 }; |
| 2074 | SkRect clipRect = {30, 130, 120, 230 }; |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2075 | canvas->save(); |
| 2076 | canvas->clipRect(clipRect); |
| 2077 | SkDebugf("quickReject %s\n", canvas->quickReject(testRect) ? "true" : "false"); |
| 2078 | canvas->restore(); |
| 2079 | canvas->rotate(10); |
| 2080 | canvas->clipRect(clipRect); |
| 2081 | SkDebugf("quickReject %s\n", canvas->quickReject(testRect) ? "true" : "false"); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2082 | } |
| 2083 | #StdOut |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2084 | quickReject true |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2085 | quickReject false |
| 2086 | ## |
| 2087 | ## |
| 2088 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2089 | #SeeAlso getLocalClipBounds getTotalMatrix SkBitmap::drawsNothing |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2090 | |
| 2091 | ## |
| 2092 | |
| 2093 | #Method bool quickReject(const SkPath& path) const |
| 2094 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2095 | #In Clip |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2096 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2097 | |
| 2098 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2099 | void draw(SkCanvas* canvas) { |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2100 | SkPoint testPoints[] = {{30, 30}, {120, 30}, {120, 129} }; |
| 2101 | SkPoint clipPoints[] = {{30, 130}, {120, 130}, {120, 230} }; |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2102 | SkPath testPath, clipPath; |
| 2103 | testPath.addPoly(testPoints, SK_ARRAY_COUNT(testPoints), true); |
| 2104 | clipPath.addPoly(clipPoints, SK_ARRAY_COUNT(clipPoints), true); |
| 2105 | canvas->save(); |
| 2106 | canvas->clipPath(clipPath); |
| 2107 | SkDebugf("quickReject %s\n", canvas->quickReject(testPath) ? "true" : "false"); |
| 2108 | canvas->restore(); |
| 2109 | canvas->rotate(10); |
| 2110 | canvas->clipPath(clipPath); |
| 2111 | SkDebugf("quickReject %s\n", canvas->quickReject(testPath) ? "true" : "false"); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2112 | #StdOut |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2113 | quickReject true |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2114 | quickReject false |
| 2115 | ## |
| 2116 | } |
| 2117 | ## |
| 2118 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2119 | #SeeAlso getLocalClipBounds getTotalMatrix SkBitmap::drawsNothing |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2120 | |
| 2121 | ## |
| 2122 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2123 | #Method SkRect getLocalClipBounds() const |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2124 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2125 | #In Clip |
| 2126 | #Line # returns Clip bounds in source coordinates ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2127 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2128 | |
| 2129 | #Example |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2130 | #Description |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2131 | Initial bounds is device bounds outset by 1 on all sides. |
| 2132 | Clipped bounds is clipPath bounds outset by 1 on all sides. |
Cary Clark | 5538c13 | 2018-06-14 12:28:14 -0400 | [diff] [blame] | 2133 | Scaling the canvas by two on both axes scales the local bounds by 1/2 |
| 2134 | on both axes. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2135 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2136 | SkCanvas local(256, 256); |
| 2137 | canvas = &local; |
| 2138 | SkRect bounds = canvas->getLocalClipBounds(); |
| 2139 | SkDebugf("left:%g top:%g right:%g bottom:%g\n", |
| 2140 | bounds.fLeft, bounds.fTop, bounds.fRight, bounds.fBottom); |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2141 | SkPoint clipPoints[] = {{30, 130}, {120, 130}, {120, 230} }; |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2142 | SkPath clipPath; |
| 2143 | clipPath.addPoly(clipPoints, SK_ARRAY_COUNT(clipPoints), true); |
| 2144 | canvas->clipPath(clipPath); |
| 2145 | bounds = canvas->getLocalClipBounds(); |
| 2146 | SkDebugf("left:%g top:%g right:%g bottom:%g\n", |
| 2147 | bounds.fLeft, bounds.fTop, bounds.fRight, bounds.fBottom); |
| 2148 | canvas->scale(2, 2); |
| 2149 | bounds = canvas->getLocalClipBounds(); |
| 2150 | SkDebugf("left:%g top:%g right:%g bottom:%g\n", |
| 2151 | bounds.fLeft, bounds.fTop, bounds.fRight, bounds.fBottom); |
| 2152 | #StdOut |
| 2153 | left:-1 top:-1 right:257 bottom:257 |
| 2154 | left:29 top:129 right:121 bottom:231 |
| 2155 | left:14.5 top:64.5 right:60.5 bottom:115.5 |
| 2156 | ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2157 | ## |
| 2158 | |
| 2159 | # local canvas in example works around bug in fiddle ## |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 2160 | #Bug 6524 |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2161 | #SeeAlso getDeviceClipBounds getBaseLayerSize quickReject |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2162 | |
| 2163 | ## |
| 2164 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2165 | #Method bool getLocalClipBounds(SkRect* bounds) const |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2166 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2167 | #In Clip |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2168 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2169 | |
| 2170 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2171 | void draw(SkCanvas* canvas) { |
| 2172 | SkCanvas local(256, 256); |
| 2173 | canvas = &local; |
| 2174 | SkRect bounds; |
| 2175 | SkDebugf("local bounds empty = %s\n", canvas->getLocalClipBounds(&bounds) |
| 2176 | ? "false" : "true"); |
| 2177 | SkPath path; |
| 2178 | canvas->clipPath(path); |
| 2179 | SkDebugf("local bounds empty = %s\n", canvas->getLocalClipBounds(&bounds) |
| 2180 | ? "false" : "true"); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2181 | } |
| 2182 | #StdOut |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2183 | local bounds empty = false |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2184 | local bounds empty = true |
| 2185 | ## |
| 2186 | ## |
| 2187 | |
| 2188 | # local canvas in example works around bug in fiddle ## |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 2189 | #Bug 6524 |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2190 | #SeeAlso getDeviceClipBounds getBaseLayerSize quickReject |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2191 | |
| 2192 | ## |
| 2193 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2194 | #Method SkIRect getDeviceClipBounds() const |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2195 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2196 | #In Clip |
| 2197 | #Line # returns IRect bounds of Clip ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2198 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2199 | |
| 2200 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2201 | void draw(SkCanvas* canvas) { |
| 2202 | #Description |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2203 | Initial bounds is device bounds, not outset. |
| 2204 | Clipped bounds is clipPath bounds, not outset. |
Cary Clark | 5538c13 | 2018-06-14 12:28:14 -0400 | [diff] [blame] | 2205 | Scaling the canvas by 1/2 on both axes scales the device bounds by 1/2 |
| 2206 | on both axes. |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2207 | ## |
| 2208 | SkCanvas device(256, 256); |
| 2209 | canvas = &device; |
| 2210 | SkIRect bounds = canvas->getDeviceClipBounds(); |
| 2211 | SkDebugf("left:%d top:%d right:%d bottom:%d\n", |
| 2212 | bounds.fLeft, bounds.fTop, bounds.fRight, bounds.fBottom); |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2213 | SkPoint clipPoints[] = {{30, 130}, {120, 130}, {120, 230} }; |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2214 | SkPath clipPath; |
| 2215 | clipPath.addPoly(clipPoints, SK_ARRAY_COUNT(clipPoints), true); |
| 2216 | canvas->save(); |
| 2217 | canvas->clipPath(clipPath); |
| 2218 | bounds = canvas->getDeviceClipBounds(); |
| 2219 | SkDebugf("left:%d top:%d right:%d bottom:%d\n", |
| 2220 | bounds.fLeft, bounds.fTop, bounds.fRight, bounds.fBottom); |
| 2221 | canvas->restore(); |
| 2222 | canvas->scale(1.f/2, 1.f/2); |
| 2223 | canvas->clipPath(clipPath); |
| 2224 | bounds = canvas->getDeviceClipBounds(); |
| 2225 | SkDebugf("left:%d top:%d right:%d bottom:%d\n", |
| 2226 | bounds.fLeft, bounds.fTop, bounds.fRight, bounds.fBottom); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2227 | #StdOut |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2228 | left:0 top:0 right:256 bottom:256 |
| 2229 | left:30 top:130 right:120 bottom:230 |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2230 | left:15 top:65 right:60 bottom:115 |
| 2231 | ## |
| 2232 | } |
| 2233 | ## |
| 2234 | |
| 2235 | #ToDo some confusion on why with an identity Matrix local and device are different ## |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2236 | #SeeAlso getLocalClipBounds getBaseLayerSize quickReject |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2237 | |
| 2238 | # device canvas in example works around bug in fiddle ## |
Cary Clark | 4855f78 | 2018-02-06 09:41:53 -0500 | [diff] [blame] | 2239 | #Bug 6524 |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2240 | |
| 2241 | ## |
| 2242 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2243 | #Method bool getDeviceClipBounds(SkIRect* bounds) const |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2244 | |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2245 | #In Clip |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2246 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2247 | |
| 2248 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2249 | void draw(SkCanvas* canvas) { |
| 2250 | SkIRect bounds; |
| 2251 | SkDebugf("device bounds empty = %s\n", canvas->getDeviceClipBounds(&bounds) |
| 2252 | ? "false" : "true"); |
| 2253 | SkPath path; |
| 2254 | canvas->clipPath(path); |
| 2255 | SkDebugf("device bounds empty = %s\n", canvas->getDeviceClipBounds(&bounds) |
| 2256 | ? "false" : "true"); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2257 | } |
| 2258 | #StdOut |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2259 | device bounds empty = false |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2260 | device bounds empty = true |
| 2261 | ## |
| 2262 | ## |
| 2263 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2264 | #SeeAlso getLocalClipBounds getBaseLayerSize quickReject |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2265 | |
| 2266 | ## |
| 2267 | |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2268 | #Subtopic Clip ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2269 | |
| 2270 | # ------------------------------------------------------------------------------ |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 2271 | #Subtopic Draw |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 2272 | #Line # draws into Canvas ## |
| 2273 | ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2274 | |
| 2275 | #Method void drawColor(SkColor color, SkBlendMode mode = SkBlendMode::kSrcOver) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 2276 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2277 | #Line # fills Clip with Color and Blend_Mode ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2278 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2279 | |
| 2280 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2281 | canvas->drawColor(SK_ColorRED); |
| 2282 | canvas->clipRect(SkRect::MakeWH(150, 150)); |
| 2283 | canvas->drawColor(SkColorSetARGB(0x80, 0x00, 0xFF, 0x00), SkBlendMode::kPlus); |
| 2284 | canvas->clipRect(SkRect::MakeWH(75, 75)); |
| 2285 | canvas->drawColor(SkColorSetARGB(0x80, 0x00, 0x00, 0xFF), SkBlendMode::kPlus); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2286 | ## |
| 2287 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2288 | #SeeAlso clear SkBitmap::erase drawPaint |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2289 | |
| 2290 | ## |
| 2291 | |
| 2292 | # ------------------------------------------------------------------------------ |
| 2293 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2294 | #Method void clear(SkColor color) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 2295 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2296 | #Line # fills Clip with Color ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2297 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2298 | |
| 2299 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2300 | void draw(SkCanvas* canvas) { |
| 2301 | canvas->save(); |
| 2302 | canvas->clipRect(SkRect::MakeWH(256, 128)); |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2303 | canvas->clear(SkColorSetARGB(0x80, 0xFF, 0x00, 0x00)); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2304 | canvas->restore(); |
| 2305 | canvas->save(); |
| 2306 | canvas->clipRect(SkRect::MakeWH(150, 192)); |
| 2307 | canvas->clear(SkColorSetARGB(0x80, 0x00, 0xFF, 0x00)); |
| 2308 | canvas->restore(); |
| 2309 | canvas->clipRect(SkRect::MakeWH(75, 256)); |
| 2310 | canvas->clear(SkColorSetARGB(0x80, 0x00, 0x00, 0xFF)); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2311 | } |
| 2312 | ## |
| 2313 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2314 | #SeeAlso drawColor SkBitmap::erase drawPaint |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2315 | |
| 2316 | ## |
| 2317 | |
| 2318 | # ------------------------------------------------------------------------------ |
| 2319 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2320 | #Method void discard() |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 2321 | #In Utility |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2322 | #Line # makes Canvas contents undefined ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2323 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2324 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2325 | #NoExample |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2326 | ## |
| 2327 | |
Cary Clark | abaffd8 | 2018-11-15 08:25:12 -0500 | [diff] [blame] | 2328 | #SeeAlso flush() GrContext::abandonContext |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2329 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2330 | ## |
| 2331 | |
| 2332 | # ------------------------------------------------------------------------------ |
| 2333 | |
| 2334 | #Method void drawPaint(const SkPaint& paint) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 2335 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2336 | #Line # fills Clip with Paint ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2337 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2338 | |
| 2339 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2340 | void draw(SkCanvas* canvas) { |
| 2341 | SkColor colors[] = { SK_ColorRED, SK_ColorGREEN, SK_ColorBLUE }; |
| 2342 | SkScalar pos[] = { 0, SK_Scalar1/2, SK_Scalar1 }; |
| 2343 | SkPaint paint; |
| 2344 | paint.setShader(SkGradientShader::MakeSweep(256, 256, colors, pos, SK_ARRAY_COUNT(colors))); |
| 2345 | canvas->drawPaint(paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2346 | } |
| 2347 | ## |
| 2348 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2349 | #SeeAlso clear drawColor SkBitmap::erase |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2350 | |
| 2351 | ## |
| 2352 | |
| 2353 | # ------------------------------------------------------------------------------ |
| 2354 | |
| 2355 | #Enum PointMode |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2356 | #Line # sets drawPoints options ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2357 | |
| 2358 | #Code |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2359 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2360 | ## |
| 2361 | |
| 2362 | Selects if an array of points are drawn as discrete points, as lines, or as |
| 2363 | an open polygon. |
| 2364 | |
| 2365 | #Const kPoints_PointMode 0 |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2366 | #Line # draw each point separately ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2367 | ## |
| 2368 | |
| 2369 | #Const kLines_PointMode 1 |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2370 | #Line # draw each pair of points as a line segment ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2371 | ## |
| 2372 | |
| 2373 | #Const kPolygon_PointMode 2 |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2374 | #Line # draw the array of points as a open polygon ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2375 | ## |
| 2376 | |
| 2377 | #Example |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2378 | #Description |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2379 | The upper left corner shows three squares when drawn as points. |
| 2380 | The upper right corner shows one line; when drawn as lines, two points are required per line. |
| 2381 | The lower right corner shows two lines; when draw as polygon, no miter is drawn at the corner. |
| 2382 | The lower left corner shows two lines with a miter when path contains polygon. |
| 2383 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2384 | void draw(SkCanvas* canvas) { |
| 2385 | SkPaint paint; |
| 2386 | paint.setStyle(SkPaint::kStroke_Style); |
| 2387 | paint.setStrokeWidth(10); |
| 2388 | SkPoint points[] = {{64, 32}, {96, 96}, {32, 96}}; |
| 2389 | canvas->drawPoints(SkCanvas::kPoints_PointMode, 3, points, paint); |
| 2390 | canvas->translate(128, 0); |
| 2391 | canvas->drawPoints(SkCanvas::kLines_PointMode, 3, points, paint); |
| 2392 | canvas->translate(0, 128); |
| 2393 | canvas->drawPoints(SkCanvas::kPolygon_PointMode, 3, points, paint); |
| 2394 | SkPath path; |
| 2395 | path.addPoly(points, 3, false); |
| 2396 | canvas->translate(-128, 0); |
| 2397 | canvas->drawPath(path, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2398 | } |
| 2399 | ## |
| 2400 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2401 | #SeeAlso drawLine drawPoint drawPath |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2402 | |
| 2403 | ## |
| 2404 | |
| 2405 | # ------------------------------------------------------------------------------ |
| 2406 | |
| 2407 | #Method void drawPoints(PointMode mode, size_t count, const SkPoint pts[], const SkPaint& paint) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 2408 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2409 | #Line # draws array as points, lines, polygon ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2410 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2411 | |
| 2412 | #Example |
| 2413 | #Height 200 |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2414 | #Description |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2415 | #List |
| 2416 | # The first column draws points. ## |
| 2417 | # The second column draws points as lines. ## |
| 2418 | # The third column draws points as a polygon. ## |
| 2419 | # The fourth column draws points as a polygonal path. ## |
| 2420 | # The first row uses a round cap and round join. ## |
| 2421 | # The second row uses a square cap and a miter join. ## |
| 2422 | # The third row uses a butt cap and a bevel join. ## |
| 2423 | ## |
| 2424 | The transparent color makes multiple line draws visible; |
| 2425 | the path is drawn all at once. |
| 2426 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2427 | void draw(SkCanvas* canvas) { |
| 2428 | SkPaint paint; |
| 2429 | paint.setAntiAlias(true); |
| 2430 | paint.setStyle(SkPaint::kStroke_Style); |
| 2431 | paint.setStrokeWidth(10); |
| 2432 | paint.setColor(0x80349a45); |
| 2433 | const SkPoint points[] = {{32, 16}, {48, 48}, {16, 32}}; |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2434 | const SkPaint::Join join[] = { SkPaint::kRound_Join, |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2435 | SkPaint::kMiter_Join, |
| 2436 | SkPaint::kBevel_Join }; |
| 2437 | int joinIndex = 0; |
| 2438 | SkPath path; |
| 2439 | path.addPoly(points, 3, false); |
| 2440 | for (const auto cap : { SkPaint::kRound_Cap, SkPaint::kSquare_Cap, SkPaint::kButt_Cap } ) { |
| 2441 | paint.setStrokeCap(cap); |
| 2442 | paint.setStrokeJoin(join[joinIndex++]); |
| 2443 | for (const auto mode : { SkCanvas::kPoints_PointMode, |
| 2444 | SkCanvas::kLines_PointMode, |
| 2445 | SkCanvas::kPolygon_PointMode } ) { |
| 2446 | canvas->drawPoints(mode, 3, points, paint); |
| 2447 | canvas->translate(64, 0); |
| 2448 | } |
| 2449 | canvas->drawPath(path, paint); |
| 2450 | canvas->translate(-192, 64); |
| 2451 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2452 | } |
| 2453 | ## |
| 2454 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2455 | #SeeAlso drawLine drawPoint drawPath |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2456 | |
| 2457 | ## |
| 2458 | |
| 2459 | # ------------------------------------------------------------------------------ |
| 2460 | |
| 2461 | #Method void drawPoint(SkScalar x, SkScalar y, const SkPaint& paint) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 2462 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2463 | #Line # draws point at (x, y) position ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2464 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2465 | |
| 2466 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2467 | void draw(SkCanvas* canvas) { |
| 2468 | SkPaint paint; |
| 2469 | paint.setAntiAlias(true); |
| 2470 | paint.setColor(0x80349a45); |
| 2471 | paint.setStyle(SkPaint::kStroke_Style); |
| 2472 | paint.setStrokeWidth(100); |
| 2473 | paint.setStrokeCap(SkPaint::kRound_Cap); |
| 2474 | canvas->scale(1, 1.2f); |
| 2475 | canvas->drawPoint(64, 96, paint); |
| 2476 | canvas->scale(.6f, .8f); |
| 2477 | paint.setColor(SK_ColorWHITE); |
| 2478 | canvas->drawPoint(106, 120, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2479 | } |
| 2480 | ## |
| 2481 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2482 | #SeeAlso drawPoints drawCircle drawRect drawLine drawPath |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2483 | |
| 2484 | ## |
| 2485 | |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2486 | #Method void drawPoint(SkPoint p, const SkPaint& paint) |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2487 | #Populate |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2488 | |
| 2489 | #Example |
| 2490 | void draw(SkCanvas* canvas) { |
| 2491 | SkPaint paint; |
| 2492 | paint.setAntiAlias(true); |
| 2493 | paint.setColor(0x80349a45); |
| 2494 | paint.setStyle(SkPaint::kStroke_Style); |
| 2495 | paint.setStrokeWidth(100); |
| 2496 | paint.setStrokeCap(SkPaint::kSquare_Cap); |
| 2497 | canvas->scale(1, 1.2f); |
| 2498 | canvas->drawPoint({64, 96}, paint); |
| 2499 | canvas->scale(.6f, .8f); |
| 2500 | paint.setColor(SK_ColorWHITE); |
| 2501 | canvas->drawPoint(106, 120, paint); |
| 2502 | } |
| 2503 | ## |
| 2504 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2505 | #SeeAlso drawPoints drawCircle drawRect drawLine drawPath |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2506 | |
| 2507 | ## |
| 2508 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2509 | # ------------------------------------------------------------------------------ |
| 2510 | |
| 2511 | #Method void drawLine(SkScalar x0, SkScalar y0, SkScalar x1, SkScalar y1, const SkPaint& paint) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 2512 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2513 | #Line # draws line segment between two points ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2514 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2515 | |
| 2516 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2517 | SkPaint paint; |
| 2518 | paint.setAntiAlias(true); |
| 2519 | paint.setColor(0xFF9a67be); |
| 2520 | paint.setStrokeWidth(20); |
| 2521 | canvas->skew(1, 0); |
| 2522 | canvas->drawLine(32, 96, 32, 160, paint); |
| 2523 | canvas->skew(-2, 0); |
| 2524 | canvas->drawLine(288, 96, 288, 160, paint); |
| 2525 | ## |
| 2526 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2527 | #SeeAlso drawPoint drawCircle drawRect drawPath |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2528 | |
| 2529 | ## |
| 2530 | |
| 2531 | #Method void drawLine(SkPoint p0, SkPoint p1, const SkPaint& paint) |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2532 | #Populate |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2533 | |
| 2534 | #Example |
| 2535 | SkPaint paint; |
| 2536 | paint.setAntiAlias(true); |
| 2537 | paint.setColor(0xFF9a67be); |
| 2538 | paint.setStrokeWidth(20); |
| 2539 | canvas->skew(1, 0); |
| 2540 | canvas->drawLine({32, 96}, {32, 160}, paint); |
| 2541 | canvas->skew(-2, 0); |
| 2542 | canvas->drawLine({288, 96}, {288, 160}, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2543 | ## |
| 2544 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2545 | #SeeAlso drawPoint drawCircle drawRect drawPath |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2546 | |
| 2547 | ## |
| 2548 | |
| 2549 | # ------------------------------------------------------------------------------ |
| 2550 | |
| 2551 | #Method void drawRect(const SkRect& rect, const SkPaint& paint) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 2552 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2553 | #Line # draws Rect using Clip, Matrix, and Paint ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2554 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2555 | |
| 2556 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2557 | void draw(SkCanvas* canvas) { |
| 2558 | SkPoint rectPts[] = { {64, 48}, {192, 160} }; |
| 2559 | SkPaint paint; |
| 2560 | paint.setAntiAlias(true); |
| 2561 | paint.setStyle(SkPaint::kStroke_Style); |
| 2562 | paint.setStrokeWidth(20); |
| 2563 | paint.setStrokeJoin(SkPaint::kRound_Join); |
| 2564 | SkMatrix rotator; |
| 2565 | rotator.setRotate(30, 128, 128); |
| 2566 | for (auto color : { SK_ColorRED, SK_ColorBLUE, SK_ColorYELLOW, SK_ColorMAGENTA } ) { |
| 2567 | paint.setColor(color); |
| 2568 | SkRect rect; |
| 2569 | rect.set(rectPts[0], rectPts[1]); |
| 2570 | canvas->drawRect(rect, paint); |
| 2571 | rotator.mapPoints(rectPts, 2); |
| 2572 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2573 | } |
| 2574 | ## |
| 2575 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2576 | #SeeAlso drawIRect drawRRect drawRoundRect drawRegion drawPath drawLine |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2577 | |
| 2578 | ## |
| 2579 | |
| 2580 | # ------------------------------------------------------------------------------ |
| 2581 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2582 | #Method void drawIRect(const SkIRect& rect, const SkPaint& paint) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 2583 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2584 | #Line # draws IRect using Clip, Matrix, and Paint ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2585 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2586 | |
| 2587 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2588 | SkIRect rect = { 64, 48, 192, 160 }; |
| 2589 | SkPaint paint; |
| 2590 | paint.setAntiAlias(true); |
| 2591 | paint.setStyle(SkPaint::kStroke_Style); |
| 2592 | paint.setStrokeWidth(20); |
| 2593 | paint.setStrokeJoin(SkPaint::kRound_Join); |
| 2594 | for (auto color : { SK_ColorRED, SK_ColorBLUE, SK_ColorYELLOW, SK_ColorMAGENTA } ) { |
| 2595 | paint.setColor(color); |
| 2596 | canvas->drawIRect(rect, paint); |
| 2597 | canvas->rotate(30, 128, 128); |
| 2598 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2599 | ## |
| 2600 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2601 | #SeeAlso drawRect drawRRect drawRoundRect drawRegion drawPath drawLine |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2602 | |
| 2603 | ## |
| 2604 | |
| 2605 | # ------------------------------------------------------------------------------ |
| 2606 | |
| 2607 | #Method void drawRegion(const SkRegion& region, const SkPaint& paint) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 2608 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2609 | #Line # draws Region using Clip, Matrix, and Paint ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2610 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2611 | |
| 2612 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2613 | void draw(SkCanvas* canvas) { |
| 2614 | SkRegion region; |
| 2615 | region.op( 10, 10, 50, 50, SkRegion::kUnion_Op); |
| 2616 | region.op( 10, 50, 90, 90, SkRegion::kUnion_Op); |
| 2617 | SkPaint paint; |
| 2618 | paint.setAntiAlias(true); |
| 2619 | paint.setStyle(SkPaint::kStroke_Style); |
| 2620 | paint.setStrokeWidth(20); |
| 2621 | paint.setStrokeJoin(SkPaint::kRound_Join); |
| 2622 | canvas->drawRegion(region, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2623 | } |
| 2624 | ## |
| 2625 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2626 | #SeeAlso drawRect drawIRect drawPath |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2627 | |
| 2628 | ## |
| 2629 | |
| 2630 | # ------------------------------------------------------------------------------ |
| 2631 | |
| 2632 | #Method void drawOval(const SkRect& oval, const SkPaint& paint) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 2633 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2634 | #Line # draws Oval using Clip, Matrix, and Paint ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2635 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2636 | |
| 2637 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2638 | void draw(SkCanvas* canvas) { |
| 2639 | canvas->clear(0xFF3f5f9f); |
| 2640 | SkColor kColor1 = SkColorSetARGB(0xff, 0xff, 0x7f, 0); |
| 2641 | SkColor g1Colors[] = { kColor1, SkColorSetA(kColor1, 0x20) }; |
| 2642 | SkPoint g1Points[] = { { 0, 0 }, { 0, 100 } }; |
| 2643 | SkScalar pos[] = { 0.2f, 1.0f }; |
| 2644 | SkRect bounds = SkRect::MakeWH(80, 70); |
| 2645 | SkPaint paint; |
| 2646 | paint.setAntiAlias(true); |
| 2647 | paint.setShader(SkGradientShader::MakeLinear(g1Points, g1Colors, pos, SK_ARRAY_COUNT(g1Colors), |
| 2648 | SkShader::kClamp_TileMode)); |
| 2649 | canvas->drawOval(bounds , paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2650 | } |
| 2651 | ## |
| 2652 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2653 | #SeeAlso drawCircle drawPoint drawPath drawRRect drawRoundRect |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2654 | |
| 2655 | ## |
| 2656 | |
| 2657 | # ------------------------------------------------------------------------------ |
| 2658 | |
| 2659 | #Method void drawRRect(const SkRRect& rrect, const SkPaint& paint) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 2660 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2661 | #Line # draws Round_Rect using Clip, Matrix, and Paint ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2662 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2663 | |
| 2664 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2665 | void draw(SkCanvas* canvas) { |
| 2666 | SkPaint paint; |
| 2667 | paint.setAntiAlias(true); |
| 2668 | SkRect outer = {30, 40, 210, 220}; |
| 2669 | SkRect radii = {30, 50, 70, 90 }; |
| 2670 | SkRRect rRect; |
| 2671 | rRect.setNinePatch(outer, radii.fLeft, radii.fTop, radii.fRight, radii.fBottom); |
| 2672 | canvas->drawRRect(rRect, paint); |
| 2673 | paint.setColor(SK_ColorWHITE); |
| 2674 | canvas->drawLine(outer.fLeft + radii.fLeft, outer.fTop, |
| 2675 | outer.fLeft + radii.fLeft, outer.fBottom, paint); |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2676 | canvas->drawLine(outer.fRight - radii.fRight, outer.fTop, |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2677 | outer.fRight - radii.fRight, outer.fBottom, paint); |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2678 | canvas->drawLine(outer.fLeft, outer.fTop + radii.fTop, |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2679 | outer.fRight, outer.fTop + radii.fTop, paint); |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2680 | canvas->drawLine(outer.fLeft, outer.fBottom - radii.fBottom, |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2681 | outer.fRight, outer.fBottom - radii.fBottom, paint); |
| 2682 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2683 | ## |
| 2684 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2685 | #SeeAlso drawRect drawRoundRect drawDRRect drawCircle drawOval drawPath |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2686 | |
| 2687 | ## |
| 2688 | |
| 2689 | # ------------------------------------------------------------------------------ |
| 2690 | |
| 2691 | #Method void drawDRRect(const SkRRect& outer, const SkRRect& inner, const SkPaint& paint) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 2692 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2693 | #Line # draws double Round_Rect stroked or filled ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2694 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2695 | |
| 2696 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2697 | void draw(SkCanvas* canvas) { |
| 2698 | SkRRect outer = SkRRect::MakeRect({20, 40, 210, 200}); |
| 2699 | SkRRect inner = SkRRect::MakeOval({60, 70, 170, 160}); |
| 2700 | SkPaint paint; |
| 2701 | canvas->drawDRRect(outer, inner, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2702 | } |
| 2703 | ## |
| 2704 | |
| 2705 | #Example |
| 2706 | #Description |
| 2707 | Outer Rect has no corner radii, but stroke join is rounded. |
| 2708 | Inner Round_Rect has corner radii; outset stroke increases radii of corners. |
| 2709 | Stroke join does not affect inner Round_Rect since it has no sharp corners. |
| 2710 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2711 | void draw(SkCanvas* canvas) { |
| 2712 | SkRRect outer = SkRRect::MakeRect({20, 40, 210, 200}); |
| 2713 | SkRRect inner = SkRRect::MakeRectXY({60, 70, 170, 160}, 10, 10); |
| 2714 | SkPaint paint; |
| 2715 | paint.setAntiAlias(true); |
| 2716 | paint.setStyle(SkPaint::kStroke_Style); |
| 2717 | paint.setStrokeWidth(20); |
| 2718 | paint.setStrokeJoin(SkPaint::kRound_Join); |
| 2719 | canvas->drawDRRect(outer, inner, paint); |
| 2720 | paint.setStrokeWidth(1); |
| 2721 | paint.setColor(SK_ColorWHITE); |
| 2722 | canvas->drawDRRect(outer, inner, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2723 | } |
| 2724 | ## |
| 2725 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2726 | #SeeAlso drawRect drawRoundRect drawRRect drawCircle drawOval drawPath |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2727 | |
| 2728 | ## |
| 2729 | |
| 2730 | # ------------------------------------------------------------------------------ |
| 2731 | |
| 2732 | #Method void drawCircle(SkScalar cx, SkScalar cy, SkScalar radius, const SkPaint& paint) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 2733 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2734 | #Line # draws Circle using Clip, Matrix, and Paint ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2735 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2736 | |
| 2737 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2738 | void draw(SkCanvas* canvas) { |
| 2739 | SkPaint paint; |
| 2740 | paint.setAntiAlias(true); |
| 2741 | canvas->drawCircle(128, 128, 90, paint); |
| 2742 | paint.setColor(SK_ColorWHITE); |
| 2743 | canvas->drawCircle(86, 86, 20, paint); |
| 2744 | canvas->drawCircle(160, 76, 20, paint); |
| 2745 | canvas->drawCircle(140, 150, 35, paint); |
| 2746 | } |
| 2747 | ## |
| 2748 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2749 | #SeeAlso drawOval drawRRect drawRoundRect drawPath drawArc drawPoint drawLine |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2750 | |
| 2751 | ## |
| 2752 | |
| 2753 | #Method void drawCircle(SkPoint center, SkScalar radius, const SkPaint& paint) |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2754 | #Populate |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2755 | |
| 2756 | #Example |
| 2757 | void draw(SkCanvas* canvas) { |
| 2758 | SkPaint paint; |
| 2759 | paint.setAntiAlias(true); |
| 2760 | canvas->drawCircle(128, 128, 90, paint); |
| 2761 | paint.setColor(SK_ColorWHITE); |
| 2762 | canvas->drawCircle({86, 86}, 20, paint); |
| 2763 | canvas->drawCircle({160, 76}, 20, paint); |
| 2764 | canvas->drawCircle({140, 150}, 35, paint); |
| 2765 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2766 | ## |
| 2767 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2768 | #SeeAlso drawOval drawRRect drawRoundRect drawPath drawArc drawPoint drawLine |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2769 | |
| 2770 | ## |
| 2771 | |
| 2772 | # ------------------------------------------------------------------------------ |
| 2773 | |
| 2774 | #Method void drawArc(const SkRect& oval, SkScalar startAngle, SkScalar sweepAngle, |
| 2775 | bool useCenter, const SkPaint& paint) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 2776 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2777 | #Line # draws Arc using Clip, Matrix, and Paint ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2778 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2779 | |
| 2780 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2781 | void draw(SkCanvas* canvas) { |
| 2782 | SkPaint paint; |
| 2783 | paint.setAntiAlias(true); |
| 2784 | SkRect oval = { 4, 4, 60, 60}; |
| 2785 | for (auto useCenter : { false, true } ) { |
| 2786 | for (auto style : { SkPaint::kFill_Style, SkPaint::kStroke_Style } ) { |
| 2787 | paint.setStyle(style); |
| 2788 | for (auto degrees : { 45, 90, 180, 360} ) { |
| 2789 | canvas->drawArc(oval, 0, degrees , useCenter, paint); |
| 2790 | canvas->translate(64, 0); |
| 2791 | } |
| 2792 | canvas->translate(-256, 64); |
| 2793 | } |
| 2794 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2795 | } |
| 2796 | ## |
| 2797 | |
| 2798 | #Example |
| 2799 | #Height 64 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2800 | void draw(SkCanvas* canvas) { |
| 2801 | SkPaint paint; |
| 2802 | paint.setAntiAlias(true); |
| 2803 | paint.setStyle(SkPaint::kStroke_Style); |
| 2804 | paint.setStrokeWidth(4); |
| 2805 | SkRect oval = { 4, 4, 60, 60}; |
| 2806 | float intervals[] = { 5, 5 }; |
| 2807 | paint.setPathEffect(SkDashPathEffect::Make(intervals, 2, 2.5f)); |
| 2808 | for (auto degrees : { 270, 360, 540, 720 } ) { |
| 2809 | canvas->drawArc(oval, 0, degrees, false, paint); |
| 2810 | canvas->translate(64, 0); |
| 2811 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2812 | } |
| 2813 | ## |
| 2814 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2815 | #SeeAlso SkPath::arcTo drawCircle drawOval drawPath |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2816 | |
| 2817 | ## |
| 2818 | |
| 2819 | # ------------------------------------------------------------------------------ |
| 2820 | |
| 2821 | #Method void drawRoundRect(const SkRect& rect, SkScalar rx, SkScalar ry, const SkPaint& paint) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 2822 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2823 | #Line # draws Round_Rect using Clip, Matrix, and Paint ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2824 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2825 | |
| 2826 | #Example |
| 2827 | #Description |
| 2828 | Top row has a zero radius a generates a rectangle. |
| 2829 | Second row radii sum to less than sides. |
| 2830 | Third row radii sum equals sides. |
| 2831 | Fourth row radii sum exceeds sides; radii are scaled to fit. |
| 2832 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2833 | void draw(SkCanvas* canvas) { |
| 2834 | SkVector radii[] = { {0, 20}, {10, 10}, {10, 20}, {10, 40} }; |
| 2835 | SkPaint paint; |
| 2836 | paint.setStrokeWidth(15); |
| 2837 | paint.setStrokeJoin(SkPaint::kRound_Join); |
| 2838 | paint.setAntiAlias(true); |
| 2839 | for (auto style : { SkPaint::kStroke_Style, SkPaint::kFill_Style } ) { |
| 2840 | paint.setStyle(style ); |
| 2841 | for (size_t i = 0; i < SK_ARRAY_COUNT(radii); ++i) { |
| 2842 | canvas->drawRoundRect({10, 10, 60, 40}, radii[i].fX, radii[i].fY, paint); |
| 2843 | canvas->translate(0, 60); |
| 2844 | } |
| 2845 | canvas->translate(80, -240); |
| 2846 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2847 | } |
| 2848 | ## |
| 2849 | |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 2850 | #SeeAlso drawRRect drawRect drawDRRect drawPath drawCircle drawOval drawPoint |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2851 | |
| 2852 | ## |
| 2853 | |
| 2854 | # ------------------------------------------------------------------------------ |
| 2855 | |
| 2856 | #Method void drawPath(const SkPath& path, const SkPaint& paint) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 2857 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2858 | #Line # draws Path using Clip, Matrix, and Paint ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2859 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2860 | |
| 2861 | #Example |
| 2862 | #Description |
| 2863 | Top rows draw stroked path with combinations of joins and caps. The open contour |
| 2864 | is affected by caps; the closed contour is affected by joins. |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2865 | Bottom row draws fill the same for open and closed contour. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2866 | First bottom column shows winding fills overlap. |
| 2867 | Second bottom column shows even odd fills exclude overlap. |
| 2868 | Third bottom column shows inverse winding fills area outside both contours. |
| 2869 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2870 | void draw(SkCanvas* canvas) { |
| 2871 | SkPath path; |
| 2872 | path.moveTo(20, 20); |
| 2873 | path.quadTo(60, 20, 60, 60); |
| 2874 | path.close(); |
| 2875 | path.moveTo(60, 20); |
| 2876 | path.quadTo(60, 60, 20, 60); |
| 2877 | SkPaint paint; |
| 2878 | paint.setStrokeWidth(10); |
| 2879 | paint.setAntiAlias(true); |
| 2880 | paint.setStyle(SkPaint::kStroke_Style); |
| 2881 | for (auto join: { SkPaint::kBevel_Join, SkPaint::kRound_Join, SkPaint::kMiter_Join } ) { |
| 2882 | paint.setStrokeJoin(join); |
| 2883 | for (auto cap: { SkPaint::kButt_Cap, SkPaint::kSquare_Cap, SkPaint::kRound_Cap } ) { |
| 2884 | paint.setStrokeCap(cap); |
| 2885 | canvas->drawPath(path, paint); |
| 2886 | canvas->translate(80, 0); |
| 2887 | } |
| 2888 | canvas->translate(-240, 60); |
| 2889 | } |
| 2890 | paint.setStyle(SkPaint::kFill_Style); |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2891 | for (auto fill : { SkPath::kWinding_FillType, |
| 2892 | SkPath::kEvenOdd_FillType, |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2893 | SkPath::kInverseWinding_FillType } ) { |
| 2894 | path.setFillType(fill); |
| 2895 | canvas->save(); |
| 2896 | canvas->clipRect({0, 10, 80, 70}); |
| 2897 | canvas->drawPath(path, paint); |
| 2898 | canvas->restore(); |
| 2899 | canvas->translate(80, 0); |
| 2900 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2901 | } |
| 2902 | ## |
| 2903 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2904 | #SeeAlso SkPath drawLine drawArc drawRect drawPoints |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2905 | |
| 2906 | ## |
| 2907 | |
| 2908 | # ------------------------------------------------------------------------------ |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2909 | #Subtopic Draw_Image |
| 2910 | #Line # draws Image to Canvas ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2911 | |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2912 | drawImage, drawImageRect, and drawImageNine can be called with a bare pointer or |
| 2913 | a smart pointer as a convenience. The pairs of calls are otherwise identical. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2914 | |
Cary Clark | 73fa972 | 2017-08-29 17:36:51 -0400 | [diff] [blame] | 2915 | #Method void drawImage(const SkImage* image, SkScalar left, SkScalar top, const SkPaint* paint = nullptr) |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2916 | #In Draw_Image |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 2917 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 2918 | #Line # draws Image at (x, y) position ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2919 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2920 | |
| 2921 | #Example |
| 2922 | #Height 64 |
| 2923 | #Image 4 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2924 | void draw(SkCanvas* canvas) { |
| 2925 | // sk_sp<SkImage> image; |
| 2926 | SkImage* imagePtr = image.get(); |
| 2927 | canvas->drawImage(imagePtr, 0, 0); |
| 2928 | SkPaint paint; |
| 2929 | canvas->drawImage(imagePtr, 80, 0, &paint); |
| 2930 | paint.setAlpha(0x80); |
| 2931 | canvas->drawImage(imagePtr, 160, 0, &paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2932 | } |
| 2933 | ## |
| 2934 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2935 | #SeeAlso drawBitmap drawImageLattice drawImageNine drawImageRect SkPaint::setImageFilter |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2936 | |
| 2937 | ## |
| 2938 | |
| 2939 | # ------------------------------------------------------------------------------ |
| 2940 | |
| 2941 | #Method void drawImage(const sk_sp<SkImage>& image, SkScalar left, SkScalar top, |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2942 | const SkPaint* paint = nullptr) |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 2943 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2944 | |
| 2945 | #Example |
| 2946 | #Height 64 |
| 2947 | #Image 4 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2948 | void draw(SkCanvas* canvas) { |
| 2949 | // sk_sp<SkImage> image; |
| 2950 | canvas->drawImage(image, 0, 0); |
| 2951 | SkPaint paint; |
| 2952 | canvas->drawImage(image, 80, 0, &paint); |
| 2953 | paint.setAlpha(0x80); |
| 2954 | canvas->drawImage(image, 160, 0, &paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2955 | } |
| 2956 | ## |
| 2957 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 2958 | #SeeAlso drawBitmap drawImageLattice drawImageNine drawImageRect SkPaint::setImageFilter |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2959 | |
| 2960 | ## |
| 2961 | |
| 2962 | # ------------------------------------------------------------------------------ |
| 2963 | |
| 2964 | #Enum SrcRectConstraint |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 2965 | #Line # sets drawImageRect options ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2966 | |
| 2967 | #Code |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 2968 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2969 | ## |
| 2970 | |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 2971 | SrcRectConstraint controls the behavior at the edge of source Rect, |
| 2972 | provided to drawImageRect, trading off speed for precision. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2973 | |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 2974 | Image_Filter in Paint may sample multiple pixels in the image. Source Rect |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 2975 | restricts the bounds of pixels that may be read. Image_Filter may slow down if |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 2976 | it cannot read outside the bounds, when sampling near the edge of source Rect. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2977 | SrcRectConstraint specifies whether an Image_Filter is allowed to read pixels |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 2978 | outside source Rect. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2979 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2980 | #Const kStrict_SrcRectConstraint 0 |
| 2981 | #Line # sample only inside bounds; slower ## |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 2982 | Requires Image_Filter to respect source Rect, |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2983 | sampling only inside of its bounds, possibly with a performance penalty. |
| 2984 | ## |
| 2985 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 2986 | #Const kFast_SrcRectConstraint 1 |
| 2987 | #Line # sample outside bounds; faster ## |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 2988 | Permits Image_Filter to sample outside of source Rect |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2989 | by half the width of Image_Filter, permitting it to run faster but with |
| 2990 | error at the image edges. |
| 2991 | ## |
| 2992 | |
| 2993 | #Example |
| 2994 | #Height 64 |
| 2995 | #Description |
| 2996 | redBorder contains a black and white checkerboard bordered by red. |
| 2997 | redBorder is drawn scaled by 16 on the left. |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 2998 | The middle and right bitmaps are filtered checkerboards. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 2999 | Drawing the checkerboard with kStrict_SrcRectConstraint shows only a blur of black and white. |
| 3000 | Drawing the checkerboard with kFast_SrcRectConstraint allows red to bleed in the corners. |
| 3001 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3002 | void draw(SkCanvas* canvas) { |
| 3003 | SkBitmap redBorder; |
| 3004 | redBorder.allocPixels(SkImageInfo::MakeN32Premul(4, 4)); |
| 3005 | SkCanvas checkRed(redBorder); |
| 3006 | checkRed.clear(SK_ColorRED); |
| 3007 | uint32_t checkers[][2] = { { SK_ColorBLACK, SK_ColorWHITE }, |
| 3008 | { SK_ColorWHITE, SK_ColorBLACK } }; |
| 3009 | checkRed.writePixels( |
| 3010 | SkImageInfo::MakeN32Premul(2, 2), (void*) checkers, sizeof(checkers[0]), 1, 1); |
| 3011 | canvas->scale(16, 16); |
| 3012 | canvas->drawBitmap(redBorder, 0, 0, nullptr); |
| 3013 | canvas->resetMatrix(); |
| 3014 | sk_sp<SkImage> image = SkImage::MakeFromBitmap(redBorder); |
| 3015 | SkPaint lowPaint; |
| 3016 | lowPaint.setFilterQuality(kLow_SkFilterQuality); |
| 3017 | for (auto constraint : { SkCanvas::kStrict_SrcRectConstraint, |
| 3018 | SkCanvas::kFast_SrcRectConstraint } ) { |
| 3019 | canvas->translate(80, 0); |
| 3020 | canvas->drawImageRect(image.get(), SkRect::MakeLTRB(1, 1, 3, 3), |
| 3021 | SkRect::MakeLTRB(16, 16, 48, 48), &lowPaint, constraint); |
| 3022 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3023 | } |
| 3024 | ## |
| 3025 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 3026 | #SeeAlso drawImageRect drawImage SkPaint::setImageFilter |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3027 | |
| 3028 | ## |
| 3029 | |
| 3030 | # ------------------------------------------------------------------------------ |
| 3031 | |
| 3032 | #Method void drawImageRect(const SkImage* image, const SkRect& src, const SkRect& dst, |
| 3033 | const SkPaint* paint, |
| 3034 | SrcRectConstraint constraint = kStrict_SrcRectConstraint) |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3035 | #In Draw_Image |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 3036 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3037 | #Line # draws Image, source Rect to destination Rect ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3038 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3039 | |
| 3040 | #Example |
| 3041 | #Height 64 |
| 3042 | #Description |
| 3043 | The left bitmap draws with Paint default kNone_SkFilterQuality, and stays within |
Cary Clark | bc5697d | 2017-10-04 14:31:33 -0400 | [diff] [blame] | 3044 | its bounds; there is no bleeding with kFast_SrcRectConstraint. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3045 | the middle and right bitmaps draw with kLow_SkFilterQuality; with |
| 3046 | kStrict_SrcRectConstraint, the filter remains within the checkerboard, and |
| 3047 | with kFast_SrcRectConstraint red bleeds on the edges. |
| 3048 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3049 | void draw(SkCanvas* canvas) { |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3050 | uint32_t pixels[][4] = { |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3051 | { 0xFFFF0000, 0xFFFF0000, 0xFFFF0000, 0xFFFF0000 }, |
| 3052 | { 0xFFFF0000, 0xFF000000, 0xFFFFFFFF, 0xFFFF0000 }, |
| 3053 | { 0xFFFF0000, 0xFFFFFFFF, 0xFF000000, 0xFFFF0000 }, |
| 3054 | { 0xFFFF0000, 0xFFFF0000, 0xFFFF0000, 0xFFFF0000 } }; |
| 3055 | SkBitmap redBorder; |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3056 | redBorder.installPixels(SkImageInfo::MakeN32Premul(4, 4), |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3057 | (void*) pixels, sizeof(pixels[0])); |
| 3058 | sk_sp<SkImage> image = SkImage::MakeFromBitmap(redBorder); |
| 3059 | SkPaint lowPaint; |
| 3060 | for (auto constraint : { |
| 3061 | SkCanvas::kFast_SrcRectConstraint, |
| 3062 | SkCanvas::kStrict_SrcRectConstraint, |
| 3063 | SkCanvas::kFast_SrcRectConstraint } ) { |
| 3064 | canvas->drawImageRect(image.get(), SkRect::MakeLTRB(1, 1, 3, 3), |
| 3065 | SkRect::MakeLTRB(16, 16, 48, 48), &lowPaint, constraint); |
| 3066 | lowPaint.setFilterQuality(kLow_SkFilterQuality); |
| 3067 | canvas->translate(80, 0); |
| 3068 | } |
| 3069 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3070 | ## |
| 3071 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 3072 | #SeeAlso SrcRectConstraint drawImage drawImageLattice drawImageNine |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3073 | |
| 3074 | ## |
| 3075 | |
| 3076 | # ------------------------------------------------------------------------------ |
| 3077 | |
| 3078 | #Method void drawImageRect(const SkImage* image, const SkIRect& isrc, const SkRect& dst, |
| 3079 | const SkPaint* paint, SrcRectConstraint constraint = kStrict_SrcRectConstraint) |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3080 | #In Draw_Image |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 3081 | #In Draw |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3082 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3083 | |
| 3084 | #Example |
| 3085 | #Image 4 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3086 | void draw(SkCanvas* canvas) { |
| 3087 | // sk_sp<SkImage> image; |
| 3088 | for (auto i : { 1, 2, 4, 8 } ) { |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3089 | canvas->drawImageRect(image.get(), SkIRect::MakeLTRB(0, 0, 100, 100), |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3090 | SkRect::MakeXYWH(i * 20, i * 20, i * 20, i * 20), nullptr); |
| 3091 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3092 | } |
| 3093 | ## |
| 3094 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 3095 | #SeeAlso SrcRectConstraint drawImage drawImageLattice drawImageNine |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3096 | |
| 3097 | ## |
| 3098 | |
| 3099 | # ------------------------------------------------------------------------------ |
| 3100 | |
Cary Clark | 0ac0edd | 2018-10-29 11:28:43 -0400 | [diff] [blame] | 3101 | #Method void drawImageRect(const SkImage* image, const SkRect& dst, const SkPaint* paint) |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3102 | #In Draw_Image |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 3103 | #In Draw |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3104 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3105 | |
| 3106 | #Example |
| 3107 | #Image 4 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3108 | void draw(SkCanvas* canvas) { |
| 3109 | // sk_sp<SkImage> image; |
| 3110 | for (auto i : { 20, 40, 80, 160 } ) { |
| 3111 | canvas->drawImageRect(image.get(), SkRect::MakeXYWH(i, i, i, i), nullptr); |
| 3112 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3113 | } |
| 3114 | ## |
| 3115 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 3116 | #SeeAlso SrcRectConstraint drawImage drawImageLattice drawImageNine |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3117 | |
| 3118 | ## |
| 3119 | |
| 3120 | # ------------------------------------------------------------------------------ |
| 3121 | |
| 3122 | #Method void drawImageRect(const sk_sp<SkImage>& image, const SkRect& src, const SkRect& dst, |
| 3123 | const SkPaint* paint, |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3124 | SrcRectConstraint constraint = kStrict_SrcRectConstraint) |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3125 | #In Draw_Image |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 3126 | #In Draw |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3127 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3128 | |
| 3129 | #Example |
| 3130 | #Height 64 |
| 3131 | #Description |
| 3132 | Canvas scales and translates; transformation from src to dst also scales. |
| 3133 | The two matrices are concatenated to create the final transformation. |
| 3134 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3135 | void draw(SkCanvas* canvas) { |
| 3136 | uint32_t pixels[][2] = { { SK_ColorBLACK, SK_ColorWHITE }, |
| 3137 | { SK_ColorWHITE, SK_ColorBLACK } }; |
| 3138 | SkBitmap bitmap; |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3139 | bitmap.installPixels(SkImageInfo::MakeN32Premul(2, 2), |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3140 | (void*) pixels, sizeof(pixels[0])); |
| 3141 | sk_sp<SkImage> image = SkImage::MakeFromBitmap(bitmap); |
| 3142 | SkPaint paint; |
| 3143 | canvas->scale(4, 4); |
| 3144 | for (auto alpha : { 50, 100, 150, 255 } ) { |
| 3145 | paint.setAlpha(alpha); |
| 3146 | canvas->drawImageRect(image, SkRect::MakeWH(2, 2), SkRect::MakeWH(8, 8), &paint); |
| 3147 | canvas->translate(8, 0); |
| 3148 | } |
| 3149 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3150 | ## |
| 3151 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 3152 | #SeeAlso SrcRectConstraint drawImage drawImageLattice drawImageNine |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3153 | |
| 3154 | ## |
| 3155 | |
| 3156 | # ------------------------------------------------------------------------------ |
| 3157 | |
| 3158 | #Method void drawImageRect(const sk_sp<SkImage>& image, const SkIRect& isrc, const SkRect& dst, |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3159 | const SkPaint* paint, SrcRectConstraint constraint = kStrict_SrcRectConstraint) |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3160 | #In Draw_Image |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 3161 | #In Draw |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3162 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3163 | |
| 3164 | #Example |
| 3165 | #Height 64 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3166 | void draw(SkCanvas* canvas) { |
| 3167 | uint32_t pixels[][2] = { { 0x00000000, 0x55555555}, |
| 3168 | { 0xAAAAAAAA, 0xFFFFFFFF} }; |
| 3169 | SkBitmap bitmap; |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3170 | bitmap.installPixels(SkImageInfo::MakeN32Premul(2, 2), |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3171 | (void*) pixels, sizeof(pixels[0])); |
| 3172 | sk_sp<SkImage> image = SkImage::MakeFromBitmap(bitmap); |
| 3173 | SkPaint paint; |
| 3174 | canvas->scale(4, 4); |
| 3175 | for (auto color : { SK_ColorRED, SK_ColorBLUE, SK_ColorGREEN } ) { |
| 3176 | paint.setColorFilter(SkColorFilter::MakeModeFilter(color, SkBlendMode::kPlus)); |
| 3177 | canvas->drawImageRect(image, SkIRect::MakeWH(2, 2), SkRect::MakeWH(8, 8), &paint); |
| 3178 | canvas->translate(8, 0); |
| 3179 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3180 | } |
| 3181 | ## |
| 3182 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 3183 | #SeeAlso SrcRectConstraint drawImage drawImageLattice drawImageNine |
| 3184 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3185 | ## |
| 3186 | |
| 3187 | # ------------------------------------------------------------------------------ |
| 3188 | |
Cary Clark | 0ac0edd | 2018-10-29 11:28:43 -0400 | [diff] [blame] | 3189 | #Method void drawImageRect(const sk_sp<SkImage>& image, const SkRect& dst, const SkPaint* paint) |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3190 | #In Draw_Image |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 3191 | #In Draw |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3192 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3193 | |
| 3194 | #Example |
| 3195 | #Height 64 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3196 | void draw(SkCanvas* canvas) { |
| 3197 | uint32_t pixels[][2] = { { 0x00000000, 0x55550000}, |
| 3198 | { 0xAAAA0000, 0xFFFF0000} }; |
| 3199 | SkBitmap bitmap; |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3200 | bitmap.installPixels(SkImageInfo::MakeN32Premul(2, 2), |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3201 | (void*) pixels, sizeof(pixels[0])); |
| 3202 | sk_sp<SkImage> image = SkImage::MakeFromBitmap(bitmap); |
| 3203 | SkPaint paint; |
| 3204 | canvas->scale(4, 4); |
| 3205 | for (auto color : { SK_ColorRED, SK_ColorBLUE, SK_ColorGREEN } ) { |
| 3206 | paint.setColorFilter(SkColorFilter::MakeModeFilter(color, SkBlendMode::kPlus)); |
| 3207 | canvas->drawImageRect(image, SkRect::MakeWH(8, 8), &paint); |
| 3208 | canvas->translate(8, 0); |
| 3209 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3210 | } |
| 3211 | ## |
| 3212 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 3213 | #SeeAlso SrcRectConstraint drawImage drawImageLattice drawImageNine |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3214 | |
| 3215 | ## |
| 3216 | |
| 3217 | # ------------------------------------------------------------------------------ |
| 3218 | |
| 3219 | #Method void drawImageNine(const SkImage* image, const SkIRect& center, const SkRect& dst, |
| 3220 | const SkPaint* paint = nullptr) |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3221 | #In Draw_Image |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 3222 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3223 | #Line # draws Nine_Patch Image ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3224 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 3225 | Draws Image image stretched proportionally to fit into Rect dst. |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3226 | IRect center divides the image into nine sections: four sides, four corners, and |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 3227 | the center. Corners are unmodified or scaled down proportionately if their sides |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3228 | are larger than dst; center and four sides are scaled to fit remaining space, if any. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3229 | |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3230 | Additionally transform draw using Clip, Matrix, and optional Paint paint. |
| 3231 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3232 | #paint_as_used_by_draw_lattice_or_draw_nine(image)# |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3233 | |
| 3234 | If generated mask extends beyond image bounds, replicate image edge colors, just |
| 3235 | as Shader made from SkImage::makeShader with SkShader::kClamp_TileMode set |
Cary Clark | bc5697d | 2017-10-04 14:31:33 -0400 | [diff] [blame] | 3236 | replicates the image edge color when it samples outside of its bounds. |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3237 | |
| 3238 | #Param image Image containing pixels, dimensions, and format ## |
| 3239 | #Param center IRect edge of image corners and sides ## |
| 3240 | #Param dst destination Rect of image to draw to ## |
| 3241 | #Param paint Paint containing Blend_Mode, Color_Filter, Image_Filter, |
| 3242 | and so on; or nullptr |
| 3243 | ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3244 | |
| 3245 | #Example |
| 3246 | #Height 128 |
| 3247 | #Description |
| 3248 | The leftmost image is smaller than center; only corners are drawn, all scaled to fit. |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 3249 | The second image equals the size of center; only corners are drawn without scaling. |
| 3250 | The remaining images are larger than center. All corners draw without scaling. |
| 3251 | The sides and center are scaled if needed to take up the remaining space. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3252 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3253 | void draw(SkCanvas* canvas) { |
| 3254 | SkIRect center = { 20, 10, 50, 40 }; |
| 3255 | SkBitmap bitmap; |
| 3256 | bitmap.allocPixels(SkImageInfo::MakeN32Premul(60, 60)); |
| 3257 | SkCanvas bitCanvas(bitmap); |
| 3258 | SkPaint paint; |
| 3259 | SkColor gray = 0xFF000000; |
| 3260 | int left = 0; |
| 3261 | for (auto right: { center.fLeft, center.fRight, bitmap.width() } ) { |
| 3262 | int top = 0; |
| 3263 | for (auto bottom: { center.fTop, center.fBottom, bitmap.height() } ) { |
| 3264 | paint.setColor(gray); |
| 3265 | bitCanvas.drawIRect(SkIRect::MakeLTRB(left, top, right, bottom), paint); |
| 3266 | gray += 0x001f1f1f; |
| 3267 | top = bottom; |
| 3268 | } |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3269 | left = right; |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3270 | } |
| 3271 | sk_sp<SkImage> image = SkImage::MakeFromBitmap(bitmap); |
| 3272 | SkImage* imagePtr = image.get(); |
| 3273 | for (auto dest: { 20, 30, 40, 60, 90 } ) { |
| 3274 | canvas->drawImageNine(imagePtr, center, SkRect::MakeWH(dest, dest), nullptr); |
| 3275 | canvas->translate(dest + 4, 0); |
| 3276 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3277 | } |
| 3278 | ## |
| 3279 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 3280 | #SeeAlso drawImage drawBitmapNine drawImageLattice drawImageRect |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3281 | |
| 3282 | ## |
| 3283 | |
| 3284 | # ------------------------------------------------------------------------------ |
| 3285 | |
| 3286 | #Method void drawImageNine(const sk_sp<SkImage>& image, const SkIRect& center, const SkRect& dst, |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3287 | const SkPaint* paint = nullptr) |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3288 | #In Draw_Image |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 3289 | #In Draw |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 3290 | Draws Image image stretched proportionally to fit into Rect dst. |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3291 | IRect center divides the image into nine sections: four sides, four corners, and |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 3292 | the center. Corners are not scaled, or scaled down proportionately if their sides |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3293 | are larger than dst; center and four sides are scaled to fit remaining space, if any. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3294 | |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3295 | Additionally transform draw using Clip, Matrix, and optional Paint paint. |
| 3296 | |
Cary Clark | 137b874 | 2018-05-30 09:21:49 -0400 | [diff] [blame] | 3297 | #paint_as_used_by_draw_lattice_or_draw_nine(image)# |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3298 | |
| 3299 | If generated mask extends beyond image bounds, replicate image edge colors, just |
| 3300 | as Shader made from SkImage::makeShader with SkShader::kClamp_TileMode set |
Cary Clark | bc5697d | 2017-10-04 14:31:33 -0400 | [diff] [blame] | 3301 | replicates the image edge color when it samples outside of its bounds. |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3302 | |
| 3303 | #Param image Image containing pixels, dimensions, and format ## |
| 3304 | #Param center IRect edge of image corners and sides ## |
| 3305 | #Param dst destination Rect of image to draw to ## |
| 3306 | #Param paint Paint containing Blend_Mode, Color_Filter, Image_Filter, |
| 3307 | and so on; or nullptr |
| 3308 | ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3309 | |
| 3310 | #Example |
| 3311 | #Height 128 |
| 3312 | #Description |
| 3313 | The two leftmost images has four corners and sides to the left and right of center. |
| 3314 | The leftmost image scales the width of corners proportionately to fit. |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3315 | The third and fourth image corners are not scaled; the sides and center are scaled to |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3316 | fill the remaining space. |
| 3317 | The rightmost image has four corners scaled vertically to fit, and uses sides above |
| 3318 | and below center to fill the remaining space. |
| 3319 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3320 | void draw(SkCanvas* canvas) { |
| 3321 | SkIRect center = { 20, 10, 50, 40 }; |
| 3322 | SkBitmap bitmap; |
| 3323 | bitmap.allocPixels(SkImageInfo::MakeN32Premul(60, 60)); |
| 3324 | SkCanvas bitCanvas(bitmap); |
| 3325 | SkPaint paint; |
| 3326 | SkColor gray = 0xFF000000; |
| 3327 | int left = 0; |
| 3328 | for (auto right: { center.fLeft, center.fRight, bitmap.width() } ) { |
| 3329 | int top = 0; |
| 3330 | for (auto bottom: { center.fTop, center.fBottom, bitmap.height() } ) { |
| 3331 | paint.setColor(gray); |
| 3332 | bitCanvas.drawIRect(SkIRect::MakeLTRB(left, top, right, bottom), paint); |
| 3333 | gray += 0x001f1f1f; |
| 3334 | top = bottom; |
| 3335 | } |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3336 | left = right; |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3337 | } |
| 3338 | sk_sp<SkImage> image = SkImage::MakeFromBitmap(bitmap); |
| 3339 | for (auto dest: { 20, 30, 40, 60, 90 } ) { |
| 3340 | canvas->drawImageNine(image, center, SkRect::MakeWH(dest, 110 - dest), nullptr); |
| 3341 | canvas->translate(dest + 4, 0); |
| 3342 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3343 | } |
| 3344 | ## |
| 3345 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 3346 | #SeeAlso drawImage drawBitmapNine drawImageLattice drawImageRect |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3347 | |
| 3348 | ## |
| 3349 | |
| 3350 | # ------------------------------------------------------------------------------ |
| 3351 | |
| 3352 | #Method void drawBitmap(const SkBitmap& bitmap, SkScalar left, SkScalar top, |
Cary Clark | 73fa972 | 2017-08-29 17:36:51 -0400 | [diff] [blame] | 3353 | const SkPaint* paint = nullptr) |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3354 | #In Draw_Image |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 3355 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3356 | #Line # draws Bitmap at (x, y) position ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3357 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3358 | |
| 3359 | #Example |
| 3360 | #Height 64 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3361 | void draw(SkCanvas* canvas) { |
| 3362 | uint8_t pixels[][8] = { { 0x00, 0x00, 0x00, 0xFF, 0xFF, 0x00, 0x00, 0x00}, |
| 3363 | { 0x00, 0x00, 0xFF, 0xFF, 0xFF, 0xFF, 0x00, 0x00}, |
| 3364 | { 0x00, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x00}, |
| 3365 | { 0xFF, 0xFF, 0x00, 0xFF, 0xFF, 0x00, 0xFF, 0xFF}, |
| 3366 | { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}, |
| 3367 | { 0x00, 0x00, 0xFF, 0x00, 0x00, 0xFF, 0x00, 0x00}, |
| 3368 | { 0x00, 0xFF, 0x00, 0xFF, 0xFF, 0x00, 0xFF, 0x00}, |
| 3369 | { 0xFF, 0x00, 0xFF, 0x00, 0x00, 0xFF, 0x00, 0xFF} }; |
| 3370 | SkBitmap bitmap; |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3371 | bitmap.installPixels(SkImageInfo::MakeA8(8, 8), |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3372 | (void*) pixels, sizeof(pixels[0])); |
| 3373 | SkPaint paint; |
| 3374 | canvas->scale(4, 4); |
| 3375 | for (auto color : { SK_ColorRED, SK_ColorBLUE, 0xFF007F00} ) { |
| 3376 | paint.setColor(color); |
| 3377 | canvas->drawBitmap(bitmap, 0, 0, &paint); |
| 3378 | canvas->translate(12, 0); |
| 3379 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3380 | } |
| 3381 | ## |
| 3382 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 3383 | #SeeAlso drawImage drawBitmapLattice drawBitmapNine drawBitmapRect SkBitmap::readPixels SkBitmap::writePixels |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3384 | |
| 3385 | ## |
| 3386 | |
| 3387 | # ------------------------------------------------------------------------------ |
| 3388 | |
| 3389 | #Method void drawBitmapRect(const SkBitmap& bitmap, const SkRect& src, const SkRect& dst, |
| 3390 | const SkPaint* paint, SrcRectConstraint constraint = kStrict_SrcRectConstraint) |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3391 | #In Draw_Image |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 3392 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3393 | #Line # draws Bitmap, source Rect to destination Rect ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3394 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3395 | |
| 3396 | #Example |
| 3397 | #Height 64 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3398 | void draw(SkCanvas* canvas) { |
| 3399 | uint8_t pixels[][8] = { { 0x00, 0x00, 0x00, 0xFF, 0xFF, 0x00, 0x00, 0x00}, |
| 3400 | { 0x00, 0x00, 0xFF, 0xFF, 0xFF, 0xFF, 0x00, 0x00}, |
| 3401 | { 0x00, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x00}, |
| 3402 | { 0xFF, 0xFF, 0x00, 0xFF, 0xFF, 0x00, 0xFF, 0xFF}, |
| 3403 | { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}, |
| 3404 | { 0x00, 0x00, 0xFF, 0x00, 0x00, 0xFF, 0x00, 0x00}, |
| 3405 | { 0x00, 0xFF, 0x00, 0x00, 0x00, 0x00, 0xFF, 0x00}, |
| 3406 | { 0x00, 0x00, 0xFF, 0x00, 0x00, 0xFF, 0x00, 0x00} }; |
| 3407 | SkBitmap bitmap; |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3408 | bitmap.installPixels(SkImageInfo::MakeA8(8, 8), |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3409 | (void*) pixels, sizeof(pixels[0])); |
| 3410 | SkPaint paint; |
Cary Clark | 681287e | 2018-03-16 11:34:15 -0400 | [diff] [blame] | 3411 | paint.setMaskFilter(SkMaskFilter::MakeBlur(kSolid_SkBlurStyle, 6)); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3412 | for (auto color : { SK_ColorRED, SK_ColorBLUE, 0xFF007F00} ) { |
| 3413 | paint.setColor(color); |
| 3414 | canvas->drawBitmapRect(bitmap, SkRect::MakeWH(8, 8), SkRect::MakeWH(32, 32), &paint); |
| 3415 | canvas->translate(48, 0); |
| 3416 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3417 | } |
| 3418 | ## |
| 3419 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 3420 | #SeeAlso drawImageRect drawBitmap drawBitmapLattice drawBitmapNine |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3421 | |
| 3422 | ## |
| 3423 | |
| 3424 | # ------------------------------------------------------------------------------ |
| 3425 | |
| 3426 | #Method void drawBitmapRect(const SkBitmap& bitmap, const SkIRect& isrc, const SkRect& dst, |
| 3427 | const SkPaint* paint, SrcRectConstraint constraint = kStrict_SrcRectConstraint) |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3428 | #In Draw_Image |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 3429 | #In Draw |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3430 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3431 | |
| 3432 | #Example |
| 3433 | #Height 64 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3434 | void draw(SkCanvas* canvas) { |
| 3435 | uint8_t pixels[][8] = { { 0x00, 0x00, 0xFF, 0xFF, 0xFF, 0xFF, 0x00, 0x00}, |
| 3436 | { 0x00, 0xFF, 0x00, 0x00, 0x00, 0x00, 0xFF, 0x00}, |
| 3437 | { 0xFF, 0x00, 0xFF, 0x00, 0xFF, 0x00, 0x00, 0xFF}, |
| 3438 | { 0xFF, 0x00, 0xFF, 0x00, 0xFF, 0x00, 0x00, 0xFF}, |
| 3439 | { 0xFF, 0x00, 0x00, 0x00, 0x00, 0xFF, 0x00, 0xFF}, |
| 3440 | { 0xFF, 0x00, 0xFF, 0xFF, 0xFF, 0x00, 0x00, 0xFF}, |
| 3441 | { 0x00, 0xFF, 0x00, 0x00, 0x00, 0x00, 0xFF, 0x00}, |
| 3442 | { 0x00, 0x00, 0xFF, 0xFF, 0xFF, 0xFF, 0x00, 0x00} }; |
| 3443 | SkBitmap bitmap; |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3444 | bitmap.installPixels(SkImageInfo::MakeA8(8, 8), |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3445 | (void*) pixels, sizeof(pixels[0])); |
| 3446 | SkPaint paint; |
| 3447 | paint.setFilterQuality(kHigh_SkFilterQuality); |
| 3448 | for (auto color : { SK_ColorRED, SK_ColorBLUE, 0xFF007F00, 0xFF7f007f} ) { |
| 3449 | paint.setColor(color); |
| 3450 | canvas->drawBitmapRect(bitmap, SkIRect::MakeWH(8, 8), SkRect::MakeWH(32, 32), &paint); |
| 3451 | canvas->translate(48.25f, 0); |
| 3452 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3453 | } |
| 3454 | ## |
| 3455 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 3456 | #SeeAlso drawImageRect drawBitmap drawBitmapLattice drawBitmapNine |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3457 | |
| 3458 | ## |
| 3459 | |
| 3460 | # ------------------------------------------------------------------------------ |
| 3461 | |
| 3462 | #Method void drawBitmapRect(const SkBitmap& bitmap, const SkRect& dst, const SkPaint* paint, |
| 3463 | SrcRectConstraint constraint = kStrict_SrcRectConstraint) |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3464 | #In Draw_Image |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 3465 | #In Draw |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3466 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3467 | |
| 3468 | #Example |
| 3469 | #Height 64 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3470 | void draw(SkCanvas* canvas) { |
| 3471 | uint32_t pixels[][2] = { { 0x00000000, 0x55550000}, |
| 3472 | { 0xAAAA0000, 0xFFFF0000} }; |
| 3473 | SkBitmap bitmap; |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3474 | bitmap.installPixels(SkImageInfo::MakeN32Premul(2, 2), |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3475 | (void*) pixels, sizeof(pixels[0])); |
| 3476 | SkPaint paint; |
| 3477 | canvas->scale(4, 4); |
| 3478 | for (auto color : { SK_ColorRED, SK_ColorBLUE, SK_ColorGREEN } ) { |
| 3479 | paint.setColorFilter(SkColorFilter::MakeModeFilter(color, SkBlendMode::kPlus)); |
| 3480 | canvas->drawBitmapRect(bitmap, SkRect::MakeWH(8, 8), &paint); |
| 3481 | canvas->translate(8, 0); |
| 3482 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3483 | } |
| 3484 | ## |
| 3485 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 3486 | #SeeAlso drawImageRect drawBitmap drawBitmapLattice drawBitmapNine |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3487 | |
| 3488 | ## |
| 3489 | |
| 3490 | # ------------------------------------------------------------------------------ |
| 3491 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3492 | #PhraseDef paint_as_used_by_draw_lattice_or_draw_nine(bitmap_or_image) |
| 3493 | If Paint paint is supplied, apply Color_Filter, Color_Alpha, Image_Filter, |
| 3494 | Blend_Mode, and Draw_Looper. If #bitmap_or_image# is kAlpha_8_SkColorType, apply Shader. |
| 3495 | If paint contains Mask_Filter, generate mask from #bitmap_or_image# bounds. If paint |
| 3496 | Filter_Quality set to kNone_SkFilterQuality, disable pixel filtering. For all |
| 3497 | other values of paint Filter_Quality, use kLow_SkFilterQuality to filter pixels. |
Cary Clark | 137b874 | 2018-05-30 09:21:49 -0400 | [diff] [blame] | 3498 | Any SkMaskFilter on paint is ignored as is paint Anti_Aliasing state. |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3499 | ## |
| 3500 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3501 | #Method void drawBitmapNine(const SkBitmap& bitmap, const SkIRect& center, const SkRect& dst, |
Cary Clark | 73fa972 | 2017-08-29 17:36:51 -0400 | [diff] [blame] | 3502 | const SkPaint* paint = nullptr) |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3503 | #In Draw_Image |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 3504 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3505 | #Line # draws Nine_Patch Bitmap ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3506 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 3507 | Draws Bitmap bitmap stretched proportionally to fit into Rect dst. |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3508 | IRect center divides the bitmap into nine sections: four sides, four corners, |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 3509 | and the center. Corners are not scaled, or scaled down proportionately if their |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3510 | sides are larger than dst; center and four sides are scaled to fit remaining |
| 3511 | space, if any. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3512 | |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3513 | Additionally transform draw using Clip, Matrix, and optional Paint paint. |
| 3514 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3515 | #paint_as_used_by_draw_lattice_or_draw_nine(bitmap)# |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3516 | |
| 3517 | If generated mask extends beyond bitmap bounds, replicate bitmap edge colors, |
| 3518 | just as Shader made from SkShader::MakeBitmapShader with |
Cary Clark | bc5697d | 2017-10-04 14:31:33 -0400 | [diff] [blame] | 3519 | SkShader::kClamp_TileMode set replicates the bitmap edge color when it samples |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3520 | outside of its bounds. |
| 3521 | |
| 3522 | #Param bitmap Bitmap containing pixels, dimensions, and format ## |
| 3523 | #Param center IRect edge of image corners and sides ## |
| 3524 | #Param dst destination Rect of image to draw to ## |
| 3525 | #Param paint Paint containing Blend_Mode, Color_Filter, Image_Filter, |
| 3526 | and so on; or nullptr |
| 3527 | ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3528 | |
| 3529 | #Example |
| 3530 | #Height 128 |
| 3531 | #Description |
| 3532 | The two leftmost bitmap draws has four corners and sides to the left and right of center. |
| 3533 | The leftmost bitmap draw scales the width of corners proportionately to fit. |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3534 | The third and fourth draw corners are not scaled; the sides and center are scaled to |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3535 | fill the remaining space. |
| 3536 | The rightmost bitmap draw has four corners scaled vertically to fit, and uses sides above |
| 3537 | and below center to fill the remaining space. |
| 3538 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3539 | void draw(SkCanvas* canvas) { |
| 3540 | SkIRect center = { 20, 10, 50, 40 }; |
| 3541 | SkBitmap bitmap; |
| 3542 | bitmap.allocPixels(SkImageInfo::MakeN32Premul(60, 60)); |
| 3543 | SkCanvas bitCanvas(bitmap); |
| 3544 | SkPaint paint; |
| 3545 | SkColor gray = 0xFF000000; |
| 3546 | int left = 0; |
| 3547 | for (auto right: { center.fLeft, center.fRight, bitmap.width() } ) { |
| 3548 | int top = 0; |
| 3549 | for (auto bottom: { center.fTop, center.fBottom, bitmap.height() } ) { |
| 3550 | paint.setColor(gray); |
| 3551 | bitCanvas.drawIRect(SkIRect::MakeLTRB(left, top, right, bottom), paint); |
| 3552 | gray += 0x001f1f1f; |
| 3553 | top = bottom; |
| 3554 | } |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3555 | left = right; |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3556 | } |
| 3557 | for (auto dest: { 20, 30, 40, 60, 90 } ) { |
| 3558 | canvas->drawBitmapNine(bitmap, center, SkRect::MakeWH(dest, 110 - dest), nullptr); |
| 3559 | canvas->translate(dest + 4, 0); |
| 3560 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3561 | } |
| 3562 | ## |
| 3563 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 3564 | #SeeAlso drawImageNine drawBitmap drawBitmapLattice drawBitmapRect |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3565 | |
| 3566 | ## |
| 3567 | |
| 3568 | # ------------------------------------------------------------------------------ |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3569 | #Subtopic Lattice |
| 3570 | #Line # divides Bitmap or Image into a rectangular grid ## |
| 3571 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3572 | #Struct Lattice |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3573 | #Line # divides Bitmap or Image into a rectangular grid ## |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3574 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3575 | #Code |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 3576 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3577 | ## |
| 3578 | |
Cary Clark | 137b874 | 2018-05-30 09:21:49 -0400 | [diff] [blame] | 3579 | Lattice divides Bitmap or Image into a rectangular grid. |
| 3580 | Grid entries on even columns and even rows are fixed; these entries are |
| 3581 | always drawn at their original size if the destination is large enough. |
| 3582 | If the destination side is too small to hold the fixed entries, all fixed |
| 3583 | entries are proportionately scaled down to fit. |
| 3584 | The grid entries not on even columns and rows are scaled to fit the |
| 3585 | remaining space, if any. |
| 3586 | |
Cary Clark | 2f46624 | 2017-12-11 16:03:17 -0500 | [diff] [blame] | 3587 | #Enum RectType |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3588 | #Line # optional setting per rectangular grid entry ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3589 | #Code |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 3590 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3591 | ## |
| 3592 | |
Cary Clark | 2f46624 | 2017-12-11 16:03:17 -0500 | [diff] [blame] | 3593 | Optional setting per rectangular grid entry to make it transparent, |
| 3594 | or to fill the grid entry with a color. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3595 | |
Cary Clark | 2f46624 | 2017-12-11 16:03:17 -0500 | [diff] [blame] | 3596 | #Const kDefault 0 |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3597 | #Line # draws Bitmap into lattice rectangle ## |
Cary Clark | 2f46624 | 2017-12-11 16:03:17 -0500 | [diff] [blame] | 3598 | ## |
| 3599 | |
| 3600 | #Const kTransparent 1 |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3601 | #Line # skips lattice rectangle by making it transparent ## |
Cary Clark | 2f46624 | 2017-12-11 16:03:17 -0500 | [diff] [blame] | 3602 | ## |
| 3603 | |
| 3604 | #Const kFixedColor 2 |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3605 | #Line # draws one of fColors into lattice rectangle ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3606 | ## |
| 3607 | ## |
| 3608 | |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 3609 | #Subtopic Members |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3610 | ## |
| 3611 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3612 | #Member const int* fXDivs |
Cary Clark | 5538c13 | 2018-06-14 12:28:14 -0400 | [diff] [blame] | 3613 | #Line # x-axis values dividing bitmap ## |
| 3614 | Array of x-axis values that divide the bitmap vertically. |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3615 | Array entries must be unique, increasing, greater than or equal to |
| 3616 | fBounds left edge, and less than fBounds right edge. |
| 3617 | Set the first element to fBounds left to collapse the left column of |
| 3618 | fixed grid entries. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3619 | ## |
| 3620 | |
| 3621 | #Member const int* fYDivs |
Cary Clark | 5538c13 | 2018-06-14 12:28:14 -0400 | [diff] [blame] | 3622 | #Line # y-axis values dividing bitmap ## |
| 3623 | Array of y-axis values that divide the bitmap horizontally. |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3624 | Array entries must be unique, increasing, greater than or equal to |
| 3625 | fBounds top edge, and less than fBounds bottom edge. |
| 3626 | Set the first element to fBounds top to collapse the top row of fixed |
| 3627 | grid entries. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3628 | ## |
| 3629 | |
Cary Clark | 2f46624 | 2017-12-11 16:03:17 -0500 | [diff] [blame] | 3630 | #Member const RectType* fRectTypes |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3631 | #Line # array of fill types ## |
Cary Clark | 2f46624 | 2017-12-11 16:03:17 -0500 | [diff] [blame] | 3632 | Optional array of fill types, one per rectangular grid entry: |
Cary Clark | 2be81cf | 2018-09-13 12:04:30 -0400 | [diff] [blame] | 3633 | array length must be #Formula # (fXCount + 1) * (fYCount + 1) ##. |
Cary Clark | 6fc5041 | 2017-09-21 12:31:06 -0400 | [diff] [blame] | 3634 | |
Cary Clark | 2f46624 | 2017-12-11 16:03:17 -0500 | [diff] [blame] | 3635 | Each RectType is one of: kDefault, kTransparent, kFixedColor. |
| 3636 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3637 | Array entries correspond to the rectangular grid entries, ascending |
| 3638 | left to right and then top to bottom. |
| 3639 | ## |
| 3640 | |
| 3641 | #Member int fXCount |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3642 | #Line # number of x-coordinates ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3643 | Number of entries in fXDivs array; one less than the number of |
| 3644 | horizontal divisions. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3645 | ## |
| 3646 | |
| 3647 | #Member int fYCount |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3648 | #Line # number of y-coordinates ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3649 | Number of entries in fYDivs array; one less than the number of vertical |
| 3650 | divisions. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3651 | ## |
| 3652 | |
| 3653 | #Member const SkIRect* fBounds |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3654 | #Line # source bounds to draw from ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3655 | Optional subset IRect source to draw from. |
| 3656 | If nullptr, source bounds is dimensions of Bitmap or Image. |
| 3657 | ## |
| 3658 | |
Cary Clark | 2f46624 | 2017-12-11 16:03:17 -0500 | [diff] [blame] | 3659 | #Member const SkColor* fColors |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3660 | #Line # array of colors ## |
Cary Clark | 2f46624 | 2017-12-11 16:03:17 -0500 | [diff] [blame] | 3661 | Optional array of colors, one per rectangular grid entry. |
Cary Clark | 2be81cf | 2018-09-13 12:04:30 -0400 | [diff] [blame] | 3662 | Array length must be #Formula # (fXCount + 1) * (fYCount + 1) ##. |
Cary Clark | 2f46624 | 2017-12-11 16:03:17 -0500 | [diff] [blame] | 3663 | |
| 3664 | Array entries correspond to the rectangular grid entries, ascending |
| 3665 | left to right, then top to bottom. |
| 3666 | ## |
| 3667 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3668 | #Struct Lattice ## |
| 3669 | |
| 3670 | #Method void drawBitmapLattice(const SkBitmap& bitmap, const Lattice& lattice, const SkRect& dst, |
| 3671 | const SkPaint* paint = nullptr) |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3672 | #In Draw_Image |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 3673 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3674 | #Line # draws proportionally stretched Bitmap ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3675 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 3676 | Draws Bitmap bitmap stretched proportionally to fit into Rect dst. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3677 | |
| 3678 | Lattice lattice divides bitmap into a rectangular grid. |
| 3679 | Each intersection of an even-numbered row and column is fixed; like the corners |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3680 | of drawBitmapNine, fixed lattice elements never scale larger than their initial |
Cary Clark | bc5697d | 2017-10-04 14:31:33 -0400 | [diff] [blame] | 3681 | size and shrink proportionately when all fixed elements exceed the bitmap |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3682 | dimension. All other grid elements scale to fill the available space, if any. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3683 | |
| 3684 | Additionally transform draw using Clip, Matrix, and optional Paint paint. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3685 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3686 | #paint_as_used_by_draw_lattice_or_draw_nine(bitmap)# |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3687 | |
| 3688 | If generated mask extends beyond bitmap bounds, replicate bitmap edge colors, |
| 3689 | just as Shader made from SkShader::MakeBitmapShader with |
Cary Clark | bc5697d | 2017-10-04 14:31:33 -0400 | [diff] [blame] | 3690 | SkShader::kClamp_TileMode set replicates the bitmap edge color when it samples |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3691 | outside of its bounds. |
| 3692 | |
| 3693 | #Param bitmap Bitmap containing pixels, dimensions, and format ## |
| 3694 | #Param lattice division of bitmap into fixed and variable rectangles ## |
| 3695 | #Param dst destination Rect of image to draw to ## |
| 3696 | #Param paint Paint containing Blend_Mode, Color_Filter, Image_Filter, |
| 3697 | and so on; or nullptr |
| 3698 | ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3699 | |
| 3700 | #Example |
| 3701 | #Height 128 |
| 3702 | #Description |
| 3703 | The two leftmost bitmap draws has four corners and sides to the left and right of center. |
| 3704 | The leftmost bitmap draw scales the width of corners proportionately to fit. |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3705 | The third and fourth draw corners are not scaled; the sides are scaled to |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3706 | fill the remaining space; the center is transparent. |
| 3707 | The rightmost bitmap draw has four corners scaled vertically to fit, and uses sides above |
| 3708 | and below center to fill the remaining space. |
| 3709 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3710 | void draw(SkCanvas* canvas) { |
| 3711 | SkIRect center = { 20, 10, 50, 40 }; |
| 3712 | SkBitmap bitmap; |
| 3713 | bitmap.allocPixels(SkImageInfo::MakeN32Premul(60, 60)); |
| 3714 | SkCanvas bitCanvas(bitmap); |
| 3715 | SkPaint paint; |
| 3716 | SkColor gray = 0xFF000000; |
| 3717 | int left = 0; |
| 3718 | for (auto right: { center.fLeft, center.fRight, bitmap.width() } ) { |
| 3719 | int top = 0; |
| 3720 | for (auto bottom: { center.fTop, center.fBottom, bitmap.height() } ) { |
| 3721 | paint.setColor(gray); |
| 3722 | bitCanvas.drawIRect(SkIRect::MakeLTRB(left, top, right, bottom), paint); |
| 3723 | gray += 0x001f1f1f; |
| 3724 | top = bottom; |
| 3725 | } |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3726 | left = right; |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3727 | } |
| 3728 | const int xDivs[] = { center.fLeft, center.fRight }; |
| 3729 | const int yDivs[] = { center.fTop, center.fBottom }; |
Cary Clark | ca3ebcd | 2017-12-12 11:22:38 -0500 | [diff] [blame] | 3730 | SkCanvas::Lattice::RectType fillTypes[3][3]; |
| 3731 | memset(fillTypes, 0, sizeof(fillTypes)); |
| 3732 | fillTypes[1][1] = SkCanvas::Lattice::kTransparent; |
| 3733 | SkColor dummy[9]; // temporary pending bug fix |
| 3734 | SkCanvas::Lattice lattice = { xDivs, yDivs, fillTypes[0], SK_ARRAY_COUNT(xDivs), |
| 3735 | SK_ARRAY_COUNT(yDivs), nullptr, dummy }; |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3736 | for (auto dest: { 20, 30, 40, 60, 90 } ) { |
Cary Clark | ca3ebcd | 2017-12-12 11:22:38 -0500 | [diff] [blame] | 3737 | canvas->drawBitmapLattice(bitmap, lattice, SkRect::MakeWH(dest, 110 - dest), nullptr); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3738 | canvas->translate(dest + 4, 0); |
| 3739 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3740 | } |
| 3741 | ## |
| 3742 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 3743 | #SeeAlso drawImageLattice drawBitmap drawBitmapNine Lattice |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3744 | |
| 3745 | ## |
| 3746 | |
| 3747 | # ------------------------------------------------------------------------------ |
| 3748 | |
| 3749 | #Method void drawImageLattice(const SkImage* image, const Lattice& lattice, const SkRect& dst, |
| 3750 | const SkPaint* paint = nullptr) |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3751 | #In Draw_Image |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 3752 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3753 | #Line # draws proportionally stretched Image ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3754 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 3755 | Draws Image image stretched proportionally to fit into Rect dst. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3756 | |
| 3757 | Lattice lattice divides image into a rectangular grid. |
| 3758 | Each intersection of an even-numbered row and column is fixed; like the corners |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3759 | of drawBitmapNine, fixed lattice elements never scale larger than their initial |
Cary Clark | bc5697d | 2017-10-04 14:31:33 -0400 | [diff] [blame] | 3760 | size and shrink proportionately when all fixed elements exceed the bitmap |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3761 | dimension. All other grid elements scale to fill the available space, if any. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3762 | |
| 3763 | Additionally transform draw using Clip, Matrix, and optional Paint paint. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3764 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3765 | #paint_as_used_by_draw_lattice_or_draw_nine(image)# |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3766 | |
| 3767 | If generated mask extends beyond bitmap bounds, replicate bitmap edge colors, |
| 3768 | just as Shader made from SkShader::MakeBitmapShader with |
Cary Clark | bc5697d | 2017-10-04 14:31:33 -0400 | [diff] [blame] | 3769 | SkShader::kClamp_TileMode set replicates the bitmap edge color when it samples |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3770 | outside of its bounds. |
| 3771 | |
| 3772 | #Param image Image containing pixels, dimensions, and format ## |
| 3773 | #Param lattice division of bitmap into fixed and variable rectangles ## |
| 3774 | #Param dst destination Rect of image to draw to ## |
| 3775 | #Param paint Paint containing Blend_Mode, Color_Filter, Image_Filter, |
| 3776 | and so on; or nullptr |
| 3777 | ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3778 | |
| 3779 | #Example |
| 3780 | #Height 128 |
| 3781 | #Description |
| 3782 | The leftmost image is smaller than center; only corners are drawn, all scaled to fit. |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 3783 | The second image equals the size of center; only corners are drawn without scaling. |
| 3784 | The remaining images are larger than center. All corners draw without scaling. The sides |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3785 | are scaled if needed to take up the remaining space; the center is transparent. |
| 3786 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3787 | void draw(SkCanvas* canvas) { |
| 3788 | SkIRect center = { 20, 10, 50, 40 }; |
| 3789 | SkBitmap bitmap; |
| 3790 | bitmap.allocPixels(SkImageInfo::MakeN32Premul(60, 60)); |
| 3791 | SkCanvas bitCanvas(bitmap); |
| 3792 | SkPaint paint; |
| 3793 | SkColor gray = 0xFF000000; |
| 3794 | int left = 0; |
| 3795 | for (auto right: { center.fLeft, center.fRight, bitmap.width() } ) { |
| 3796 | int top = 0; |
| 3797 | for (auto bottom: { center.fTop, center.fBottom, bitmap.height() } ) { |
| 3798 | paint.setColor(gray); |
| 3799 | bitCanvas.drawIRect(SkIRect::MakeLTRB(left, top, right, bottom), paint); |
| 3800 | gray += 0x001f1f1f; |
| 3801 | top = bottom; |
| 3802 | } |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3803 | left = right; |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3804 | } |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3805 | sk_sp<SkImage> image = SkImage::MakeFromBitmap(bitmap); |
| 3806 | SkImage* imagePtr = image.get(); |
| 3807 | for (auto dest: { 20, 30, 40, 60, 90 } ) { |
| 3808 | canvas->drawImageNine(imagePtr, center, SkRect::MakeWH(dest, dest), nullptr); |
| 3809 | canvas->translate(dest + 4, 0); |
| 3810 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3811 | } |
| 3812 | ## |
| 3813 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 3814 | #SeeAlso drawBitmapLattice drawImage drawImageNine Lattice |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3815 | |
| 3816 | ## |
| 3817 | |
Cary Clark | 682c58d | 2018-05-16 07:07:07 -0400 | [diff] [blame] | 3818 | #Subtopic Lattice ## |
| 3819 | |
Cary Clark | 08895c4 | 2018-02-01 09:37:32 -0500 | [diff] [blame] | 3820 | #Subtopic Draw_Image ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3821 | |
| 3822 | # ------------------------------------------------------------------------------ |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 3823 | #Subtopic Draw_Text |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 3824 | #Line # draws text into Canvas ## |
| 3825 | ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3826 | |
Mike Reed | cb268f6 | 2019-01-07 12:51:32 -0500 | [diff] [blame] | 3827 | #Method void drawSimpleText(const void* text, size_t byteLength, SkTextEncoding encoding, |
| 3828 | SkScalar x, SkScalar y, const SkFont& font, const SkPaint& paint) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 3829 | #In Draw_Text |
| 3830 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3831 | #Line # draws text at (x, y), using font advance ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3832 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3833 | |
| 3834 | #Example |
| 3835 | #Height 200 |
| 3836 | #Description |
Mike Reed | cb268f6 | 2019-01-07 12:51:32 -0500 | [diff] [blame] | 3837 | The same text is drawn varying Paint_Text_Size and varying |
| 3838 | Matrix. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3839 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3840 | void draw(SkCanvas* canvas) { |
| 3841 | SkPaint paint; |
Mike Reed | cb268f6 | 2019-01-07 12:51:32 -0500 | [diff] [blame] | 3842 | SkFont font; |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3843 | float textSizes[] = { 12, 18, 24, 36 }; |
| 3844 | for (auto size: textSizes ) { |
Mike Reed | cb268f6 | 2019-01-07 12:51:32 -0500 | [diff] [blame] | 3845 | font.setSize(size); |
Hal Canary | 35d1470 | 2019-01-15 11:57:41 -0500 | [diff] [blame] | 3846 | canvas->drawSimpleText("Aa", 2, kUTF8_SkTextEncoding, 10, 20, font, paint); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3847 | canvas->translate(0, size * 2); |
| 3848 | } |
Mike Reed | cb268f6 | 2019-01-07 12:51:32 -0500 | [diff] [blame] | 3849 | font.setSize(12); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3850 | float yPos = 20; |
| 3851 | for (auto size: textSizes ) { |
| 3852 | float scale = size / 12.f; |
| 3853 | canvas->resetMatrix(); |
| 3854 | canvas->translate(100, 0); |
| 3855 | canvas->scale(scale, scale); |
Hal Canary | 35d1470 | 2019-01-15 11:57:41 -0500 | [diff] [blame] | 3856 | canvas->drawSimpleText("Aa", 2, kUTF8_SkTextEncoding, |
| 3857 | 10 / scale, yPos / scale, font, paint); |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3858 | yPos += size * 2; |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3859 | } |
| 3860 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3861 | ## |
| 3862 | |
Mike Reed | 53a11f5 | 2019-01-03 12:18:06 -0500 | [diff] [blame] | 3863 | #SeeAlso drawString drawTextBlob |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3864 | |
| 3865 | ## |
| 3866 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3867 | # ------------------------------------------------------------------------------ |
| 3868 | |
| 3869 | #Method void drawTextBlob(const SkTextBlob* blob, SkScalar x, SkScalar y, const SkPaint& paint) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 3870 | #In Draw_Text |
| 3871 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3872 | #Line # draws text with arrays of positions and Paint ## |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 3873 | Draws Text_Blob blob at (x, y), using Clip, Matrix, and Paint paint. |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3874 | |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 3875 | blob contains Glyphs, their positions, and paint attributes specific to text: |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame] | 3876 | #font_metrics#. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3877 | |
Mike Reed | 0f9d33e | 2018-12-05 10:54:05 -0500 | [diff] [blame] | 3878 | Paint_Text_Encoding must be set to kGlyphID_SkTextEncoding. |
Cary Clark | 3cd22cc | 2017-12-01 11:49:58 -0500 | [diff] [blame] | 3879 | |
Cary Clark | d2ca79c | 2018-08-10 13:09:13 -0400 | [diff] [blame] | 3880 | Elements of paint: Anti_Alias, Blend_Mode, Color including Color_Alpha, |
| 3881 | Color_Filter, Paint_Dither, Draw_Looper, Mask_Filter, Path_Effect, Shader, and |
Cary Clark | 61313f3 | 2018-10-08 14:57:48 -0400 | [diff] [blame] | 3882 | Paint_Style; apply to blob. If Paint contains SkPaint::kStroke_Style: |
Cary Clark | d2ca79c | 2018-08-10 13:09:13 -0400 | [diff] [blame] | 3883 | Paint_Miter_Limit, Paint_Stroke_Cap, Paint_Stroke_Join, and Paint_Stroke_Width; |
| 3884 | apply to Path created from blob. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3885 | |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 3886 | #Param blob Glyphs, positions, and their paints' text size, typeface, and so on ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3887 | #Param x horizontal offset applied to blob ## |
| 3888 | #Param y vertical offset applied to blob ## |
| 3889 | #Param paint blend, color, stroking, and so on, used to draw ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3890 | |
| 3891 | #Example |
| 3892 | #Height 120 |
Cary Clark | e80cd44 | 2018-07-17 13:19:56 -0400 | [diff] [blame] | 3893 | void draw(SkCanvas* canvas) { |
Mike Reed | 0f9d33e | 2018-12-05 10:54:05 -0500 | [diff] [blame] | 3894 | SkTextBlobBuilder textBlobBuilder; |
| 3895 | const char bunny[] = "/(^x^)\\"; |
| 3896 | const int len = sizeof(bunny) - 1; |
| 3897 | uint16_t glyphs[len]; |
Mike Reed | 0f9d33e | 2018-12-05 10:54:05 -0500 | [diff] [blame] | 3898 | SkFont font; |
Cary Clark | 26d173f | 2019-01-07 15:16:56 -0500 | [diff] [blame] | 3899 | font.textToGlyphs(bunny, len, SkTextEncoding::kUTF8, glyphs, len); |
Mike Reed | 0f9d33e | 2018-12-05 10:54:05 -0500 | [diff] [blame] | 3900 | int runs[] = { 3, 1, 3 }; |
| 3901 | SkPoint textPos = { 20, 100 }; |
| 3902 | int glyphIndex = 0; |
| 3903 | for (auto runLen : runs) { |
| 3904 | font.setSize(1 == runLen ? 20 : 50); |
| 3905 | const SkTextBlobBuilder::RunBuffer& run = |
| 3906 | textBlobBuilder.allocRun(font, runLen, textPos.fX, textPos.fY); |
| 3907 | memcpy(run.glyphs, &glyphs[glyphIndex], sizeof(glyphs[0]) * runLen); |
Cary Clark | 26d173f | 2019-01-07 15:16:56 -0500 | [diff] [blame] | 3908 | font.setSize(1 == runLen ? 20 : 50); |
| 3909 | textPos.fX += font.measureText(&glyphs[glyphIndex], sizeof(glyphs[0]) * runLen, |
| 3910 | SkTextEncoding::kGlyphID); |
Mike Reed | 0f9d33e | 2018-12-05 10:54:05 -0500 | [diff] [blame] | 3911 | glyphIndex += runLen; |
| 3912 | } |
| 3913 | sk_sp<const SkTextBlob> blob = textBlobBuilder.make(); |
Cary Clark | 26d173f | 2019-01-07 15:16:56 -0500 | [diff] [blame] | 3914 | canvas->drawTextBlob(blob.get(), 0, 0, SkPaint()); |
Cary Clark | e80cd44 | 2018-07-17 13:19:56 -0400 | [diff] [blame] | 3915 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3916 | ## |
| 3917 | |
Mike Reed | 53a11f5 | 2019-01-03 12:18:06 -0500 | [diff] [blame] | 3918 | #SeeAlso drawText |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3919 | |
| 3920 | ## |
| 3921 | |
| 3922 | # ------------------------------------------------------------------------------ |
| 3923 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3924 | #Method void drawTextBlob(const sk_sp<SkTextBlob>& blob, SkScalar x, SkScalar y, const SkPaint& paint) |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3925 | |
Cary Clark | 80247e5 | 2018-07-11 16:18:41 -0400 | [diff] [blame] | 3926 | Draws Text_Blob blob at (x, y), using Clip, Matrix, and Paint paint. |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3927 | |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 3928 | blob contains Glyphs, their positions, and paint attributes specific to text: |
Cary Clark | 3e73dcf | 2018-12-06 08:41:14 -0500 | [diff] [blame] | 3929 | #font_metrics#. |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3930 | |
Mike Reed | 0f9d33e | 2018-12-05 10:54:05 -0500 | [diff] [blame] | 3931 | Paint_Text_Encoding must be set to kGlyphID_SkTextEncoding. |
Cary Clark | 3cd22cc | 2017-12-01 11:49:58 -0500 | [diff] [blame] | 3932 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3933 | Elements of paint: Path_Effect, Mask_Filter, Shader, Color_Filter, |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3934 | Image_Filter, and Draw_Looper; apply to blob. |
| 3935 | |
Cary Clark | ce10124 | 2017-09-01 15:51:02 -0400 | [diff] [blame] | 3936 | #Param blob Glyphs, positions, and their paints' text size, typeface, and so on ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3937 | #Param x horizontal offset applied to blob ## |
| 3938 | #Param y vertical offset applied to blob ## |
| 3939 | #Param paint blend, color, stroking, and so on, used to draw ## |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3940 | |
| 3941 | #Example |
| 3942 | #Height 120 |
| 3943 | #Description |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3944 | Paint attributes related to text, like text size, have no effect on paint passed to drawTextBlob. |
| 3945 | ## |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3946 | void draw(SkCanvas* canvas) { |
| 3947 | SkTextBlobBuilder textBlobBuilder; |
Cary Clark | fc93eb0 | 2018-11-24 22:32:31 -0500 | [diff] [blame] | 3948 | SkFont font; |
| 3949 | font.setSize(50); |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3950 | const SkTextBlobBuilder::RunBuffer& run = |
Cary Clark | fc93eb0 | 2018-11-24 22:32:31 -0500 | [diff] [blame] | 3951 | textBlobBuilder.allocRun(font, 1, 20, 100); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3952 | run.glyphs[0] = 20; |
| 3953 | sk_sp<const SkTextBlob> blob = textBlobBuilder.make(); |
Cary Clark | fc93eb0 | 2018-11-24 22:32:31 -0500 | [diff] [blame] | 3954 | SkPaint paint; |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3955 | paint.setColor(SK_ColorBLUE); |
| 3956 | canvas->drawTextBlob(blob.get(), 0, 0, paint); |
| 3957 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3958 | ## |
| 3959 | |
Mike Reed | 53a11f5 | 2019-01-03 12:18:06 -0500 | [diff] [blame] | 3960 | #SeeAlso drawText |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3961 | |
| 3962 | ## |
| 3963 | |
| 3964 | # ------------------------------------------------------------------------------ |
| 3965 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3966 | #Method void drawPicture(const SkPicture* picture) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 3967 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 3968 | #Line # draws Picture using Clip and Matrix ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3969 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3970 | |
| 3971 | #Example |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3972 | void draw(SkCanvas* canvas) { |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3973 | SkPictureRecorder recorder; |
| 3974 | SkCanvas* recordingCanvas = recorder.beginRecording(50, 50); |
| 3975 | for (auto color : { SK_ColorRED, SK_ColorBLUE, 0xff007f00 } ) { |
| 3976 | SkPaint paint; |
| 3977 | paint.setColor(color); |
| 3978 | recordingCanvas->drawRect({10, 10, 30, 40}, paint); |
| 3979 | recordingCanvas->translate(10, 10); |
| 3980 | recordingCanvas->scale(1.2f, 1.4f); |
| 3981 | } |
| 3982 | sk_sp<SkPicture> playback = recorder.finishRecordingAsPicture(); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 3983 | canvas->drawPicture(playback); |
| 3984 | canvas->scale(2, 2); |
| 3985 | canvas->translate(50, 0); |
| 3986 | canvas->drawPicture(playback); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3987 | } |
| 3988 | ## |
| 3989 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 3990 | #SeeAlso drawDrawable SkPicture SkPicture::playback |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3991 | |
| 3992 | ## |
| 3993 | |
| 3994 | # ------------------------------------------------------------------------------ |
| 3995 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 3996 | #Method void drawPicture(const sk_sp<SkPicture>& picture) |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 3997 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 3998 | |
| 3999 | #Example |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 4000 | void draw(SkCanvas* canvas) { |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4001 | SkPictureRecorder recorder; |
| 4002 | SkCanvas* recordingCanvas = recorder.beginRecording(50, 50); |
| 4003 | for (auto color : { SK_ColorRED, SK_ColorBLUE, 0xff007f00 } ) { |
| 4004 | SkPaint paint; |
| 4005 | paint.setColor(color); |
| 4006 | recordingCanvas->drawRect({10, 10, 30, 40}, paint); |
| 4007 | recordingCanvas->translate(10, 10); |
| 4008 | recordingCanvas->scale(1.2f, 1.4f); |
| 4009 | } |
| 4010 | sk_sp<SkPicture> playback = recorder.finishRecordingAsPicture(); |
| 4011 | canvas->drawPicture(playback); |
| 4012 | canvas->scale(2, 2); |
| 4013 | canvas->translate(50, 0); |
| 4014 | canvas->drawPicture(playback); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4015 | } |
| 4016 | ## |
| 4017 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 4018 | #SeeAlso drawDrawable SkPicture SkPicture::playback |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4019 | |
| 4020 | ## |
| 4021 | |
| 4022 | # ------------------------------------------------------------------------------ |
| 4023 | |
| 4024 | #Method void drawPicture(const SkPicture* picture, const SkMatrix* matrix, const SkPaint* paint) |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4025 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4026 | |
| 4027 | #Example |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 4028 | void draw(SkCanvas* canvas) { |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4029 | SkPaint paint; |
| 4030 | SkPictureRecorder recorder; |
| 4031 | SkCanvas* recordingCanvas = recorder.beginRecording(50, 50); |
| 4032 | for (auto color : { SK_ColorRED, SK_ColorBLUE, 0xff007f00 } ) { |
| 4033 | paint.setColor(color); |
| 4034 | recordingCanvas->drawRect({10, 10, 30, 40}, paint); |
| 4035 | recordingCanvas->translate(10, 10); |
| 4036 | recordingCanvas->scale(1.2f, 1.4f); |
| 4037 | } |
| 4038 | sk_sp<SkPicture> playback = recorder.finishRecordingAsPicture(); |
| 4039 | const SkPicture* playbackPtr = playback.get(); |
| 4040 | SkMatrix matrix; |
| 4041 | matrix.reset(); |
| 4042 | for (auto alpha : { 70, 140, 210 } ) { |
| 4043 | paint.setAlpha(alpha); |
| 4044 | canvas->drawPicture(playbackPtr, &matrix, &paint); |
| 4045 | matrix.preTranslate(70, 70); |
| 4046 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4047 | } |
| 4048 | ## |
| 4049 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 4050 | #SeeAlso drawDrawable SkPicture SkPicture::playback |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4051 | |
| 4052 | ## |
| 4053 | |
| 4054 | # ------------------------------------------------------------------------------ |
| 4055 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 4056 | #Method void drawPicture(const sk_sp<SkPicture>& picture, const SkMatrix* matrix, const SkPaint* paint) |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4057 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4058 | |
| 4059 | #Example |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 4060 | void draw(SkCanvas* canvas) { |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4061 | SkPaint paint; |
| 4062 | SkPictureRecorder recorder; |
| 4063 | SkCanvas* recordingCanvas = recorder.beginRecording(50, 50); |
| 4064 | for (auto color : { SK_ColorRED, SK_ColorBLUE, 0xff007f00 } ) { |
| 4065 | paint.setColor(color); |
| 4066 | recordingCanvas->drawRect({10, 10, 30, 40}, paint); |
| 4067 | recordingCanvas->translate(10, 10); |
| 4068 | recordingCanvas->scale(1.2f, 1.4f); |
| 4069 | } |
| 4070 | sk_sp<SkPicture> playback = recorder.finishRecordingAsPicture(); |
| 4071 | SkMatrix matrix; |
| 4072 | matrix.reset(); |
| 4073 | for (auto alpha : { 70, 140, 210 } ) { |
| 4074 | paint.setAlpha(alpha); |
| 4075 | canvas->drawPicture(playback, &matrix, &paint); |
| 4076 | matrix.preTranslate(70, 70); |
| 4077 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4078 | } |
| 4079 | ## |
| 4080 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 4081 | #SeeAlso drawDrawable SkPicture SkPicture::playback |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4082 | |
| 4083 | ## |
| 4084 | |
| 4085 | # ------------------------------------------------------------------------------ |
| 4086 | |
| 4087 | #Method void drawVertices(const SkVertices* vertices, SkBlendMode mode, const SkPaint& paint) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 4088 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 4089 | #Line # draws Vertices, a triangle mesh ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4090 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4091 | |
| 4092 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4093 | void draw(SkCanvas* canvas) { |
| 4094 | SkPaint paint; |
| 4095 | SkPoint points[] = { { 0, 0 }, { 250, 0 }, { 100, 100 }, { 0, 250 } }; |
| 4096 | SkColor colors[] = { SK_ColorRED, SK_ColorBLUE, SK_ColorYELLOW, SK_ColorCYAN }; |
| 4097 | auto vertices = SkVertices::MakeCopy(SkVertices::kTriangleFan_VertexMode, |
| 4098 | SK_ARRAY_COUNT(points), points, nullptr, colors); |
| 4099 | canvas->drawVertices(vertices.get(), SkBlendMode::kSrc, paint); |
| 4100 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4101 | ## |
| 4102 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 4103 | #SeeAlso drawPatch drawPicture |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4104 | |
| 4105 | ## |
| 4106 | |
| 4107 | # ------------------------------------------------------------------------------ |
| 4108 | |
| 4109 | #Method void drawVertices(const sk_sp<SkVertices>& vertices, SkBlendMode mode, const SkPaint& paint) |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4110 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4111 | |
| 4112 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4113 | void draw(SkCanvas* canvas) { |
| 4114 | SkPaint paint; |
| 4115 | SkPoint points[] = { { 0, 0 }, { 250, 0 }, { 100, 100 }, { 0, 250 } }; |
| 4116 | SkPoint texs[] = { { 0, 0 }, { 0, 250 }, { 250, 250 }, { 250, 0 } }; |
| 4117 | SkColor colors[] = { SK_ColorRED, SK_ColorBLUE, SK_ColorYELLOW, SK_ColorCYAN }; |
| 4118 | paint.setShader(SkGradientShader::MakeLinear(points, colors, nullptr, 4, |
| 4119 | SkShader::kClamp_TileMode)); |
| 4120 | auto vertices = SkVertices::MakeCopy(SkVertices::kTriangleFan_VertexMode, |
| 4121 | SK_ARRAY_COUNT(points), points, texs, colors); |
Ruiqi Mao | 94d57c4 | 2018-07-02 15:20:10 -0400 | [diff] [blame] | 4122 | canvas->drawVertices(vertices, SkBlendMode::kDarken, paint); |
| 4123 | } |
| 4124 | ## |
| 4125 | |
| 4126 | #SeeAlso drawPatch drawPicture |
| 4127 | |
| 4128 | ## |
| 4129 | |
| 4130 | # ------------------------------------------------------------------------------ |
| 4131 | |
Ruiqi Mao | c97a339 | 2018-08-15 10:44:19 -0400 | [diff] [blame] | 4132 | #Method void drawVertices(const SkVertices* vertices, const SkVertices::Bone bones[], |
| 4133 | int boneCount, SkBlendMode mode, const SkPaint& paint) |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4134 | #Populate |
Ruiqi Mao | 94d57c4 | 2018-07-02 15:20:10 -0400 | [diff] [blame] | 4135 | |
Ruiqi Mao | c97a339 | 2018-08-15 10:44:19 -0400 | [diff] [blame] | 4136 | #NoExample |
Ruiqi Mao | 94d57c4 | 2018-07-02 15:20:10 -0400 | [diff] [blame] | 4137 | void draw(SkCanvas* canvas) { |
| 4138 | SkPaint paint; |
| 4139 | SkPoint points[] = { { 0, 0 }, { 250, 0 }, { 100, 100 }, { 0, 250 } }; |
| 4140 | SkPoint texs[] = { { 0, 0 }, { 0, 250 }, { 250, 250 }, { 250, 0 } }; |
| 4141 | SkColor colors[] = { SK_ColorRED, SK_ColorBLUE, SK_ColorYELLOW, SK_ColorCYAN }; |
| 4142 | SkVertices::BoneIndices boneIndices[] = { { 0, 0, 0, 0 }, |
| 4143 | { 1, 0, 0, 0 }, |
| 4144 | { 2, 0, 0, 0 }, |
| 4145 | { 3, 0, 0, 0 } }; |
| 4146 | SkVertices::BoneWeights boneWeights[] = { { 0.0f, 0.0f, 0.0f, 0.0f }, |
| 4147 | { 1.0f, 0.0f, 0.0f, 0.0f }, |
| 4148 | { 1.0f, 0.0f, 0.0f, 0.0f }, |
| 4149 | { 1.0f, 0.0f, 0.0f, 0.0f } }; |
Ruiqi Mao | c97a339 | 2018-08-15 10:44:19 -0400 | [diff] [blame] | 4150 | SkVertices::Bone bones[] = { {{ 1.0f, 0.0f, 0.0f, 1.0f, 0.0f, 0.0f }}, |
| 4151 | {{ 1.0f, 0.0f, 0.0f, 1.0f, 0.0f, 20.0f }}, |
| 4152 | {{ 1.0f, 0.0f, 0.0f, 1.0f, 50.0f, 50.0f }}, |
| 4153 | {{ 1.0f, 0.0f, 0.0f, 1.0f, 20.0f, 0.0f }} }; |
Ruiqi Mao | 94d57c4 | 2018-07-02 15:20:10 -0400 | [diff] [blame] | 4154 | paint.setShader(SkGradientShader::MakeLinear(points, colors, nullptr, 4, |
| 4155 | SkShader::kClamp_TileMode)); |
| 4156 | auto vertices = SkVertices::MakeCopy(SkVertices::kTriangleFan_VertexMode, |
| 4157 | SK_ARRAY_COUNT(points), points, texs, colors, boneIndices, boneWeights); |
| 4158 | canvas->drawVertices(vertices.get(), bones, SK_ARRAY_COUNT(bones), SkBlendMode::kDarken, paint); |
| 4159 | } |
| 4160 | ## |
| 4161 | |
| 4162 | #SeeAlso drawPatch drawPicture |
| 4163 | |
| 4164 | ## |
| 4165 | |
| 4166 | # ------------------------------------------------------------------------------ |
| 4167 | |
Ruiqi Mao | c97a339 | 2018-08-15 10:44:19 -0400 | [diff] [blame] | 4168 | #Method void drawVertices(const sk_sp<SkVertices>& vertices, const SkVertices::Bone bones[], |
| 4169 | int boneCount, SkBlendMode mode, const SkPaint& paint) |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4170 | #Populate |
Ruiqi Mao | 94d57c4 | 2018-07-02 15:20:10 -0400 | [diff] [blame] | 4171 | |
Ruiqi Mao | c97a339 | 2018-08-15 10:44:19 -0400 | [diff] [blame] | 4172 | #NoExample |
Ruiqi Mao | 94d57c4 | 2018-07-02 15:20:10 -0400 | [diff] [blame] | 4173 | void draw(SkCanvas* canvas) { |
| 4174 | SkPaint paint; |
| 4175 | SkPoint points[] = { { 0, 0 }, { 250, 0 }, { 100, 100 }, { 0, 250 } }; |
| 4176 | SkPoint texs[] = { { 0, 0 }, { 0, 250 }, { 250, 250 }, { 250, 0 } }; |
| 4177 | SkColor colors[] = { SK_ColorRED, SK_ColorBLUE, SK_ColorYELLOW, SK_ColorCYAN }; |
| 4178 | SkVertices::BoneIndices boneIndices[] = { { 0, 0, 0, 0 }, |
| 4179 | { 1, 0, 0, 0 }, |
| 4180 | { 2, 0, 0, 0 }, |
| 4181 | { 3, 0, 0, 0 } }; |
| 4182 | SkVertices::BoneWeights boneWeights[] = { { 0.0f, 0.0f, 0.0f, 0.0f }, |
| 4183 | { 1.0f, 0.0f, 0.0f, 0.0f }, |
| 4184 | { 1.0f, 0.0f, 0.0f, 0.0f }, |
| 4185 | { 1.0f, 0.0f, 0.0f, 0.0f } }; |
Ruiqi Mao | c97a339 | 2018-08-15 10:44:19 -0400 | [diff] [blame] | 4186 | SkVertices::Bone bones[] = { {{ 1.0f, 0.0f, 0.0f, 1.0f, 0.0f, 0.0f }}, |
| 4187 | {{ 1.0f, 0.0f, 0.0f, 1.0f, 0.0f, 20.0f }}, |
| 4188 | {{ 1.0f, 0.0f, 0.0f, 1.0f, 50.0f, 50.0f }}, |
| 4189 | {{ 1.0f, 0.0f, 0.0f, 1.0f, 20.0f, 0.0f }} }; |
Ruiqi Mao | 94d57c4 | 2018-07-02 15:20:10 -0400 | [diff] [blame] | 4190 | paint.setShader(SkGradientShader::MakeLinear(points, colors, nullptr, 4, |
| 4191 | SkShader::kClamp_TileMode)); |
| 4192 | auto vertices = SkVertices::MakeCopy(SkVertices::kTriangleFan_VertexMode, |
| 4193 | SK_ARRAY_COUNT(points), points, texs, colors, boneIndices, boneWeights); |
| 4194 | canvas->drawVertices(vertices, bones, SK_ARRAY_COUNT(bones), SkBlendMode::kDarken, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4195 | } |
| 4196 | ## |
| 4197 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 4198 | #SeeAlso drawPatch drawPicture |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4199 | |
| 4200 | ## |
| 4201 | |
| 4202 | # ------------------------------------------------------------------------------ |
| 4203 | |
| 4204 | #Method void drawPatch(const SkPoint cubics[12], const SkColor colors[4], |
| 4205 | const SkPoint texCoords[4], SkBlendMode mode, const SkPaint& paint) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 4206 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 4207 | #Line # draws Coons_Patch ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4208 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4209 | |
| 4210 | #Example |
| 4211 | #Image 5 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4212 | void draw(SkCanvas* canvas) { |
| 4213 | // SkBitmap source = cmbkygk; |
| 4214 | SkPaint paint; |
| 4215 | paint.setFilterQuality(kLow_SkFilterQuality); |
| 4216 | paint.setAntiAlias(true); |
| 4217 | SkPoint cubics[] = { { 3, 1 }, { 4, 2 }, { 5, 1 }, { 7, 3 }, |
| 4218 | /* { 7, 3 }, */ { 6, 4 }, { 7, 5 }, { 5, 7 }, |
| 4219 | /* { 5, 7 }, */ { 4, 6 }, { 3, 7 }, { 1, 5 }, |
| 4220 | /* { 1, 5 }, */ { 2, 4 }, { 1, 3 }, /* { 3, 1 } */ }; |
| 4221 | SkColor colors[] = { 0xbfff0000, 0xbf0000ff, 0xbfff00ff, 0xbf00ffff }; |
| 4222 | SkPoint texCoords[] = { { -30, -30 }, { 162, -30}, { 162, 162}, { -30, 162} }; |
| 4223 | paint.setShader(SkShader::MakeBitmapShader(source, SkShader::kClamp_TileMode, |
| 4224 | SkShader::kClamp_TileMode, nullptr)); |
| 4225 | canvas->scale(15, 15); |
| 4226 | for (auto blend : { SkBlendMode::kSrcOver, SkBlendMode::kModulate, SkBlendMode::kXor } ) { |
| 4227 | canvas->drawPatch(cubics, colors, texCoords, blend, paint); |
| 4228 | canvas->translate(4, 4); |
| 4229 | } |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4230 | } |
| 4231 | ## |
| 4232 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 4233 | #ToDo can patch use image filter? ## |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 4234 | #SeeAlso drawVertices drawPicture |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4235 | |
| 4236 | ## |
| 4237 | |
| 4238 | # ------------------------------------------------------------------------------ |
| 4239 | |
| 4240 | #Method void drawPatch(const SkPoint cubics[12], const SkColor colors[4], |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 4241 | const SkPoint texCoords[4], const SkPaint& paint) |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4242 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4243 | |
| 4244 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4245 | void draw(SkCanvas* canvas) { |
| 4246 | SkPaint paint; |
| 4247 | paint.setAntiAlias(true); |
| 4248 | SkPoint cubics[] = { { 3, 1 }, { 4, 2 }, { 5, 1 }, { 7, 3 }, |
| 4249 | /* { 7, 3 }, */ { 6, 4 }, { 7, 5 }, { 5, 7 }, |
| 4250 | /* { 5, 7 }, */ { 4, 6 }, { 3, 7 }, { 1, 5 }, |
| 4251 | /* { 1, 5 }, */ { 2, 4 }, { 1, 3 }, /* { 3, 1 } */ }; |
| 4252 | SkColor colors[] = { SK_ColorRED, SK_ColorBLUE, SK_ColorYELLOW, SK_ColorCYAN }; |
| 4253 | canvas->scale(30, 30); |
| 4254 | canvas->drawPatch(cubics, colors, nullptr, paint); |
| 4255 | SkPoint text[] = { {3,0.9f}, {4,2.5f}, {5,0.9f}, {7.5f,3.2f}, {5.5f,4.2f}, |
| 4256 | {7.5f,5.2f}, {5,7.5f}, {4,5.9f}, {3,7.5f}, {0.5f,5.2f}, {2.5f,4.2f}, |
| 4257 | {0.5f,3.2f} }; |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 4258 | |
| 4259 | SkFont font(nullptr, 18.f / 30); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4260 | for (int i = 0; i< 10; ++i) { |
| 4261 | char digit = '0' + i; |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 4262 | canvas->drawSimpleText(&digit, kUTF8_SkTextEncoding, 1, text[i].fX, text[i].fY, font, paint); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4263 | } |
Mike Reed | 33535cb | 2019-01-09 11:25:18 -0500 | [diff] [blame] | 4264 | canvas->drawString("10", text[10].fX, text[10].fY, font, paint); |
| 4265 | canvas->drawString("11", text[11].fX, text[11].fY, font, paint); |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4266 | paint.setStyle(SkPaint::kStroke_Style); |
| 4267 | canvas->drawPoints(SkCanvas::kPolygon_PointMode, 12, cubics, paint); |
| 4268 | canvas->drawLine(cubics[11].fX, cubics[11].fY, cubics[0].fX, cubics[0].fY, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4269 | } |
| 4270 | ## |
| 4271 | |
| 4272 | #Example |
| 4273 | #Image 6 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4274 | void draw(SkCanvas* canvas) { |
| 4275 | // SkBitmap source = checkerboard; |
| 4276 | SkPaint paint; |
| 4277 | paint.setFilterQuality(kLow_SkFilterQuality); |
| 4278 | paint.setAntiAlias(true); |
| 4279 | SkPoint cubics[] = { { 3, 1 }, { 4, 2 }, { 5, 1 }, { 7, 3 }, |
| 4280 | /* { 7, 3 }, */ { 6, 4 }, { 7, 5 }, { 5, 7 }, |
| 4281 | /* { 5, 7 }, */ { 4, 6 }, { 3, 7 }, { 1, 5 }, |
| 4282 | /* { 1, 5 }, */ { 2, 4 }, { 1, 3 }, /* { 3, 1 } */ }; |
| 4283 | SkPoint texCoords[] = { { 0, 0 }, { 0, 62}, { 62, 62}, { 62, 0 } }; |
| 4284 | paint.setShader(SkShader::MakeBitmapShader(source, SkShader::kClamp_TileMode, |
| 4285 | SkShader::kClamp_TileMode, nullptr)); |
| 4286 | canvas->scale(30, 30); |
| 4287 | canvas->drawPatch(cubics, nullptr, texCoords, paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4288 | } |
| 4289 | ## |
| 4290 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 4291 | #ToDo can patch use image filter? ## |
Cary Clark | 77b3f3a | 2018-11-07 14:59:03 -0500 | [diff] [blame] | 4292 | #SeeAlso drawVertices drawPicture |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4293 | |
| 4294 | ## |
| 4295 | |
| 4296 | # ------------------------------------------------------------------------------ |
| 4297 | |
| 4298 | #Method void drawAtlas(const SkImage* atlas, const SkRSXform xform[], const SkRect tex[], |
| 4299 | const SkColor colors[], int count, SkBlendMode mode, const SkRect* cullRect, |
| 4300 | const SkPaint* paint) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 4301 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 4302 | #Line # draws sprites using Clip, Matrix, and Paint ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4303 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4304 | |
| 4305 | #Example |
| 4306 | #Image 3 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4307 | void draw(SkCanvas* canvas) { |
| 4308 | // SkBitmap source = mandrill; |
| 4309 | SkRSXform xforms[] = { { .5f, 0, 0, 0 }, {0, .5f, 200, 100 } }; |
| 4310 | SkRect tex[] = { { 0, 0, 250, 250 }, { 0, 0, 250, 250 } }; |
| 4311 | SkColor colors[] = { 0x7f55aa00, 0x7f3333bf }; |
| 4312 | const SkImage* imagePtr = image.get(); |
| 4313 | canvas->drawAtlas(imagePtr, xforms, tex, colors, 2, SkBlendMode::kSrcOver, nullptr, nullptr); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4314 | } |
| 4315 | ## |
| 4316 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 4317 | #SeeAlso drawBitmap drawImage |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4318 | |
| 4319 | ## |
| 4320 | |
| 4321 | # ------------------------------------------------------------------------------ |
| 4322 | |
| 4323 | #Method void drawAtlas(const sk_sp<SkImage>& atlas, const SkRSXform xform[], const SkRect tex[], |
| 4324 | const SkColor colors[], int count, SkBlendMode mode, const SkRect* cullRect, |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 4325 | const SkPaint* paint) |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4326 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4327 | |
| 4328 | #Example |
| 4329 | #Image 3 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4330 | void draw(SkCanvas* canvas) { |
| 4331 | // SkBitmap source = mandrill; |
| 4332 | SkRSXform xforms[] = { { .5f, 0, 0, 0 }, {0, .5f, 200, 100 } }; |
| 4333 | SkRect tex[] = { { 0, 0, 250, 250 }, { 0, 0, 250, 250 } }; |
| 4334 | SkColor colors[] = { 0x7f55aa00, 0x7f3333bf }; |
| 4335 | SkPaint paint; |
| 4336 | paint.setAlpha(127); |
| 4337 | canvas->drawAtlas(image, xforms, tex, colors, 2, SkBlendMode::kPlus, nullptr, &paint); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4338 | } |
| 4339 | ## |
| 4340 | |
| 4341 | #ToDo bug in example on cpu side, gpu looks ok ## |
| 4342 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 4343 | #SeeAlso drawBitmap drawImage |
| 4344 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4345 | ## |
| 4346 | |
| 4347 | # ------------------------------------------------------------------------------ |
| 4348 | |
| 4349 | #Method void drawAtlas(const SkImage* atlas, const SkRSXform xform[], const SkRect tex[], int count, |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 4350 | const SkRect* cullRect, const SkPaint* paint) |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4351 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4352 | |
| 4353 | #Example |
| 4354 | #Image 3 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4355 | void draw(SkCanvas* canvas) { |
| 4356 | // sk_sp<SkImage> image = mandrill; |
| 4357 | SkRSXform xforms[] = { { .5f, 0, 0, 0 }, {0, .5f, 200, 100 } }; |
| 4358 | SkRect tex[] = { { 0, 0, 250, 250 }, { 0, 0, 250, 250 } }; |
| 4359 | const SkImage* imagePtr = image.get(); |
| 4360 | canvas->drawAtlas(imagePtr, xforms, tex, 2, nullptr, nullptr); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4361 | } |
| 4362 | ## |
| 4363 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 4364 | #SeeAlso drawBitmap drawImage |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4365 | |
| 4366 | ## |
| 4367 | |
| 4368 | # ------------------------------------------------------------------------------ |
| 4369 | |
| 4370 | #Method void drawAtlas(const sk_sp<SkImage>& atlas, const SkRSXform xform[], const SkRect tex[], |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 4371 | int count, const SkRect* cullRect, const SkPaint* paint) |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4372 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4373 | |
| 4374 | #Example |
| 4375 | #Image 3 |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4376 | void draw(SkCanvas* canvas) { |
| 4377 | // sk_sp<SkImage> image = mandrill; |
| 4378 | SkRSXform xforms[] = { { 1, 0, 0, 0 }, {0, 1, 300, 100 } }; |
| 4379 | SkRect tex[] = { { 0, 0, 200, 200 }, { 200, 0, 400, 200 } }; |
| 4380 | canvas->drawAtlas(image, xforms, tex, 2, nullptr, nullptr); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4381 | } |
| 4382 | ## |
| 4383 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 4384 | #SeeAlso drawBitmap drawImage |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4385 | |
| 4386 | ## |
| 4387 | |
| 4388 | # ------------------------------------------------------------------------------ |
| 4389 | |
Cary Clark | 73fa972 | 2017-08-29 17:36:51 -0400 | [diff] [blame] | 4390 | #Method void drawDrawable(SkDrawable* drawable, const SkMatrix* matrix = nullptr) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 4391 | #In Draw |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 4392 | #Line # draws Drawable, encapsulated drawing commands ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4393 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4394 | |
| 4395 | #Example |
| 4396 | #Height 100 |
| 4397 | #Function |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4398 | struct MyDrawable : public SkDrawable { |
| 4399 | SkRect onGetBounds() override { return SkRect::MakeWH(50, 100); } |
| 4400 | |
| 4401 | void onDraw(SkCanvas* canvas) override { |
| 4402 | SkPath path; |
| 4403 | path.conicTo(10, 90, 50, 90, 0.9f); |
| 4404 | SkPaint paint; |
| 4405 | paint.setColor(SK_ColorBLUE); |
| 4406 | canvas->drawRect(path.getBounds(), paint); |
| 4407 | paint.setAntiAlias(true); |
| 4408 | paint.setColor(SK_ColorWHITE); |
| 4409 | canvas->drawPath(path, paint); |
| 4410 | } |
| 4411 | }; |
| 4412 | |
| 4413 | #Function ## |
| 4414 | void draw(SkCanvas* canvas) { |
| 4415 | sk_sp<SkDrawable> drawable(new MyDrawable); |
| 4416 | SkMatrix matrix; |
| 4417 | matrix.setTranslate(10, 10); |
| 4418 | canvas->drawDrawable(drawable.get(), &matrix); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4419 | } |
| 4420 | ## |
| 4421 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 4422 | #SeeAlso SkDrawable drawPicture |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4423 | |
| 4424 | ## |
| 4425 | |
| 4426 | # ------------------------------------------------------------------------------ |
| 4427 | |
| 4428 | #Method void drawDrawable(SkDrawable* drawable, SkScalar x, SkScalar y) |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4429 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4430 | |
| 4431 | #Example |
| 4432 | #Height 100 |
| 4433 | #Function |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4434 | struct MyDrawable : public SkDrawable { |
| 4435 | SkRect onGetBounds() override { return SkRect::MakeWH(50, 100); } |
| 4436 | |
| 4437 | void onDraw(SkCanvas* canvas) override { |
| 4438 | SkPath path; |
| 4439 | path.conicTo(10, 90, 50, 90, 0.9f); |
| 4440 | SkPaint paint; |
| 4441 | paint.setColor(SK_ColorBLUE); |
| 4442 | canvas->drawRect(path.getBounds(), paint); |
| 4443 | paint.setAntiAlias(true); |
| 4444 | paint.setColor(SK_ColorWHITE); |
| 4445 | canvas->drawPath(path, paint); |
| 4446 | } |
| 4447 | }; |
| 4448 | |
| 4449 | #Function ## |
| 4450 | void draw(SkCanvas* canvas) { |
| 4451 | sk_sp<SkDrawable> drawable(new MyDrawable); |
| 4452 | canvas->drawDrawable(drawable.get(), 10, 10); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4453 | } |
| 4454 | ## |
| 4455 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 4456 | #SeeAlso SkDrawable drawPicture |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4457 | |
| 4458 | ## |
| 4459 | |
| 4460 | # ------------------------------------------------------------------------------ |
| 4461 | |
| 4462 | #Method void drawAnnotation(const SkRect& rect, const char key[], SkData* value) |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 4463 | #In Draw |
| 4464 | #In Utility |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 4465 | #Line # associates a Rect with a key-value pair ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4466 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4467 | |
| 4468 | #Example |
| 4469 | #Height 1 |
| 4470 | const char text[] = "Click this link!"; |
| 4471 | SkRect bounds; |
| 4472 | SkPaint paint; |
Cary Clark | 26d173f | 2019-01-07 15:16:56 -0500 | [diff] [blame] | 4473 | SkFont font(nullptr, 40); |
| 4474 | (void)font.measureText(text, strlen(text), SkTextEncoding::kUTF8, &bounds); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4475 | const char url[] = "https://www.google.com/"; |
| 4476 | sk_sp<SkData> urlData(SkData::MakeWithCString(url)); |
| 4477 | canvas->drawAnnotation(bounds, "url_key", urlData.get()); |
| 4478 | ## |
| 4479 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 4480 | #SeeAlso SkPicture SkDocument |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4481 | |
| 4482 | ## |
| 4483 | |
| 4484 | # ------------------------------------------------------------------------------ |
| 4485 | |
Herb Derby | efe39bc | 2018-05-01 17:06:20 -0400 | [diff] [blame] | 4486 | #Method void drawAnnotation(const SkRect& rect, const char key[], const sk_sp<SkData>& value) |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4487 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4488 | |
| 4489 | #Example |
| 4490 | #Height 1 |
| 4491 | const char text[] = "Click this link!"; |
| 4492 | SkRect bounds; |
| 4493 | SkPaint paint; |
Cary Clark | 26d173f | 2019-01-07 15:16:56 -0500 | [diff] [blame] | 4494 | SkFont font(nullptr, 40); |
| 4495 | (void)font.measureText(text, strlen(text), SkTextEncoding::kUTF8, &bounds); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4496 | const char url[] = "https://www.google.com/"; |
| 4497 | sk_sp<SkData> urlData(SkData::MakeWithCString(url)); |
| 4498 | canvas->drawAnnotation(bounds, "url_key", urlData.get()); |
| 4499 | ## |
| 4500 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 4501 | #SeeAlso SkPicture SkDocument |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4502 | |
| 4503 | ## |
| 4504 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4505 | # ------------------------------------------------------------------------------ |
| 4506 | |
| 4507 | #Method virtual bool isClipEmpty() const |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 4508 | #In Property |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 4509 | #Line # returns if Clip is empty ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4510 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4511 | |
| 4512 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4513 | void draw(SkCanvas* canvas) { |
| 4514 | SkDebugf("clip is%s empty\n", canvas->isClipEmpty() ? "" : " not"); |
| 4515 | SkPath path; |
| 4516 | canvas->clipPath(path); |
| 4517 | SkDebugf("clip is%s empty\n", canvas->isClipEmpty() ? "" : " not"); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4518 | } |
| 4519 | #StdOut |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4520 | clip is not empty |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4521 | clip is empty |
| 4522 | ## |
| 4523 | ## |
| 4524 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 4525 | #SeeAlso isClipRect getLocalClipBounds getDeviceClipBounds |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4526 | |
| 4527 | ## |
| 4528 | |
| 4529 | # ------------------------------------------------------------------------------ |
| 4530 | |
| 4531 | #Method virtual bool isClipRect() const |
Cary Clark | 78de751 | 2018-02-07 07:27:09 -0500 | [diff] [blame] | 4532 | #In Property |
Cary Clark | ab2621d | 2018-01-30 10:08:57 -0500 | [diff] [blame] | 4533 | #Line # returns if Clip is Rect and not empty ## |
Cary Clark | 09d80c0 | 2018-10-31 12:14:03 -0400 | [diff] [blame] | 4534 | #Populate |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4535 | |
| 4536 | #Example |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4537 | void draw(SkCanvas* canvas) { |
| 4538 | SkDebugf("clip is%s rect\n", canvas->isClipRect() ? "" : " not"); |
| 4539 | canvas->clipRect({0, 0, 0, 0}); |
| 4540 | SkDebugf("clip is%s rect\n", canvas->isClipRect() ? "" : " not"); |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4541 | } |
| 4542 | #StdOut |
Cary Clark | bad5ad7 | 2017-08-03 17:14:08 -0400 | [diff] [blame] | 4543 | clip is rect |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4544 | clip is not rect |
| 4545 | ## |
| 4546 | ## |
| 4547 | |
Cary Clark | 2ade997 | 2017-11-02 17:49:34 -0400 | [diff] [blame] | 4548 | #SeeAlso isClipEmpty getLocalClipBounds getDeviceClipBounds |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4549 | |
| 4550 | ## |
| 4551 | |
| 4552 | #Class SkCanvas ## |
Cary Clark | 884dd7d | 2017-10-11 10:37:52 -0400 | [diff] [blame] | 4553 | |
Cary Clark | 8032b98 | 2017-07-28 11:04:54 -0400 | [diff] [blame] | 4554 | #Topic Canvas ## |