SkCanvas.h revision d58a1cd00b969a7755c375f55cf80f4d49d3047b
1ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com 28a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/* 3ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com * Copyright 2006 The Android Open Source Project 48a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com * 5ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com * Use of this source code is governed by a BSD-style license that can be 6ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com * found in the LICENSE file. 78a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 88a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 9ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com 108a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#ifndef SkCanvas_DEFINED 118a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#define SkCanvas_DEFINED 128a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 138a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#include "SkTypes.h" 148a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#include "SkBitmap.h" 158a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#include "SkDeque.h" 165c3d1471e4908706cd053a5e2ea9ded3a6c2eaebreed@google.com#include "SkClipStack.h" 178a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#include "SkPaint.h" 188a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#include "SkRefCnt.h" 198a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#include "SkPath.h" 208a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#include "SkRegion.h" 218a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#include "SkScalarCompare.h" 22845fdaca174f4675e9acc164b510e3a5ffa9053creed@android.com#include "SkXfermode.h" 238a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 248a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comclass SkBounder; 258a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comclass SkDevice; 268a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comclass SkDraw; 278a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comclass SkDrawFilter; 288a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comclass SkPicture; 298a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 308a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/** \class SkCanvas 318a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 328a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com A Canvas encapsulates all of the state about drawing into a device (bitmap). 338a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com This includes a reference to the device itself, and a stack of matrix/clip 348a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com values. For any given draw call (e.g. drawRect), the geometry of the object 358a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com being drawn is transformed by the concatenation of all the matrices in the 368a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com stack. The transformed geometry is clipped by the intersection of all of 378a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com the clips in the stack. 388a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 398a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com While the Canvas holds the state of the drawing device, the state (style) 408a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com of the object being drawn is held by the Paint, which is provided as a 418a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com parameter to each of the draw() methods. The Paint holds attributes such as 428a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com color, typeface, textSize, strokeWidth, shader (e.g. gradients, patterns), 438a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com etc. 448a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com*/ 457ffb1b21abcc7bbed5a0fc711f6dd7b9dbb4f577ctguil@chromium.orgclass SK_API SkCanvas : public SkRefCnt { 468a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.compublic: 47cde92111d50a96b6d0f3e166fbac7c9bc6eca349reed@google.com SkCanvas(); 488d84fac294682647694b0d2d8a87ac2bd19b6aabvandebo@chromium.org 496dc745506e6d6cc0936fed4de24443dc1ecb5a34reed@google.com /** Construct a canvas with the specified device to draw into. 50e97f0856a8044866b12527819d14cdfbcdfd96f2bsalomon@google.com 518d84fac294682647694b0d2d8a87ac2bd19b6aabvandebo@chromium.org @param device Specifies a device for the canvas to draw into. 528d84fac294682647694b0d2d8a87ac2bd19b6aabvandebo@chromium.org */ 538d84fac294682647694b0d2d8a87ac2bd19b6aabvandebo@chromium.org explicit SkCanvas(SkDevice* device); 548d84fac294682647694b0d2d8a87ac2bd19b6aabvandebo@chromium.org 558d84fac294682647694b0d2d8a87ac2bd19b6aabvandebo@chromium.org /** Deprecated - Construct a canvas with the specified bitmap to draw into. 568a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param bitmap Specifies a bitmap for the canvas to draw into. Its 578a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com structure are copied to the canvas. 588a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 598a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com explicit SkCanvas(const SkBitmap& bitmap); 608a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual ~SkCanvas(); 618a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 628a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /////////////////////////////////////////////////////////////////////////// 638a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 64210ce003a5ec039dda80de0569fb47ca4efc4dc7reed@google.com /** 65210ce003a5ec039dda80de0569fb47ca4efc4dc7reed@google.com * Return the width/height of the underlying device. The current drawable 66210ce003a5ec039dda80de0569fb47ca4efc4dc7reed@google.com * area may be small (due to clipping or saveLayer). For a canvas with 67210ce003a5ec039dda80de0569fb47ca4efc4dc7reed@google.com * no device, 0,0 will be returned. 68210ce003a5ec039dda80de0569fb47ca4efc4dc7reed@google.com */ 69210ce003a5ec039dda80de0569fb47ca4efc4dc7reed@google.com SkISize getDeviceSize() const; 70210ce003a5ec039dda80de0569fb47ca4efc4dc7reed@google.com 718a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Return the canvas' device object, which may be null. The device holds 728a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com the bitmap of the pixels that the canvas draws into. The reference count 738a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com of the returned device is not changed by this call. 748a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 758a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkDevice* getDevice() const; 768a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 778a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Specify a device for this canvas to draw into. If it is not null, its 788a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com reference count is incremented. If the canvas was already holding a 798a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com device, its reference count is decremented. The new device is returned. 808a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 818a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkDevice* setDevice(SkDevice* device); 828d84fac294682647694b0d2d8a87ac2bd19b6aabvandebo@chromium.org 839266fed56a46a4edc710a52c7be8d46fd7c2bc7areed@google.com /** 849266fed56a46a4edc710a52c7be8d46fd7c2bc7areed@google.com * saveLayer() can create another device (which is later drawn onto 859266fed56a46a4edc710a52c7be8d46fd7c2bc7areed@google.com * the previous device). getTopDevice() returns the top-most device current 869266fed56a46a4edc710a52c7be8d46fd7c2bc7areed@google.com * installed. Note that this can change on other calls like save/restore, 879266fed56a46a4edc710a52c7be8d46fd7c2bc7areed@google.com * so do not access this device after subsequent canvas calls. 889266fed56a46a4edc710a52c7be8d46fd7c2bc7areed@google.com * The reference count of the device is not changed. 899266fed56a46a4edc710a52c7be8d46fd7c2bc7areed@google.com */ 909266fed56a46a4edc710a52c7be8d46fd7c2bc7areed@google.com SkDevice* getTopDevice() const; 919266fed56a46a4edc710a52c7be8d46fd7c2bc7areed@google.com 92f2b98d67dcb6fcb3120feede9c72016fc7b3ead8reed@android.com /** 93f2b98d67dcb6fcb3120feede9c72016fc7b3ead8reed@android.com * Create a new raster device and make it current. This also returns 94f2b98d67dcb6fcb3120feede9c72016fc7b3ead8reed@android.com * the new device. 95f2b98d67dcb6fcb3120feede9c72016fc7b3ead8reed@android.com */ 96af951c9bc4cbb6e60b430194fe5127ebe99c53fbreed@google.com SkDevice* setBitmapDevice(const SkBitmap& bitmap); 978a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 9851df9e3fe3c1aec370854b2718df16fc02faa1b2reed@google.com /** 99cde92111d50a96b6d0f3e166fbac7c9bc6eca349reed@google.com * Shortcut for getDevice()->createCompatibleDevice(...). 100cde92111d50a96b6d0f3e166fbac7c9bc6eca349reed@google.com * If getDevice() == NULL, this method does nothing, and returns NULL. 101e97f0856a8044866b12527819d14cdfbcdfd96f2bsalomon@google.com */ 102e97f0856a8044866b12527819d14cdfbcdfd96f2bsalomon@google.com SkDevice* createCompatibleDevice(SkBitmap::Config config, 103e97f0856a8044866b12527819d14cdfbcdfd96f2bsalomon@google.com int width, int height, 104e97f0856a8044866b12527819d14cdfbcdfd96f2bsalomon@google.com bool isOpaque); 105e97f0856a8044866b12527819d14cdfbcdfd96f2bsalomon@google.com 1064b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com /////////////////////////////////////////////////////////////////////////// 1074b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com 108daba14b7d4fc96b915c45d82713b22729c0d0f37bsalomon@google.com /** 109d58a1cd00b969a7755c375f55cf80f4d49d3047bbsalomon@google.com * This enum can be used with read/writePixels to perform a pixel ops to or 110d58a1cd00b969a7755c375f55cf80f4d49d3047bbsalomon@google.com * from an 8888 config other than Skia's native config (SkPMColor). There 111d58a1cd00b969a7755c375f55cf80f4d49d3047bbsalomon@google.com * are three byte orders supported: native, BGRA, and RGBA. Each has a 112d58a1cd00b969a7755c375f55cf80f4d49d3047bbsalomon@google.com * premultiplied and unpremultiplied variant. 113d58a1cd00b969a7755c375f55cf80f4d49d3047bbsalomon@google.com * 114d58a1cd00b969a7755c375f55cf80f4d49d3047bbsalomon@google.com * Components of a 8888 pixel can be packed/unpacked from a 32bit word using 115d58a1cd00b969a7755c375f55cf80f4d49d3047bbsalomon@google.com * either byte offsets or shift values. Byte offsets are endian-invariant 116d58a1cd00b969a7755c375f55cf80f4d49d3047bbsalomon@google.com * while shifts are not. BGRA and RGBA configs are defined by byte 117d58a1cd00b969a7755c375f55cf80f4d49d3047bbsalomon@google.com * orderings. The native config is defined by shift values (SK_A32_SHIFT, 118d58a1cd00b969a7755c375f55cf80f4d49d3047bbsalomon@google.com * ..., SK_B32_SHIFT). 1196850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com */ 1206850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com enum Config8888 { 1216850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com /** 1226850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * Skia's native order specified by: 1236850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * SK_A32_SHIFT, SK_R32_SHIFT, SK_G32_SHIFT, and SK_B32_SHIFT 1246850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * 1256850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * kNative_Premul_Config8888 is equivalent to SkPMColor 1266850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * kNative_Unpremul_Config8888 has the same component order as SkPMColor 1276850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * but is not premultiplied. 1286850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com */ 1296850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com kNative_Premul_Config8888, 1306850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com kNative_Unpremul_Config8888, 1316850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com /** 1326850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * low byte to high byte: B, G, R, A. 1336850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com */ 1346850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com kBGRA_Premul_Config8888, 1356850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com kBGRA_Unpremul_Config8888, 1366850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com /** 1376850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * low byte to high byte: R, G, B, A. 1386850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com */ 1396850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com kRGBA_Premul_Config8888, 1406850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com kRGBA_Unpremul_Config8888, 1416850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com }; 1426850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com 1436850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com /** 144daba14b7d4fc96b915c45d82713b22729c0d0f37bsalomon@google.com * On success (returns true), copy the canvas pixels into the bitmap. 145daba14b7d4fc96b915c45d82713b22729c0d0f37bsalomon@google.com * On failure, the bitmap parameter is left unchanged and false is 146daba14b7d4fc96b915c45d82713b22729c0d0f37bsalomon@google.com * returned. 147daba14b7d4fc96b915c45d82713b22729c0d0f37bsalomon@google.com * 1486850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * The canvas' pixels are converted to the bitmap's config. The only 1496850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * supported config is kARGB_8888_Config, though this is likely to be 1506850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * relaxed in the future. The meaning of config kARGB_8888_Config is 1516850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * modified by the enum param config8888. The default value interprets 1526850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * kARGB_8888_Config as SkPMColor 153daba14b7d4fc96b915c45d82713b22729c0d0f37bsalomon@google.com * 154daba14b7d4fc96b915c45d82713b22729c0d0f37bsalomon@google.com * If the bitmap has pixels already allocated, the canvas pixels will be 155daba14b7d4fc96b915c45d82713b22729c0d0f37bsalomon@google.com * written there. If not, bitmap->allocPixels() will be called 156daba14b7d4fc96b915c45d82713b22729c0d0f37bsalomon@google.com * automatically. If the bitmap is backed by a texture readPixels will 157daba14b7d4fc96b915c45d82713b22729c0d0f37bsalomon@google.com * fail. 158daba14b7d4fc96b915c45d82713b22729c0d0f37bsalomon@google.com * 159daba14b7d4fc96b915c45d82713b22729c0d0f37bsalomon@google.com * The actual pixels written is the intersection of the canvas' bounds, and 160daba14b7d4fc96b915c45d82713b22729c0d0f37bsalomon@google.com * the rectangle formed by the bitmap's width,height and the specified x,y. 161daba14b7d4fc96b915c45d82713b22729c0d0f37bsalomon@google.com * If bitmap pixels extend outside of that intersection, they will not be 162daba14b7d4fc96b915c45d82713b22729c0d0f37bsalomon@google.com * modified. 163daba14b7d4fc96b915c45d82713b22729c0d0f37bsalomon@google.com * 1646850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * Other failure conditions: 1656850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * * If the canvas is backed by a non-raster device (e.g. PDF) then 1666850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * readPixels will fail. 1676850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * * If bitmap is texture-backed then readPixels will fail. (This may be 1686850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * relaxed in the future.) 1696850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * 1706850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * Example that reads the entire canvas into a bitmap using the native 1716850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * SkPMColor: 1726850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * SkISize size = canvas->getDeviceSize(); 1736850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * bitmap->setConfig(SkBitmap::kARGB_8888_Config, size.fWidth, 1746850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * size.fHeight); 1756850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * if (canvas->readPixels(bitmap, 0, 0)) { 1766850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * // use the pixels 1776850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com * } 178c69809745e6496564639e42ef998ad39adf7dfb8bsalomon@google.com */ 1796850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com bool readPixels(SkBitmap* bitmap, 1806850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com int x, int y, 1816850eab42ba4c2a7033a99824b02a2846ce0ef2absalomon@google.com Config8888 config8888 = kNative_Premul_Config8888); 182c69809745e6496564639e42ef998ad39adf7dfb8bsalomon@google.com 1834b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com /** 184c69809745e6496564639e42ef998ad39adf7dfb8bsalomon@google.com * DEPRECATED: This will be removed as soon as webkit is no longer relying 185c69809745e6496564639e42ef998ad39adf7dfb8bsalomon@google.com * on it. The bitmap is resized to the intersection of srcRect and the 186c69809745e6496564639e42ef998ad39adf7dfb8bsalomon@google.com * canvas bounds. New pixels are always allocated on success. Bitmap is 187c69809745e6496564639e42ef998ad39adf7dfb8bsalomon@google.com * unmodified on failure. 18851df9e3fe3c1aec370854b2718df16fc02faa1b2reed@google.com */ 18951df9e3fe3c1aec370854b2718df16fc02faa1b2reed@google.com bool readPixels(const SkIRect& srcRect, SkBitmap* bitmap); 19051df9e3fe3c1aec370854b2718df16fc02faa1b2reed@google.com 19151df9e3fe3c1aec370854b2718df16fc02faa1b2reed@google.com /** 19251df9e3fe3c1aec370854b2718df16fc02faa1b2reed@google.com * Similar to draw sprite, this method will copy the pixels in bitmap onto 193d58a1cd00b969a7755c375f55cf80f4d49d3047bbsalomon@google.com * the canvas, with the top/left corner specified by (x, y). The canvas' 194d58a1cd00b969a7755c375f55cf80f4d49d3047bbsalomon@google.com * pixel values are completely replaced: there is no blending. 195d58a1cd00b969a7755c375f55cf80f4d49d3047bbsalomon@google.com * 196d58a1cd00b969a7755c375f55cf80f4d49d3047bbsalomon@google.com * Currently if bitmap is backed by a texture this is a no-op. This may be 197d58a1cd00b969a7755c375f55cf80f4d49d3047bbsalomon@google.com * relaxed in the future. 198d58a1cd00b969a7755c375f55cf80f4d49d3047bbsalomon@google.com * 199d58a1cd00b969a7755c375f55cf80f4d49d3047bbsalomon@google.com * If the bitmap has config kARGB_8888_Config then the config8888 param 200d58a1cd00b969a7755c375f55cf80f4d49d3047bbsalomon@google.com * will determines how the pixel valuess are intepreted. If the bitmap is 201d58a1cd00b969a7755c375f55cf80f4d49d3047bbsalomon@google.com * not kARGB_8888_Config then this parameter is ignored. 2024f1151ab27485aff393d16559086c4c461f137a4epoger@google.com * 2034f1151ab27485aff393d16559086c4c461f137a4epoger@google.com * Note: If you are recording drawing commands on this canvas to 2044f1151ab27485aff393d16559086c4c461f137a4epoger@google.com * SkPicture, writePixels() is ignored! 20551df9e3fe3c1aec370854b2718df16fc02faa1b2reed@google.com */ 206d58a1cd00b969a7755c375f55cf80f4d49d3047bbsalomon@google.com void writePixels(const SkBitmap& bitmap, 207d58a1cd00b969a7755c375f55cf80f4d49d3047bbsalomon@google.com int x, int y, 208d58a1cd00b969a7755c375f55cf80f4d49d3047bbsalomon@google.com Config8888 config8888 = kNative_Premul_Config8888); 2094b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com 2108a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /////////////////////////////////////////////////////////////////////////// 2118d84fac294682647694b0d2d8a87ac2bd19b6aabvandebo@chromium.org 2128a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com enum SaveFlags { 2138a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** save the matrix state, restoring it on restore() */ 2148a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com kMatrix_SaveFlag = 0x01, 2158a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** save the clip state, restoring it on restore() */ 2168a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com kClip_SaveFlag = 0x02, 2178a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** the layer needs to support per-pixel alpha */ 2188a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com kHasAlphaLayer_SaveFlag = 0x04, 2198a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** the layer needs to support 8-bits per color component */ 2208a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com kFullColorLayer_SaveFlag = 0x08, 2218a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** the layer should clip against the bounds argument */ 2228a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com kClipToLayer_SaveFlag = 0x10, 2238a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 2248a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com // helper masks for common choices 2258a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com kMatrixClip_SaveFlag = 0x03, 2268a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com kARGB_NoClipLayer_SaveFlag = 0x0F, 2278a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com kARGB_ClipLayer_SaveFlag = 0x1F 2288a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com }; 2298a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 230dc3381fc8194a6192af39539c6ac9787b20209d3reed@android.com /** This call saves the current matrix, clip, and drawFilter, and pushes a 2318a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com copy onto a private stack. Subsequent calls to translate, scale, 232dc3381fc8194a6192af39539c6ac9787b20209d3reed@android.com rotate, skew, concat or clipRect, clipPath, and setDrawFilter all 233dc3381fc8194a6192af39539c6ac9787b20209d3reed@android.com operate on this copy. 234dc3381fc8194a6192af39539c6ac9787b20209d3reed@android.com When the balancing call to restore() is made, the previous matrix, clip, 235dc3381fc8194a6192af39539c6ac9787b20209d3reed@android.com and drawFilter are restored. 2368a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @return The value to pass to restoreToCount() to balance this save() 2378a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 2388a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual int save(SaveFlags flags = kMatrixClip_SaveFlag); 2398a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 2408a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** This behaves the same as save(), but in addition it allocates an 2418a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com offscreen bitmap. All drawing calls are directed there, and only when 2428a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com the balancing call to restore() is made is that offscreen transfered to 243dc3381fc8194a6192af39539c6ac9787b20209d3reed@android.com the canvas (or the previous layer). 244ad164b2025cba65131ca68221a6ea7640d7b1de8reed@android.com @param bounds (may be null) This rect, if non-null, is used as a hint to 245ad164b2025cba65131ca68221a6ea7640d7b1de8reed@android.com limit the size of the offscreen, and thus drawing may be 246ad164b2025cba65131ca68221a6ea7640d7b1de8reed@android.com clipped to it, though that clipping is not guaranteed to 247ad164b2025cba65131ca68221a6ea7640d7b1de8reed@android.com happen. If exact clipping is desired, use clipRect(). 2488a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param paint (may be null) This is copied, and is applied to the 2498a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com offscreen when restore() is called 2508a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param flags LayerFlags 2518a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @return The value to pass to restoreToCount() to balance this save() 2528a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 2538a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual int saveLayer(const SkRect* bounds, const SkPaint* paint, 2548a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SaveFlags flags = kARGB_ClipLayer_SaveFlag); 2558a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 2568a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** This behaves the same as save(), but in addition it allocates an 2578a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com offscreen bitmap. All drawing calls are directed there, and only when 2588a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com the balancing call to restore() is made is that offscreen transfered to 259dc3381fc8194a6192af39539c6ac9787b20209d3reed@android.com the canvas (or the previous layer). 26040408614655c4057d93842c9b0f09aa6dfff9e02reed@android.com @param bounds (may be null) This rect, if non-null, is used as a hint to 26140408614655c4057d93842c9b0f09aa6dfff9e02reed@android.com limit the size of the offscreen, and thus drawing may be 26240408614655c4057d93842c9b0f09aa6dfff9e02reed@android.com clipped to it, though that clipping is not guaranteed to 26340408614655c4057d93842c9b0f09aa6dfff9e02reed@android.com happen. If exact clipping is desired, use clipRect(). 2648a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param alpha This is applied to the offscreen when restore() is called. 2658a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param flags LayerFlags 2668a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @return The value to pass to restoreToCount() to balance this save() 2678a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 2688a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com int saveLayerAlpha(const SkRect* bounds, U8CPU alpha, 2698a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SaveFlags flags = kARGB_ClipLayer_SaveFlag); 2708a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 2718a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** This call balances a previous call to save(), and is used to remove all 272dc3381fc8194a6192af39539c6ac9787b20209d3reed@android.com modifications to the matrix/clip/drawFilter state since the last save 273dc3381fc8194a6192af39539c6ac9787b20209d3reed@android.com call. 274dc3381fc8194a6192af39539c6ac9787b20209d3reed@android.com It is an error to call restore() more times than save() was called. 2758a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 2768a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual void restore(); 2778a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 2788a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Returns the number of matrix/clip states on the SkCanvas' private stack. 2798a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com This will equal # save() calls - # restore() calls. 2808a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 2818a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com int getSaveCount() const; 2828a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 2838a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Efficient way to pop any calls to save() that happened after the save 2848a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com count reached saveCount. It is an error for saveCount to be less than 2858a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com getSaveCount() 2868a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param saveCount The number of save() levels to restore from 2878a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 2888a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void restoreToCount(int saveCount); 2898a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 2908a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Preconcat the current matrix with the specified translation 2918a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param dx The distance to translate in X 2928a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param dy The distance to translate in Y 2938a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com returns true if the operation succeeded (e.g. did not overflow) 2948a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 2958a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual bool translate(SkScalar dx, SkScalar dy); 2968a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 2978a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Preconcat the current matrix with the specified scale. 2988a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param sx The amount to scale in X 2998a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param sy The amount to scale in Y 3008a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com returns true if the operation succeeded (e.g. did not overflow) 3018a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 3028a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual bool scale(SkScalar sx, SkScalar sy); 3038a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 3048a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Preconcat the current matrix with the specified rotation. 3058a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param degrees The amount to rotate, in degrees 3068a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com returns true if the operation succeeded (e.g. did not overflow) 3078a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 3088a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual bool rotate(SkScalar degrees); 3098a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 3108a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Preconcat the current matrix with the specified skew. 3118a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param sx The amount to skew in X 3128a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param sy The amount to skew in Y 3138a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com returns true if the operation succeeded (e.g. did not overflow) 3148a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 3158a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual bool skew(SkScalar sx, SkScalar sy); 3168a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 3178a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Preconcat the current matrix with the specified matrix. 3188a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param matrix The matrix to preconcatenate with the current matrix 3198a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @return true if the operation succeeded (e.g. did not overflow) 3208a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 3218a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual bool concat(const SkMatrix& matrix); 3224b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com 3238a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Replace the current matrix with a copy of the specified matrix. 3248a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param matrix The matrix that will be copied into the current matrix. 3258a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 3268a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual void setMatrix(const SkMatrix& matrix); 3274b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com 3288a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Helper for setMatrix(identity). Sets the current matrix to identity. 3298a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 3308a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void resetMatrix(); 3318a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 3328a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Modify the current clip with the specified rectangle. 3338a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param rect The rect to intersect with the current clip 3348a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param op The region op to apply to the current clip 3358a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @return true if the canvas' clip is non-empty 3368a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 3378a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual bool clipRect(const SkRect& rect, 338071eef918d70b6ca8334bc1241d1ea6923e828d5reed@google.com SkRegion::Op op = SkRegion::kIntersect_Op, 339071eef918d70b6ca8334bc1241d1ea6923e828d5reed@google.com bool doAntiAlias = false); 3408a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 3418a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Modify the current clip with the specified path. 3428a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param path The path to apply to the current clip 3438a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param op The region op to apply to the current clip 3448a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @return true if the canvas' new clip is non-empty 3458a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 3468a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual bool clipPath(const SkPath& path, 347071eef918d70b6ca8334bc1241d1ea6923e828d5reed@google.com SkRegion::Op op = SkRegion::kIntersect_Op, 348071eef918d70b6ca8334bc1241d1ea6923e828d5reed@google.com bool doAntiAlias = false); 3498a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 3508a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Modify the current clip with the specified region. Note that unlike 3518a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com clipRect() and clipPath() which transform their arguments by the current 3528a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com matrix, clipRegion() assumes its argument is already in device 3538a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com coordinates, and so no transformation is performed. 3548a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param deviceRgn The region to apply to the current clip 3558a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param op The region op to apply to the current clip 3568a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @return true if the canvas' new clip is non-empty 3578a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 3588a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual bool clipRegion(const SkRegion& deviceRgn, 3598a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkRegion::Op op = SkRegion::kIntersect_Op); 3608a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 3618a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Helper for clipRegion(rgn, kReplace_Op). Sets the current clip to the 3628a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com specified region. This does not intersect or in any other way account 3638a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com for the existing clip region. 3648a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param deviceRgn The region to copy into the current clip. 3658a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @return true if the new clip region is non-empty 3668a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 3678a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com bool setClipRegion(const SkRegion& deviceRgn) { 3688a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com return this->clipRegion(deviceRgn, SkRegion::kReplace_Op); 3698a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com } 3708a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 3718a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Enum describing how to treat edges when performing quick-reject tests 3728a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com of a geometry against the current clip. Treating them as antialiased 3738a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com (kAA_EdgeType) will take into account the extra pixels that may be drawn 3748a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com if the edge does not lie exactly on a device pixel boundary (after being 3758a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com transformed by the current matrix). 3768a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 3778a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com enum EdgeType { 3788a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Treat the edges as B&W (not antialiased) for the purposes of testing 3798a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com against the current clip 3808a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 3818a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com kBW_EdgeType, 3828a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Treat the edges as antialiased for the purposes of testing 3838a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com against the current clip 3848a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 3858a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com kAA_EdgeType 3868a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com }; 3878a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 3888a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Return true if the specified rectangle, after being transformed by the 3898a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com current matrix, would lie completely outside of the current clip. Call 3908a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com this to check if an area you intend to draw into is clipped out (and 3918a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com therefore you can skip making the draw calls). 3928a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param rect the rect to compare with the current clip 3938a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param et specifies how to treat the edges (see EdgeType) 3948a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @return true if the rect (transformed by the canvas' matrix) does not 3958a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com intersect with the canvas' clip 3968a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 3978a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com bool quickReject(const SkRect& rect, EdgeType et) const; 3988a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 3998a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Return true if the specified path, after being transformed by the 4008a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com current matrix, would lie completely outside of the current clip. Call 4018a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com this to check if an area you intend to draw into is clipped out (and 4028a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com therefore you can skip making the draw calls). Note, for speed it may 4038a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com return false even if the path itself might not intersect the clip 4048a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com (i.e. the bounds of the path intersects, but the path does not). 4058a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param path The path to compare with the current clip 4068a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param et specifies how to treat the edges (see EdgeType) 4078a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @return true if the path (transformed by the canvas' matrix) does not 4088a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com intersect with the canvas' clip 4098a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 4108a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com bool quickReject(const SkPath& path, EdgeType et) const; 4118a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 4128a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Return true if the horizontal band specified by top and bottom is 4138a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com completely clipped out. This is a conservative calculation, meaning 4148a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com that it is possible that if the method returns false, the band may still 4158a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com in fact be clipped out, but the converse is not true. If this method 4168a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com returns true, then the band is guaranteed to be clipped out. 4178a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param top The top of the horizontal band to compare with the clip 4188a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param bottom The bottom of the horizontal and to compare with the clip 4198a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @return true if the horizontal band is completely clipped out (i.e. does 4208a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com not intersect the current clip) 4218a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 4228a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com bool quickRejectY(SkScalar top, SkScalar bottom, EdgeType et) const; 4238a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 4248a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Return the bounds of the current clip (in local coordinates) in the 4258a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com bounds parameter, and return true if it is non-empty. This can be useful 4268a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com in a way similar to quickReject, in that it tells you that drawing 4278a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com outside of these bounds will be clipped out. 4288a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 4298a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com bool getClipBounds(SkRect* bounds, EdgeType et = kAA_EdgeType) const; 4308a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 431bcb671c82a7341253864cda3a5c46d396402d7fbtomhudson@google.com /** Return the bounds of the current clip, in device coordinates; returns 432bcb671c82a7341253864cda3a5c46d396402d7fbtomhudson@google.com true if non-empty. Maybe faster than getting the clip explicitly and 433bcb671c82a7341253864cda3a5c46d396402d7fbtomhudson@google.com then taking its bounds. 434bcb671c82a7341253864cda3a5c46d396402d7fbtomhudson@google.com */ 435bcb671c82a7341253864cda3a5c46d396402d7fbtomhudson@google.com bool getClipDeviceBounds(SkIRect* bounds) const; 436bcb671c82a7341253864cda3a5c46d396402d7fbtomhudson@google.com 437bcb671c82a7341253864cda3a5c46d396402d7fbtomhudson@google.com 4388a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Fill the entire canvas' bitmap (restricted to the current clip) with the 439845fdaca174f4675e9acc164b510e3a5ffa9053creed@android.com specified ARGB color, using the specified mode. 4408a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param a the alpha component (0..255) of the color to fill the canvas 4418a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param r the red component (0..255) of the color to fill the canvas 4428a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param g the green component (0..255) of the color to fill the canvas 4438a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param b the blue component (0..255) of the color to fill the canvas 4448a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param mode the mode to apply the color in (defaults to SrcOver) 4458a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 4468a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void drawARGB(U8CPU a, U8CPU r, U8CPU g, U8CPU b, 447845fdaca174f4675e9acc164b510e3a5ffa9053creed@android.com SkXfermode::Mode mode = SkXfermode::kSrcOver_Mode); 4488a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 4498a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Fill the entire canvas' bitmap (restricted to the current clip) with the 450845fdaca174f4675e9acc164b510e3a5ffa9053creed@android.com specified color and mode. 4518a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param color the color to draw with 4528a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param mode the mode to apply the color in (defaults to SrcOver) 4538a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 4548a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void drawColor(SkColor color, 455845fdaca174f4675e9acc164b510e3a5ffa9053creed@android.com SkXfermode::Mode mode = SkXfermode::kSrcOver_Mode); 4568a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 4572a98181f048c11f21f52fbd99f803f5fd6118261reed@google.com /** 4582a98181f048c11f21f52fbd99f803f5fd6118261reed@google.com * This erases the entire drawing surface to the specified color, 4592a98181f048c11f21f52fbd99f803f5fd6118261reed@google.com * irrespective of the clip. It does not blend with the previous pixels, 4602a98181f048c11f21f52fbd99f803f5fd6118261reed@google.com * but always overwrites them. 4612a98181f048c11f21f52fbd99f803f5fd6118261reed@google.com * 4622a98181f048c11f21f52fbd99f803f5fd6118261reed@google.com * It is roughly equivalent to the following: 4632a98181f048c11f21f52fbd99f803f5fd6118261reed@google.com * canvas.save(); 4642a98181f048c11f21f52fbd99f803f5fd6118261reed@google.com * canvas.clipRect(hugeRect, kReplace_Op); 4652a98181f048c11f21f52fbd99f803f5fd6118261reed@google.com * paint.setColor(color); 4662a98181f048c11f21f52fbd99f803f5fd6118261reed@google.com * paint.setXfermodeMode(kSrc_Mode); 4672a98181f048c11f21f52fbd99f803f5fd6118261reed@google.com * canvas.drawPaint(paint); 4682a98181f048c11f21f52fbd99f803f5fd6118261reed@google.com * canvas.restore(); 4692a98181f048c11f21f52fbd99f803f5fd6118261reed@google.com * though it is almost always much more efficient. 4702a98181f048c11f21f52fbd99f803f5fd6118261reed@google.com */ 4712a98181f048c11f21f52fbd99f803f5fd6118261reed@google.com virtual void clear(SkColor); 4722a98181f048c11f21f52fbd99f803f5fd6118261reed@google.com 4732a98181f048c11f21f52fbd99f803f5fd6118261reed@google.com /** 4742a98181f048c11f21f52fbd99f803f5fd6118261reed@google.com * Fill the entire canvas' bitmap (restricted to the current clip) with the 4752a98181f048c11f21f52fbd99f803f5fd6118261reed@google.com * specified paint. 4762a98181f048c11f21f52fbd99f803f5fd6118261reed@google.com * @param paint The paint used to fill the canvas 4772a98181f048c11f21f52fbd99f803f5fd6118261reed@google.com */ 4788a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual void drawPaint(const SkPaint& paint); 4798a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 4808a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com enum PointMode { 4818a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** drawPoints draws each point separately */ 4828a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com kPoints_PointMode, 4838a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** drawPoints draws each pair of points as a line segment */ 4848a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com kLines_PointMode, 4858a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** drawPoints draws the array of points as a polygon */ 4868a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com kPolygon_PointMode 4878a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com }; 4888a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 4898a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Draw a series of points, interpreted based on the PointMode mode. For 4908a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com all modes, the count parameter is interpreted as the total number of 4918a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com points. For kLine mode, count/2 line segments are drawn. 4928a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com For kPoint mode, each point is drawn centered at its coordinate, and its 4938a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com size is specified by the paint's stroke-width. It draws as a square, 4948a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com unless the paint's cap-type is round, in which the points are drawn as 4958a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com circles. 4968a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com For kLine mode, each pair of points is drawn as a line segment, 4978a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com respecting the paint's settings for cap/join/width. 4988a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com For kPolygon mode, the entire array is drawn as a series of connected 4998a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com line segments. 5008a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com Note that, while similar, kLine and kPolygon modes draw slightly 5018a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com differently than the equivalent path built with a series of moveto, 5028a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com lineto calls, in that the path will draw all of its contours at once, 5038a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com with no interactions if contours intersect each other (think XOR 5048a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com xfermode). drawPoints always draws each element one at a time. 5058a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param mode PointMode specifying how to draw the array of points. 5068a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param count The number of points in the array 5078a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param pts Array of points to draw 5088a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param paint The paint used to draw the points 5098a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 5108a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual void drawPoints(PointMode mode, size_t count, const SkPoint pts[], 5118a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkPaint& paint); 5128a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 5138a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Helper method for drawing a single point. See drawPoints() for a more 5148a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com details. 5158a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 5168a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void drawPoint(SkScalar x, SkScalar y, const SkPaint& paint); 5174b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com 5188a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Draws a single pixel in the specified color. 5198a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param x The X coordinate of which pixel to draw 5208a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param y The Y coordiante of which pixel to draw 5218a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param color The color to draw 5228a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 5238a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void drawPoint(SkScalar x, SkScalar y, SkColor color); 5248a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 5258a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Draw a line segment with the specified start and stop x,y coordinates, 5268a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com using the specified paint. NOTE: since a line is always "framed", the 5278a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com paint's Style is ignored. 5288a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param x0 The x-coordinate of the start point of the line 5298a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param y0 The y-coordinate of the start point of the line 5308a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param x1 The x-coordinate of the end point of the line 5318a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param y1 The y-coordinate of the end point of the line 5328a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param paint The paint used to draw the line 5338a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 5348a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void drawLine(SkScalar x0, SkScalar y0, SkScalar x1, SkScalar y1, 5358a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkPaint& paint); 5368a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 5378a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Draw the specified rectangle using the specified paint. The rectangle 5388a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com will be filled or stroked based on the Style in the paint. 5398a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param rect The rect to be drawn 5408a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param paint The paint used to draw the rect 5418a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 5428a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual void drawRect(const SkRect& rect, const SkPaint& paint); 5438a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 5448a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Draw the specified rectangle using the specified paint. The rectangle 5458a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com will be filled or framed based on the Style in the paint. 5468a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param rect The rect to be drawn 5478a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param paint The paint used to draw the rect 5488a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 5498a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void drawIRect(const SkIRect& rect, const SkPaint& paint) 5508a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com { 5518a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkRect r; 5528a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com r.set(rect); // promotes the ints to scalars 5538a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com this->drawRect(r, paint); 5548a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com } 5554b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com 5568a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Draw the specified rectangle using the specified paint. The rectangle 5578a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com will be filled or framed based on the Style in the paint. 5588a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param left The left side of the rectangle to be drawn 5598a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param top The top side of the rectangle to be drawn 5608a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param right The right side of the rectangle to be drawn 5618a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param bottom The bottom side of the rectangle to be drawn 5628a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param paint The paint used to draw the rect 5638a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 5648a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void drawRectCoords(SkScalar left, SkScalar top, SkScalar right, 5658a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkScalar bottom, const SkPaint& paint); 5668a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 5678a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Draw the specified oval using the specified paint. The oval will be 5688a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com filled or framed based on the Style in the paint. 5698a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param oval The rectangle bounds of the oval to be drawn 5708a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param paint The paint used to draw the oval 5718a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 5728a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void drawOval(const SkRect& oval, const SkPaint&); 5738a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 5748a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Draw the specified circle using the specified paint. If radius is <= 0, 5758a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com then nothing will be drawn. The circle will be filled 5768a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com or framed based on the Style in the paint. 5778a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param cx The x-coordinate of the center of the cirle to be drawn 5788a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param cy The y-coordinate of the center of the cirle to be drawn 5798a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param radius The radius of the cirle to be drawn 5808a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param paint The paint used to draw the circle 5818a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 5828a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void drawCircle(SkScalar cx, SkScalar cy, SkScalar radius, 5838a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkPaint& paint); 5848a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 5858a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Draw the specified arc, which will be scaled to fit inside the 5868a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com specified oval. If the sweep angle is >= 360, then the oval is drawn 5878a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com completely. Note that this differs slightly from SkPath::arcTo, which 5888a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com treats the sweep angle mod 360. 5898a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param oval The bounds of oval used to define the shape of the arc 5908a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param startAngle Starting angle (in degrees) where the arc begins 5918a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param sweepAngle Sweep angle (in degrees) measured clockwise 5928a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param useCenter true means include the center of the oval. For filling 5938a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com this will draw a wedge. False means just use the arc. 5948a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param paint The paint used to draw the arc 5958a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 5968a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void drawArc(const SkRect& oval, SkScalar startAngle, SkScalar sweepAngle, 5978a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com bool useCenter, const SkPaint& paint); 5988a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 5998a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Draw the specified round-rect using the specified paint. The round-rect 6008a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com will be filled or framed based on the Style in the paint. 6018a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param rect The rectangular bounds of the roundRect to be drawn 6028a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param rx The x-radius of the oval used to round the corners 6038a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param ry The y-radius of the oval used to round the corners 6048a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param paint The paint used to draw the roundRect 6058a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 6068a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void drawRoundRect(const SkRect& rect, SkScalar rx, SkScalar ry, 6078a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkPaint& paint); 6088a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 6098a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Draw the specified path using the specified paint. The path will be 6108a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com filled or framed based on the Style in the paint. 6118a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param path The path to be drawn 6128a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param paint The paint used to draw the path 6138a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 6148a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual void drawPath(const SkPath& path, const SkPaint& paint); 6158a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 6168a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Draw the specified bitmap, with its top/left corner at (x,y), using the 6178a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com specified paint, transformed by the current matrix. Note: if the paint 6188a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com contains a maskfilter that generates a mask which extends beyond the 6198a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com bitmap's original width/height, then the bitmap will be drawn as if it 6208a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com were in a Shader with CLAMP mode. Thus the color outside of the original 6218a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com width/height will be the edge color replicated. 6228a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param bitmap The bitmap to be drawn 6238a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param left The position of the left side of the bitmap being drawn 6248a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param top The position of the top side of the bitmap being drawn 6258a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param paint The paint used to draw the bitmap, or NULL 6268a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 6278a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual void drawBitmap(const SkBitmap& bitmap, SkScalar left, SkScalar top, 6288a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkPaint* paint = NULL); 6298a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 6308a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Draw the specified bitmap, with the specified matrix applied (before the 6318a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com canvas' matrix is applied). 6328a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param bitmap The bitmap to be drawn 6338a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param src Optional: specify the subset of the bitmap to be drawn 6348a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param dst The destination rectangle where the scaled/translated 6358a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com image will be drawn 6368a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param paint The paint used to draw the bitmap, or NULL 6378a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 6388a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual void drawBitmapRect(const SkBitmap& bitmap, const SkIRect* src, 6398a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkRect& dst, const SkPaint* paint = NULL); 6408a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 6418a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual void drawBitmapMatrix(const SkBitmap& bitmap, const SkMatrix& m, 6428a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkPaint* paint = NULL); 6434b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com 644f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com /** 645f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com * Draw the bitmap stretched differentially to fit into dst. 646f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com * center is a rect within the bitmap, and logically divides the bitmap 647f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com * into 9 sections (3x3). For example, if the middle pixel of a [5x5] 648f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com * bitmap is the "center", then the center-rect should be [2, 2, 3, 3]. 649f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com * 650f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com * If the dst is >= the bitmap size, then... 651f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com * - The 4 corners are not stretch at all. 652f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com * - The sides are stretch in only one axis. 653f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com * - The center is stretch in both axes. 654f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com * Else, for each axis where dst < bitmap, 655f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com * - The corners shrink proportionally 656f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com * - The sides (along the shrink axis) and center are not drawn 657f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com */ 658f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com virtual void drawBitmapNine(const SkBitmap& bitmap, const SkIRect& center, 659f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com const SkRect& dst, const SkPaint* paint = NULL); 660f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com 6618a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Draw the specified bitmap, with its top/left corner at (x,y), 6628a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com NOT transformed by the current matrix. Note: if the paint 6638a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com contains a maskfilter that generates a mask which extends beyond the 6648a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com bitmap's original width/height, then the bitmap will be drawn as if it 6658a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com were in a Shader with CLAMP mode. Thus the color outside of the original 6668a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com width/height will be the edge color replicated. 6678a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param bitmap The bitmap to be drawn 6688a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param left The position of the left side of the bitmap being drawn 6698a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param top The position of the top side of the bitmap being drawn 6708a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param paint The paint used to draw the bitmap, or NULL 6718a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 6728a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual void drawSprite(const SkBitmap& bitmap, int left, int top, 6738a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkPaint* paint = NULL); 6748a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 6758a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Draw the text, with origin at (x,y), using the specified paint. 6768a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com The origin is interpreted based on the Align setting in the paint. 6778a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param text The text to be drawn 6788a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param byteLength The number of bytes to read from the text parameter 6798a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param x The x-coordinate of the origin of the text being drawn 6808a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param y The y-coordinate of the origin of the text being drawn 6818a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param paint The paint used for the text (e.g. color, size, style) 6828a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 6838a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual void drawText(const void* text, size_t byteLength, SkScalar x, 6848a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkScalar y, const SkPaint& paint); 6858a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 6868a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Draw the text, with each character/glyph origin specified by the pos[] 6874b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com array. The origin is interpreted by the Align setting in the paint. 6888a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param text The text to be drawn 6898a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param byteLength The number of bytes to read from the text parameter 6908a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param pos Array of positions, used to position each character 6918a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param paint The paint used for the text (e.g. color, size, style) 6928a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 6938a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual void drawPosText(const void* text, size_t byteLength, 6948a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkPoint pos[], const SkPaint& paint); 6954b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com 6968a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Draw the text, with each character/glyph origin specified by the x 6978a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com coordinate taken from the xpos[] array, and the y from the constY param. 6984b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com The origin is interpreted by the Align setting in the paint. 6998a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param text The text to be drawn 7008a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param byteLength The number of bytes to read from the text parameter 7018a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param xpos Array of x-positions, used to position each character 7028a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param constY The shared Y coordinate for all of the positions 7038a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param paint The paint used for the text (e.g. color, size, style) 7048a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 7058a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual void drawPosTextH(const void* text, size_t byteLength, 7068a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkScalar xpos[], SkScalar constY, 7078a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkPaint& paint); 7084b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com 7098a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Draw the text, with origin at (x,y), using the specified paint, along 7108a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com the specified path. The paint's Align setting determins where along the 7118a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com path to start the text. 7128a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param text The text to be drawn 7138a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param byteLength The number of bytes to read from the text parameter 7148a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param path The path the text should follow for its baseline 7158a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param hOffset The distance along the path to add to the text's 7168a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com starting position 7178a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param vOffset The distance above(-) or below(+) the path to 7188a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com position the text 7198a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param paint The paint used for the text 7208a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 7218a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void drawTextOnPathHV(const void* text, size_t byteLength, 7228a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkPath& path, SkScalar hOffset, 7238a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkScalar vOffset, const SkPaint& paint); 7248a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 7258a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Draw the text, with origin at (x,y), using the specified paint, along 7268a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com the specified path. The paint's Align setting determins where along the 7278a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com path to start the text. 7288a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param text The text to be drawn 7298a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param byteLength The number of bytes to read from the text parameter 7308a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param path The path the text should follow for its baseline 7318a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param matrix (may be null) Applied to the text before it is 7328a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com mapped onto the path 7338a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param paint The paint used for the text 7348a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 7358a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual void drawTextOnPath(const void* text, size_t byteLength, 7368a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkPath& path, const SkMatrix* matrix, 7378a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkPaint& paint); 7388a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 73956c69773aea56c6c6bd47bc7e7970dd081205184djsollen@google.com#ifdef SK_BUILD_FOR_ANDROID 740cd9d69b9ce7eb301a9fd8d91b9f95fd99b07bae5djsollen@google.com /** Draw the text on path, with each character/glyph origin specified by the pos[] 741cd9d69b9ce7eb301a9fd8d91b9f95fd99b07bae5djsollen@google.com array. The origin is interpreted by the Align setting in the paint. 742cd9d69b9ce7eb301a9fd8d91b9f95fd99b07bae5djsollen@google.com @param text The text to be drawn 743cd9d69b9ce7eb301a9fd8d91b9f95fd99b07bae5djsollen@google.com @param byteLength The number of bytes to read from the text parameter 744cd9d69b9ce7eb301a9fd8d91b9f95fd99b07bae5djsollen@google.com @param pos Array of positions, used to position each character 745cd9d69b9ce7eb301a9fd8d91b9f95fd99b07bae5djsollen@google.com @param paint The paint used for the text (e.g. color, size, style) 746cd9d69b9ce7eb301a9fd8d91b9f95fd99b07bae5djsollen@google.com @param path The path to draw on 747cd9d69b9ce7eb301a9fd8d91b9f95fd99b07bae5djsollen@google.com @param matrix The canvas matrix 748cd9d69b9ce7eb301a9fd8d91b9f95fd99b07bae5djsollen@google.com */ 749cd9d69b9ce7eb301a9fd8d91b9f95fd99b07bae5djsollen@google.com void drawPosTextOnPath(const void* text, size_t byteLength, 750cd9d69b9ce7eb301a9fd8d91b9f95fd99b07bae5djsollen@google.com const SkPoint pos[], const SkPaint& paint, 751cd9d69b9ce7eb301a9fd8d91b9f95fd99b07bae5djsollen@google.com const SkPath& path, const SkMatrix* matrix); 752cd9d69b9ce7eb301a9fd8d91b9f95fd99b07bae5djsollen@google.com#endif 753cd9d69b9ce7eb301a9fd8d91b9f95fd99b07bae5djsollen@google.com 7548a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Draw the picture into this canvas. This method effective brackets the 7558a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com playback of the picture's draw calls with save/restore, so the state 7568a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com of this canvas will be unchanged after this call. This contrasts with 7578a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com the more immediate method SkPicture::draw(), which does not bracket 7588a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com the canvas with save/restore, thus the canvas may be left in a changed 7598a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com state after the call. 7608a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param picture The recorded drawing commands to playback into this 7618a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com canvas. 7628a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 7638a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual void drawPicture(SkPicture& picture); 7644b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com 7658a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com enum VertexMode { 7668a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com kTriangles_VertexMode, 7678a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com kTriangleStrip_VertexMode, 7688a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com kTriangleFan_VertexMode 7698a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com }; 7704b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com 7718a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Draw the array of vertices, interpreted as triangles (based on mode). 7728a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param vmode How to interpret the array of vertices 7738a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param vertexCount The number of points in the vertices array (and 7748a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com corresponding texs and colors arrays if non-null) 7758a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param vertices Array of vertices for the mesh 7768a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param texs May be null. If not null, specifies the coordinate 7778a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com in texture space for each vertex. 7788a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param colors May be null. If not null, specifies a color for each 7798a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com vertex, to be interpolated across the triangle. 7808a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param xmode Used if both texs and colors are present. In this 7818a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com case the colors are combined with the texture using mode, 7828a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com before being drawn using the paint. If mode is null, then 783845fdaca174f4675e9acc164b510e3a5ffa9053creed@android.com kMultiply_Mode is used. 7848a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param indices If not null, array of indices to reference into the 7858a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com vertex (texs, colors) array. 7868a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param indexCount number of entries in the indices array (if not null) 7874b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com @param paint Specifies the shader/texture if present. 7888a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 7898a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual void drawVertices(VertexMode vmode, int vertexCount, 7908a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkPoint vertices[], const SkPoint texs[], 7918a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkColor colors[], SkXfermode* xmode, 7928a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const uint16_t indices[], int indexCount, 7938a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkPaint& paint); 7948a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 795cb60844b34766aad4151df5e87c144d4a57e9abereed@android.com /** Send a blob of data to the canvas. 796cb60844b34766aad4151df5e87c144d4a57e9abereed@android.com For canvases that draw, this call is effectively a no-op, as the data 797cb60844b34766aad4151df5e87c144d4a57e9abereed@android.com is not parsed, but just ignored. However, this call exists for 798cb60844b34766aad4151df5e87c144d4a57e9abereed@android.com subclasses like SkPicture's recording canvas, that can store the data 799cb60844b34766aad4151df5e87c144d4a57e9abereed@android.com and then play it back later (via another call to drawData). 800cb60844b34766aad4151df5e87c144d4a57e9abereed@android.com */ 801cb60844b34766aad4151df5e87c144d4a57e9abereed@android.com virtual void drawData(const void* data, size_t length); 802cb60844b34766aad4151df5e87c144d4a57e9abereed@android.com 8038a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com ////////////////////////////////////////////////////////////////////////// 8044b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com 8058a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Get the current bounder object. 8068a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com The bounder's reference count is unchaged. 8078a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @return the canva's bounder (or NULL). 8088a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 8098a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkBounder* getBounder() const { return fBounder; } 8108a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 8118a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Set a new bounder (or NULL). 8128a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com Pass NULL to clear any previous bounder. 8138a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com As a convenience, the parameter passed is also returned. 8148a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com If a previous bounder exists, its reference count is decremented. 8158a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com If bounder is not NULL, its reference count is incremented. 8168a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param bounder the new bounder (or NULL) to be installed in the canvas 8178a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @return the set bounder object 8188a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 8198a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual SkBounder* setBounder(SkBounder* bounder); 8204b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com 8218a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Get the current filter object. The filter's reference count is not 822dc3381fc8194a6192af39539c6ac9787b20209d3reed@android.com affected. The filter is saved/restored, just like the matrix and clip. 8238a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @return the canvas' filter (or NULL). 8248a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 8258a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkDrawFilter* getDrawFilter() const; 8264b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com 8278a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Set the new filter (or NULL). Pass NULL to clear any existing filter. 8288a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com As a convenience, the parameter is returned. If an existing filter 8298a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com exists, its refcnt is decrement. If the new filter is not null, its 830dc3381fc8194a6192af39539c6ac9787b20209d3reed@android.com refcnt is incremented. The filter is saved/restored, just like the 831dc3381fc8194a6192af39539c6ac9787b20209d3reed@android.com matrix and clip. 8328a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @param filter the new filter (or NULL) 8338a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @return the new filter 8348a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 8358a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com virtual SkDrawFilter* setDrawFilter(SkDrawFilter* filter); 8368a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 8378a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com ////////////////////////////////////////////////////////////////////////// 8388a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 8398a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Return the current matrix on the canvas. 8408a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com This does not account for the translate in any of the devices. 8418a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @return The current matrix on the canvas. 8428a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 8438a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkMatrix& getTotalMatrix() const; 8448a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 845bcb671c82a7341253864cda3a5c46d396402d7fbtomhudson@google.com enum ClipType { 846bcb671c82a7341253864cda3a5c46d396402d7fbtomhudson@google.com kEmpty_ClipType = 0, 847bcb671c82a7341253864cda3a5c46d396402d7fbtomhudson@google.com kRect_ClipType, 848bcb671c82a7341253864cda3a5c46d396402d7fbtomhudson@google.com kComplex_ClipType 849bcb671c82a7341253864cda3a5c46d396402d7fbtomhudson@google.com }; 850bcb671c82a7341253864cda3a5c46d396402d7fbtomhudson@google.com 851bcb671c82a7341253864cda3a5c46d396402d7fbtomhudson@google.com /** Returns a description of the total clip; may be cheaper than 852bcb671c82a7341253864cda3a5c46d396402d7fbtomhudson@google.com getting the clip and querying it directly. 853bcb671c82a7341253864cda3a5c46d396402d7fbtomhudson@google.com */ 854bcb671c82a7341253864cda3a5c46d396402d7fbtomhudson@google.com ClipType getClipType() const; 855bcb671c82a7341253864cda3a5c46d396402d7fbtomhudson@google.com 8568a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Return the current device clip (concatenation of all clip calls). 8578a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com This does not account for the translate in any of the devices. 8588a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com @return the current device clip (concatenation of all clip calls). 8598a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 8608a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkRegion& getTotalClip() const; 8618a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 8627d7ca79c3e6e6be7b7849b0d9a7fe26effb89c38reed@google.com /** 8635e2457ef2eba0c3f2e4c8fc89be7f36659e4f3b1reed@google.com * Return true if the current clip is non-empty. 8645e2457ef2eba0c3f2e4c8fc89be7f36659e4f3b1reed@google.com * 8655e2457ef2eba0c3f2e4c8fc89be7f36659e4f3b1reed@google.com * If bounds is not NULL, set it to the bounds of the current clip 8665e2457ef2eba0c3f2e4c8fc89be7f36659e4f3b1reed@google.com * in global coordinates. 8675e2457ef2eba0c3f2e4c8fc89be7f36659e4f3b1reed@google.com */ 8685e2457ef2eba0c3f2e4c8fc89be7f36659e4f3b1reed@google.com bool getTotalClipBounds(SkIRect* bounds) const; 8695e2457ef2eba0c3f2e4c8fc89be7f36659e4f3b1reed@google.com 8705e2457ef2eba0c3f2e4c8fc89be7f36659e4f3b1reed@google.com /** 8717d7ca79c3e6e6be7b7849b0d9a7fe26effb89c38reed@google.com * Return the current clipstack. This mirrors the result in getTotalClip() 8727d7ca79c3e6e6be7b7849b0d9a7fe26effb89c38reed@google.com * but is represented as a stack of geometric clips + region-ops. 8737d7ca79c3e6e6be7b7849b0d9a7fe26effb89c38reed@google.com */ 8747d7ca79c3e6e6be7b7849b0d9a7fe26effb89c38reed@google.com const SkClipStack& getTotalClipStack() const; 8757d7ca79c3e6e6be7b7849b0d9a7fe26effb89c38reed@google.com 876f2b98d67dcb6fcb3120feede9c72016fc7b3ead8reed@android.com void setExternalMatrix(const SkMatrix* = NULL); 8778a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 8788a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /////////////////////////////////////////////////////////////////////////// 8798a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 8808a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** After calling saveLayer(), there can be any number of devices that make 8818a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com up the top-most drawing area. LayerIter can be used to iterate through 8828a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com those devices. Note that the iterator is only valid until the next API 8838a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com call made on the canvas. Ownership of all pointers in the iterator stays 8848a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com with the canvas, so none of them should be modified or deleted. 8858a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 8867ffb1b21abcc7bbed5a0fc711f6dd7b9dbb4f577ctguil@chromium.org class SK_API LayerIter /*: SkNoncopyable*/ { 8878a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com public: 8888a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Initialize iterator with canvas, and set values for 1st device */ 8898a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com LayerIter(SkCanvas*, bool skipEmptyClips); 8908a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com ~LayerIter(); 8914b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com 8928a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Return true if the iterator is done */ 8938a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com bool done() const { return fDone; } 8948a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Cycle to the next device */ 8958a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void next(); 8964b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com 8978a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com // These reflect the current device in the iterator 8988a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 8998a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkDevice* device() const; 9008a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkMatrix& matrix() const; 9018a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkRegion& clip() const; 9028a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkPaint& paint() const; 9038a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com int x() const; 9048a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com int y() const; 9054b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com 9068a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com private: 9078a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com // used to embed the SkDrawIter object directly in our instance, w/o 9088a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com // having to expose that class def to the public. There is an assert 9098a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com // in our constructor to ensure that fStorage is large enough 9108a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com // (though needs to be a compile-time-assert!). We use intptr_t to work 9118a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com // safely with 32 and 64 bit machines (to ensure the storage is enough) 912f2b98d67dcb6fcb3120feede9c72016fc7b3ead8reed@android.com intptr_t fStorage[32]; 9138a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com class SkDrawIter* fImpl; // this points at fStorage 9148a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkPaint fDefaultPaint; 9158a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com bool fDone; 9168a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com }; 9178a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 9188a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comprotected: 9198a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com // all of the drawBitmap variants call this guy 920f2b98d67dcb6fcb3120feede9c72016fc7b3ead8reed@android.com virtual void commonDrawBitmap(const SkBitmap&, const SkIRect*, 921f2b98d67dcb6fcb3120feede9c72016fc7b3ead8reed@android.com const SkMatrix&, const SkPaint& paint); 9224b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com 9238a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comprivate: 9248a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com class MCRec; 9258a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 9265c3d1471e4908706cd053a5e2ea9ded3a6c2eaebreed@google.com SkClipStack fClipStack; 9278a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkDeque fMCStack; 9288a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com // points to top of stack 9298a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com MCRec* fMCRec; 9308a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com // the first N recs that can fit here mean we won't call malloc 9318a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com uint32_t fMCRecStorage[32]; 9328a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 9338a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkBounder* fBounder; 934199f108f14a5f60a9c2205ffa79b26102a206ad0reed@android.com SkDevice* fLastDeviceToGainFocus; 9358a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 936d302f1401b3c9aea094804bad4e76de98782cfe8bsalomon@google.com void prepareForDeviceDraw(SkDevice*, const SkMatrix&, const SkRegion&, 937d302f1401b3c9aea094804bad4e76de98782cfe8bsalomon@google.com const SkClipStack& clipStack); 9384b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com 9398a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com bool fDeviceCMDirty; // cleared by updateDeviceCMCache() 9408a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void updateDeviceCMCache(); 9418a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 9428a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com friend class SkDrawIter; // needs setupDrawForLayerDevice() 9438a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 944e97f0856a8044866b12527819d14cdfbcdfd96f2bsalomon@google.com SkDevice* createLayerDevice(SkBitmap::Config, int width, int height, 945e97f0856a8044866b12527819d14cdfbcdfd96f2bsalomon@google.com bool isOpaque); 946e97f0856a8044866b12527819d14cdfbcdfd96f2bsalomon@google.com 9478a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkDevice* init(SkDevice*); 948f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com 949f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com // internal methods are not virtual, so they can safely be called by other 950f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com // canvas apis, without confusing subclasses (like SkPictureRecording) 951f2b98d67dcb6fcb3120feede9c72016fc7b3ead8reed@android.com void internalDrawBitmap(const SkBitmap&, const SkIRect*, const SkMatrix& m, 9528a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkPaint* paint); 953f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com void internalDrawBitmapRect(const SkBitmap& bitmap, const SkIRect* src, 954f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com const SkRect& dst, const SkPaint* paint); 955f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com void internalDrawBitmapNine(const SkBitmap& bitmap, const SkIRect& center, 956f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com const SkRect& dst, const SkPaint* paint); 957fa6ac938e64fe11b442d05fe8a90ddac2d1951f9bsalomon@google.com void internalDrawPaint(const SkPaint& paint); 958fa6ac938e64fe11b442d05fe8a90ddac2d1951f9bsalomon@google.com 959f0b5e1190af9807a027c0adba2f1380663c8e910reed@google.com 9608a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void drawDevice(SkDevice*, int x, int y, const SkPaint*); 9618a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com // shared by save() and saveLayer() 9628a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com int internalSave(SaveFlags flags); 9638a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void internalRestore(); 96452c748b1691f02f90b27c35bc05074fcef709e66bungeman@google.com static void DrawRect(const SkDraw& draw, const SkPaint& paint, 96552c748b1691f02f90b27c35bc05074fcef709e66bungeman@google.com const SkRect& r, SkScalar textSize); 96652c748b1691f02f90b27c35bc05074fcef709e66bungeman@google.com static void DrawTextDecorations(const SkDraw& draw, const SkPaint& paint, 96752c748b1691f02f90b27c35bc05074fcef709e66bungeman@google.com const char text[], size_t byteLength, 96852c748b1691f02f90b27c35bc05074fcef709e66bungeman@google.com SkScalar x, SkScalar y); 9694b226023832011bc3bcdd1e5092ff0645ad0bdeereed@google.com 9708a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /* These maintain a cache of the clip bounds in local coordinates, 9718a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com (converted to 2s-compliment if floats are slow). 9728a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 9738a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com mutable SkRectCompareType fLocalBoundsCompareType; 9748a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com mutable bool fLocalBoundsCompareTypeDirty; 9758a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 976ba09de4c4be66cc07790f23b0f3a925f47340e3ereed@android.com mutable SkRectCompareType fLocalBoundsCompareTypeBW; 977ba09de4c4be66cc07790f23b0f3a925f47340e3ereed@android.com mutable bool fLocalBoundsCompareTypeDirtyBW; 978ba09de4c4be66cc07790f23b0f3a925f47340e3ereed@android.com 979ba09de4c4be66cc07790f23b0f3a925f47340e3ereed@android.com /* Get the local clip bounds with an anti-aliased edge. 980ba09de4c4be66cc07790f23b0f3a925f47340e3ereed@android.com */ 9818a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com const SkRectCompareType& getLocalClipBoundsCompareType() const { 982ba09de4c4be66cc07790f23b0f3a925f47340e3ereed@android.com return getLocalClipBoundsCompareType(kAA_EdgeType); 983ba09de4c4be66cc07790f23b0f3a925f47340e3ereed@android.com } 984ba09de4c4be66cc07790f23b0f3a925f47340e3ereed@android.com 985ba09de4c4be66cc07790f23b0f3a925f47340e3ereed@android.com const SkRectCompareType& getLocalClipBoundsCompareType(EdgeType et) const { 986ba09de4c4be66cc07790f23b0f3a925f47340e3ereed@android.com if (et == kAA_EdgeType) { 987ba09de4c4be66cc07790f23b0f3a925f47340e3ereed@android.com if (fLocalBoundsCompareTypeDirty) { 988ba09de4c4be66cc07790f23b0f3a925f47340e3ereed@android.com this->computeLocalClipBoundsCompareType(et); 989ba09de4c4be66cc07790f23b0f3a925f47340e3ereed@android.com fLocalBoundsCompareTypeDirty = false; 990ba09de4c4be66cc07790f23b0f3a925f47340e3ereed@android.com } 991ba09de4c4be66cc07790f23b0f3a925f47340e3ereed@android.com return fLocalBoundsCompareType; 992ba09de4c4be66cc07790f23b0f3a925f47340e3ereed@android.com } else { 993ba09de4c4be66cc07790f23b0f3a925f47340e3ereed@android.com if (fLocalBoundsCompareTypeDirtyBW) { 994ba09de4c4be66cc07790f23b0f3a925f47340e3ereed@android.com this->computeLocalClipBoundsCompareType(et); 995ba09de4c4be66cc07790f23b0f3a925f47340e3ereed@android.com fLocalBoundsCompareTypeDirtyBW = false; 996ba09de4c4be66cc07790f23b0f3a925f47340e3ereed@android.com } 997ba09de4c4be66cc07790f23b0f3a925f47340e3ereed@android.com return fLocalBoundsCompareTypeBW; 9988a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com } 9998a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com } 1000ba09de4c4be66cc07790f23b0f3a925f47340e3ereed@android.com void computeLocalClipBoundsCompareType(EdgeType et) const; 1001f2b98d67dcb6fcb3120feede9c72016fc7b3ead8reed@android.com 1002f2b98d67dcb6fcb3120feede9c72016fc7b3ead8reed@android.com SkMatrix fExternalMatrix, fExternalInverse; 1003f2b98d67dcb6fcb3120feede9c72016fc7b3ead8reed@android.com bool fUseExternalMatrix; 10045c3d1471e4908706cd053a5e2ea9ded3a6c2eaebreed@google.com 10055c3d1471e4908706cd053a5e2ea9ded3a6c2eaebreed@google.com class AutoValidateClip : ::SkNoncopyable { 10065c3d1471e4908706cd053a5e2ea9ded3a6c2eaebreed@google.com public: 10075c3d1471e4908706cd053a5e2ea9ded3a6c2eaebreed@google.com explicit AutoValidateClip(SkCanvas* canvas) : fCanvas(canvas) { 10085c3d1471e4908706cd053a5e2ea9ded3a6c2eaebreed@google.com fCanvas->validateClip(); 10095c3d1471e4908706cd053a5e2ea9ded3a6c2eaebreed@google.com } 10105c3d1471e4908706cd053a5e2ea9ded3a6c2eaebreed@google.com ~AutoValidateClip() { fCanvas->validateClip(); } 10115c3d1471e4908706cd053a5e2ea9ded3a6c2eaebreed@google.com 10125c3d1471e4908706cd053a5e2ea9ded3a6c2eaebreed@google.com private: 10135c3d1471e4908706cd053a5e2ea9ded3a6c2eaebreed@google.com const SkCanvas* fCanvas; 10145c3d1471e4908706cd053a5e2ea9ded3a6c2eaebreed@google.com }; 10155c3d1471e4908706cd053a5e2ea9ded3a6c2eaebreed@google.com 10165c3d1471e4908706cd053a5e2ea9ded3a6c2eaebreed@google.com#ifdef SK_DEBUG 10175c3d1471e4908706cd053a5e2ea9ded3a6c2eaebreed@google.com void validateClip() const; 10185c3d1471e4908706cd053a5e2ea9ded3a6c2eaebreed@google.com#else 10195c3d1471e4908706cd053a5e2ea9ded3a6c2eaebreed@google.com void validateClip() const {} 10205c3d1471e4908706cd053a5e2ea9ded3a6c2eaebreed@google.com#endif 10218a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com}; 10228a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 10238a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/** Stack helper class to automatically call restoreToCount() on the canvas 10248a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com when this object goes out of scope. Use this to guarantee that the canvas 10258a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com is restored to a known state. 10268a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com*/ 10278a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comclass SkAutoCanvasRestore : SkNoncopyable { 10288a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.compublic: 10298a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkAutoCanvasRestore(SkCanvas* canvas, bool doSave) : fCanvas(canvas) { 10308a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkASSERT(canvas); 10318a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com fSaveCount = canvas->getSaveCount(); 10328a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com if (doSave) { 10338a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com canvas->save(); 10348a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com } 10358a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com } 10368a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com ~SkAutoCanvasRestore() { 10378a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com fCanvas->restoreToCount(fSaveCount); 10388a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com } 10398a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 10408a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comprivate: 10418a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkCanvas* fCanvas; 10428a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com int fSaveCount; 10438a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com}; 10448a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 10458a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#endif 1046