Canvas.java revision da12f389eb4be0c08ca3fa9ca7663f4977858df5
1/* 2 * Copyright (C) 2006 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package android.graphics; 18 19import android.text.GraphicsOperations; 20import android.text.SpannableString; 21import android.text.SpannedString; 22import android.text.TextUtils; 23 24import javax.microedition.khronos.opengles.GL; 25 26/** 27 * The Canvas class holds the "draw" calls. To draw something, you need 28 * 4 basic components: A Bitmap to hold the pixels, a Canvas to host 29 * the draw calls (writing into the bitmap), a drawing primitive (e.g. Rect, 30 * Path, text, Bitmap), and a paint (to describe the colors and styles for the 31 * drawing). 32 * 33 * <div class="special reference"> 34 * <h3>Developer Guides</h3> 35 * <p>For more information about how to use Canvas, read the 36 * <a href="{@docRoot}guide/topics/graphics/2d-graphics.html"> 37 * Canvas and Drawables</a> developer guide.</p></div> 38 */ 39public class Canvas { 40 // assigned in constructors or setBitmap, freed in finalizer 41 int mNativeCanvas; 42 43 // may be null 44 private Bitmap mBitmap; 45 46 // optional field set by the caller 47 private DrawFilter mDrawFilter; 48 49 /** 50 * @hide 51 */ 52 protected int mDensity = Bitmap.DENSITY_NONE; 53 54 /** 55 * Used to determine when compatibility scaling is in effect. 56 * 57 * @hide 58 */ 59 protected int mScreenDensity = Bitmap.DENSITY_NONE; 60 61 // Used by native code 62 @SuppressWarnings({"UnusedDeclaration"}) 63 private int mSurfaceFormat; 64 65 /** 66 * Flag for drawTextRun indicating left-to-right run direction. 67 * @hide 68 */ 69 public static final int DIRECTION_LTR = 0; 70 71 /** 72 * Flag for drawTextRun indicating right-to-left run direction. 73 * @hide 74 */ 75 public static final int DIRECTION_RTL = 1; 76 77 // Maximum bitmap size as defined in Skia's native code 78 // (see SkCanvas.cpp, SkDraw.cpp) 79 private static final int MAXMIMUM_BITMAP_SIZE = 32766; 80 81 // This field is used to finalize the native Canvas properly 82 @SuppressWarnings({"UnusedDeclaration"}) 83 private final CanvasFinalizer mFinalizer; 84 85 private static class CanvasFinalizer { 86 private int mNativeCanvas; 87 88 public CanvasFinalizer(int nativeCanvas) { 89 mNativeCanvas = nativeCanvas; 90 } 91 92 @Override 93 protected void finalize() throws Throwable { 94 try { 95 if (mNativeCanvas != 0) { 96 finalizer(mNativeCanvas); 97 } 98 } finally { 99 super.finalize(); 100 } 101 } 102 } 103 104 /** 105 * Construct an empty raster canvas. Use setBitmap() to specify a bitmap to 106 * draw into. The initial target density is {@link Bitmap#DENSITY_NONE}; 107 * this will typically be replaced when a target bitmap is set for the 108 * canvas. 109 */ 110 public Canvas() { 111 // 0 means no native bitmap 112 mNativeCanvas = initRaster(0); 113 mFinalizer = new CanvasFinalizer(mNativeCanvas); 114 } 115 116 /** 117 * Construct a canvas with the specified bitmap to draw into. The bitmap 118 * must be mutable. 119 * 120 * <p>The initial target density of the canvas is the same as the given 121 * bitmap's density. 122 * 123 * @param bitmap Specifies a mutable bitmap for the canvas to draw into. 124 */ 125 public Canvas(Bitmap bitmap) { 126 if (!bitmap.isMutable()) { 127 throw new IllegalStateException("Immutable bitmap passed to Canvas constructor"); 128 } 129 throwIfRecycled(bitmap); 130 mNativeCanvas = initRaster(bitmap.ni()); 131 mFinalizer = new CanvasFinalizer(mNativeCanvas); 132 mBitmap = bitmap; 133 mDensity = bitmap.mDensity; 134 } 135 136 Canvas(int nativeCanvas) { 137 if (nativeCanvas == 0) { 138 throw new IllegalStateException(); 139 } 140 mNativeCanvas = nativeCanvas; 141 mFinalizer = new CanvasFinalizer(nativeCanvas); 142 mDensity = Bitmap.getDefaultDensity(); 143 } 144 145 /** 146 * Replace existing canvas while ensuring that the swap has occurred before 147 * the previous native canvas is unreferenced. 148 */ 149 private void safeCanvasSwap(int nativeCanvas) { 150 final int oldCanvas = mNativeCanvas; 151 mNativeCanvas = nativeCanvas; 152 mFinalizer.mNativeCanvas = nativeCanvas; 153 copyNativeCanvasState(oldCanvas, mNativeCanvas); 154 finalizer(oldCanvas); 155 } 156 157 /** 158 * Returns null. 159 * 160 * @deprecated This method is not supported and should not be invoked. 161 * 162 * @hide 163 */ 164 @Deprecated 165 protected GL getGL() { 166 return null; 167 } 168 169 /** 170 * Indicates whether this Canvas uses hardware acceleration. 171 * 172 * Note that this method does not define what type of hardware acceleration 173 * may or may not be used. 174 * 175 * @return True if drawing operations are hardware accelerated, 176 * false otherwise. 177 */ 178 public boolean isHardwareAccelerated() { 179 return false; 180 } 181 182 /** 183 * Specify a bitmap for the canvas to draw into. As a side-effect, the 184 * canvas' target density is updated to match that of the bitmap while all 185 * other state such as the layers, filters, matrix, and clip are reset. 186 * 187 * @param bitmap Specifies a mutable bitmap for the canvas to draw into. 188 * @see #setDensity(int) 189 * @see #getDensity() 190 */ 191 public void setBitmap(Bitmap bitmap) { 192 if (isHardwareAccelerated()) { 193 throw new RuntimeException("Can't set a bitmap device on a GL canvas"); 194 } 195 196 if (bitmap == null) { 197 safeCanvasSwap(initRaster(0)); 198 mDensity = Bitmap.DENSITY_NONE; 199 } else { 200 if (!bitmap.isMutable()) { 201 throw new IllegalStateException(); 202 } 203 throwIfRecycled(bitmap); 204 205 safeCanvasSwap(initRaster(bitmap.ni())); 206 mDensity = bitmap.mDensity; 207 } 208 209 mBitmap = bitmap; 210 } 211 212 /** 213 * Set the viewport dimensions if this canvas is GL based. If it is not, 214 * this method is ignored and no exception is thrown. 215 * 216 * @param width The width of the viewport 217 * @param height The height of the viewport 218 * 219 * @hide 220 */ 221 public void setViewport(int width, int height) { 222 } 223 224 /** 225 * Return true if the device that the current layer draws into is opaque 226 * (i.e. does not support per-pixel alpha). 227 * 228 * @return true if the device that the current layer draws into is opaque 229 */ 230 public native boolean isOpaque(); 231 232 /** 233 * Returns the width of the current drawing layer 234 * 235 * @return the width of the current drawing layer 236 */ 237 public native int getWidth(); 238 239 /** 240 * Returns the height of the current drawing layer 241 * 242 * @return the height of the current drawing layer 243 */ 244 public native int getHeight(); 245 246 /** 247 * <p>Returns the target density of the canvas. The default density is 248 * derived from the density of its backing bitmap, or 249 * {@link Bitmap#DENSITY_NONE} if there is not one.</p> 250 * 251 * @return Returns the current target density of the canvas, which is used 252 * to determine the scaling factor when drawing a bitmap into it. 253 * 254 * @see #setDensity(int) 255 * @see Bitmap#getDensity() 256 */ 257 public int getDensity() { 258 return mDensity; 259 } 260 261 /** 262 * <p>Specifies the density for this Canvas' backing bitmap. This modifies 263 * the target density of the canvas itself, as well as the density of its 264 * backing bitmap via {@link Bitmap#setDensity(int) Bitmap.setDensity(int)}. 265 * 266 * @param density The new target density of the canvas, which is used 267 * to determine the scaling factor when drawing a bitmap into it. Use 268 * {@link Bitmap#DENSITY_NONE} to disable bitmap scaling. 269 * 270 * @see #getDensity() 271 * @see Bitmap#setDensity(int) 272 */ 273 public void setDensity(int density) { 274 if (mBitmap != null) { 275 mBitmap.setDensity(density); 276 } 277 mDensity = density; 278 } 279 280 /** @hide */ 281 public void setScreenDensity(int density) { 282 mScreenDensity = density; 283 } 284 285 /** 286 * Returns the maximum allowed width for bitmaps drawn with this canvas. 287 * Attempting to draw with a bitmap wider than this value will result 288 * in an error. 289 * 290 * @see #getMaximumBitmapHeight() 291 */ 292 public int getMaximumBitmapWidth() { 293 return MAXMIMUM_BITMAP_SIZE; 294 } 295 296 /** 297 * Returns the maximum allowed height for bitmaps drawn with this canvas. 298 * Attempting to draw with a bitmap taller than this value will result 299 * in an error. 300 * 301 * @see #getMaximumBitmapWidth() 302 */ 303 public int getMaximumBitmapHeight() { 304 return MAXMIMUM_BITMAP_SIZE; 305 } 306 307 // the SAVE_FLAG constants must match their native equivalents 308 309 /** restore the current matrix when restore() is called */ 310 public static final int MATRIX_SAVE_FLAG = 0x01; 311 /** restore the current clip when restore() is called */ 312 public static final int CLIP_SAVE_FLAG = 0x02; 313 /** the layer needs to per-pixel alpha */ 314 public static final int HAS_ALPHA_LAYER_SAVE_FLAG = 0x04; 315 /** the layer needs to 8-bits per color component */ 316 public static final int FULL_COLOR_LAYER_SAVE_FLAG = 0x08; 317 /** clip against the layer's bounds */ 318 public static final int CLIP_TO_LAYER_SAVE_FLAG = 0x10; 319 /** restore everything when restore() is called */ 320 public static final int ALL_SAVE_FLAG = 0x1F; 321 322 /** 323 * Saves the current matrix and clip onto a private stack. Subsequent 324 * calls to translate,scale,rotate,skew,concat or clipRect,clipPath 325 * will all operate as usual, but when the balancing call to restore() 326 * is made, those calls will be forgotten, and the settings that existed 327 * before the save() will be reinstated. 328 * 329 * @return The value to pass to restoreToCount() to balance this save() 330 */ 331 public native int save(); 332 333 /** 334 * Based on saveFlags, can save the current matrix and clip onto a private 335 * stack. Subsequent calls to translate,scale,rotate,skew,concat or 336 * clipRect,clipPath will all operate as usual, but when the balancing 337 * call to restore() is made, those calls will be forgotten, and the 338 * settings that existed before the save() will be reinstated. 339 * 340 * @param saveFlags flag bits that specify which parts of the Canvas state 341 * to save/restore 342 * @return The value to pass to restoreToCount() to balance this save() 343 */ 344 public native int save(int saveFlags); 345 346 /** 347 * This behaves the same as save(), but in addition it allocates an 348 * offscreen bitmap. All drawing calls are directed there, and only when 349 * the balancing call to restore() is made is that offscreen transfered to 350 * the canvas (or the previous layer). Subsequent calls to translate, 351 * scale, rotate, skew, concat or clipRect, clipPath all operate on this 352 * copy. When the balancing call to restore() is made, this copy is 353 * deleted and the previous matrix/clip state is restored. 354 * 355 * @param bounds May be null. The maximum size the offscreen bitmap 356 * needs to be (in local coordinates) 357 * @param paint This is copied, and is applied to the offscreen when 358 * restore() is called. 359 * @param saveFlags see _SAVE_FLAG constants 360 * @return value to pass to restoreToCount() to balance this save() 361 */ 362 public int saveLayer(RectF bounds, Paint paint, int saveFlags) { 363 return native_saveLayer(mNativeCanvas, bounds, 364 paint != null ? paint.mNativePaint : 0, 365 saveFlags); 366 } 367 368 /** 369 * Helper version of saveLayer() that takes 4 values rather than a RectF. 370 */ 371 public int saveLayer(float left, float top, float right, float bottom, Paint paint, 372 int saveFlags) { 373 return native_saveLayer(mNativeCanvas, left, top, right, bottom, 374 paint != null ? paint.mNativePaint : 0, 375 saveFlags); 376 } 377 378 /** 379 * This behaves the same as save(), but in addition it allocates an 380 * offscreen bitmap. All drawing calls are directed there, and only when 381 * the balancing call to restore() is made is that offscreen transfered to 382 * the canvas (or the previous layer). Subsequent calls to translate, 383 * scale, rotate, skew, concat or clipRect, clipPath all operate on this 384 * copy. When the balancing call to restore() is made, this copy is 385 * deleted and the previous matrix/clip state is restored. 386 * 387 * @param bounds The maximum size the offscreen bitmap needs to be 388 * (in local coordinates) 389 * @param alpha The alpha to apply to the offscreen when when it is 390 drawn during restore() 391 * @param saveFlags see _SAVE_FLAG constants 392 * @return value to pass to restoreToCount() to balance this call 393 */ 394 public int saveLayerAlpha(RectF bounds, int alpha, int saveFlags) { 395 alpha = Math.min(255, Math.max(0, alpha)); 396 return native_saveLayerAlpha(mNativeCanvas, bounds, alpha, saveFlags); 397 } 398 399 /** 400 * Helper for saveLayerAlpha() that takes 4 values instead of a RectF. 401 */ 402 public int saveLayerAlpha(float left, float top, float right, float bottom, int alpha, 403 int saveFlags) { 404 return native_saveLayerAlpha(mNativeCanvas, left, top, right, bottom, 405 alpha, saveFlags); 406 } 407 408 /** 409 * This call balances a previous call to save(), and is used to remove all 410 * modifications to the matrix/clip state since the last save call. It is 411 * an error to call restore() more times than save() was called. 412 */ 413 public native void restore(); 414 415 /** 416 * Returns the number of matrix/clip states on the Canvas' private stack. 417 * This will equal # save() calls - # restore() calls. 418 */ 419 public native int getSaveCount(); 420 421 /** 422 * Efficient way to pop any calls to save() that happened after the save 423 * count reached saveCount. It is an error for saveCount to be less than 1. 424 * 425 * Example: 426 * int count = canvas.save(); 427 * ... // more calls potentially to save() 428 * canvas.restoreToCount(count); 429 * // now the canvas is back in the same state it was before the initial 430 * // call to save(). 431 * 432 * @param saveCount The save level to restore to. 433 */ 434 public native void restoreToCount(int saveCount); 435 436 /** 437 * Preconcat the current matrix with the specified translation 438 * 439 * @param dx The distance to translate in X 440 * @param dy The distance to translate in Y 441 */ 442 public native void translate(float dx, float dy); 443 444 /** 445 * Preconcat the current matrix with the specified scale. 446 * 447 * @param sx The amount to scale in X 448 * @param sy The amount to scale in Y 449 */ 450 public native void scale(float sx, float sy); 451 452 /** 453 * Preconcat the current matrix with the specified scale. 454 * 455 * @param sx The amount to scale in X 456 * @param sy The amount to scale in Y 457 * @param px The x-coord for the pivot point (unchanged by the scale) 458 * @param py The y-coord for the pivot point (unchanged by the scale) 459 */ 460 public final void scale(float sx, float sy, float px, float py) { 461 translate(px, py); 462 scale(sx, sy); 463 translate(-px, -py); 464 } 465 466 /** 467 * Preconcat the current matrix with the specified rotation. 468 * 469 * @param degrees The amount to rotate, in degrees 470 */ 471 public native void rotate(float degrees); 472 473 /** 474 * Preconcat the current matrix with the specified rotation. 475 * 476 * @param degrees The amount to rotate, in degrees 477 * @param px The x-coord for the pivot point (unchanged by the rotation) 478 * @param py The y-coord for the pivot point (unchanged by the rotation) 479 */ 480 public final void rotate(float degrees, float px, float py) { 481 translate(px, py); 482 rotate(degrees); 483 translate(-px, -py); 484 } 485 486 /** 487 * Preconcat the current matrix with the specified skew. 488 * 489 * @param sx The amount to skew in X 490 * @param sy The amount to skew in Y 491 */ 492 public native void skew(float sx, float sy); 493 494 /** 495 * Preconcat the current matrix with the specified matrix. 496 * 497 * @param matrix The matrix to preconcatenate with the current matrix 498 */ 499 public void concat(Matrix matrix) { 500 native_concat(mNativeCanvas, matrix.native_instance); 501 } 502 503 /** 504 * Completely replace the current matrix with the specified matrix. If the 505 * matrix parameter is null, then the current matrix is reset to identity. 506 * 507 * <strong>Note:</strong> it is recommended to use {@link #concat(Matrix)}, 508 * {@link #scale(float, float)}, {@link #translate(float, float)} and 509 * {@link #rotate(float)} instead of this method. 510 * 511 * @param matrix The matrix to replace the current matrix with. If it is 512 * null, set the current matrix to identity. 513 * 514 * @see #concat(Matrix) 515 */ 516 public void setMatrix(Matrix matrix) { 517 native_setMatrix(mNativeCanvas, 518 matrix == null ? 0 : matrix.native_instance); 519 } 520 521 /** 522 * Return, in ctm, the current transformation matrix. This does not alter 523 * the matrix in the canvas, but just returns a copy of it. 524 */ 525 @Deprecated 526 public void getMatrix(Matrix ctm) { 527 native_getCTM(mNativeCanvas, ctm.native_instance); 528 } 529 530 /** 531 * Return a new matrix with a copy of the canvas' current transformation 532 * matrix. 533 */ 534 @Deprecated 535 public final Matrix getMatrix() { 536 Matrix m = new Matrix(); 537 //noinspection deprecation 538 getMatrix(m); 539 return m; 540 } 541 542 /** 543 * Modify the current clip with the specified rectangle. 544 * 545 * @param rect The rect to intersect with the current clip 546 * @param op How the clip is modified 547 * @return true if the resulting clip is non-empty 548 */ 549 public boolean clipRect(RectF rect, Region.Op op) { 550 return native_clipRect(mNativeCanvas, rect.left, rect.top, rect.right, rect.bottom, 551 op.nativeInt); 552 } 553 554 /** 555 * Modify the current clip with the specified rectangle, which is 556 * expressed in local coordinates. 557 * 558 * @param rect The rectangle to intersect with the current clip. 559 * @param op How the clip is modified 560 * @return true if the resulting clip is non-empty 561 */ 562 public boolean clipRect(Rect rect, Region.Op op) { 563 return native_clipRect(mNativeCanvas, rect.left, rect.top, rect.right, rect.bottom, 564 op.nativeInt); 565 } 566 567 /** 568 * Intersect the current clip with the specified rectangle, which is 569 * expressed in local coordinates. 570 * 571 * @param rect The rectangle to intersect with the current clip. 572 * @return true if the resulting clip is non-empty 573 */ 574 public native boolean clipRect(RectF rect); 575 576 /** 577 * Intersect the current clip with the specified rectangle, which is 578 * expressed in local coordinates. 579 * 580 * @param rect The rectangle to intersect with the current clip. 581 * @return true if the resulting clip is non-empty 582 */ 583 public native boolean clipRect(Rect rect); 584 585 /** 586 * Modify the current clip with the specified rectangle, which is 587 * expressed in local coordinates. 588 * 589 * @param left The left side of the rectangle to intersect with the 590 * current clip 591 * @param top The top of the rectangle to intersect with the current 592 * clip 593 * @param right The right side of the rectangle to intersect with the 594 * current clip 595 * @param bottom The bottom of the rectangle to intersect with the current 596 * clip 597 * @param op How the clip is modified 598 * @return true if the resulting clip is non-empty 599 */ 600 public boolean clipRect(float left, float top, float right, float bottom, Region.Op op) { 601 return native_clipRect(mNativeCanvas, left, top, right, bottom, op.nativeInt); 602 } 603 604 /** 605 * Intersect the current clip with the specified rectangle, which is 606 * expressed in local coordinates. 607 * 608 * @param left The left side of the rectangle to intersect with the 609 * current clip 610 * @param top The top of the rectangle to intersect with the current clip 611 * @param right The right side of the rectangle to intersect with the 612 * current clip 613 * @param bottom The bottom of the rectangle to intersect with the current 614 * clip 615 * @return true if the resulting clip is non-empty 616 */ 617 public native boolean clipRect(float left, float top, float right, float bottom); 618 619 /** 620 * Intersect the current clip with the specified rectangle, which is 621 * expressed in local coordinates. 622 * 623 * @param left The left side of the rectangle to intersect with the 624 * current clip 625 * @param top The top of the rectangle to intersect with the current clip 626 * @param right The right side of the rectangle to intersect with the 627 * current clip 628 * @param bottom The bottom of the rectangle to intersect with the current 629 * clip 630 * @return true if the resulting clip is non-empty 631 */ 632 public native boolean clipRect(int left, int top, int right, int bottom); 633 634 /** 635 * Modify the current clip with the specified path. 636 * 637 * @param path The path to operate on the current clip 638 * @param op How the clip is modified 639 * @return true if the resulting is non-empty 640 */ 641 public boolean clipPath(Path path, Region.Op op) { 642 return native_clipPath(mNativeCanvas, path.ni(), op.nativeInt); 643 } 644 645 /** 646 * Intersect the current clip with the specified path. 647 * 648 * @param path The path to intersect with the current clip 649 * @return true if the resulting is non-empty 650 */ 651 public boolean clipPath(Path path) { 652 return clipPath(path, Region.Op.INTERSECT); 653 } 654 655 /** 656 * Modify the current clip with the specified region. Note that unlike 657 * clipRect() and clipPath() which transform their arguments by the 658 * current matrix, clipRegion() assumes its argument is already in the 659 * coordinate system of the current layer's bitmap, and so not 660 * transformation is performed. 661 * 662 * @param region The region to operate on the current clip, based on op 663 * @param op How the clip is modified 664 * @return true if the resulting is non-empty 665 */ 666 public boolean clipRegion(Region region, Region.Op op) { 667 return native_clipRegion(mNativeCanvas, region.ni(), op.nativeInt); 668 } 669 670 /** 671 * Intersect the current clip with the specified region. Note that unlike 672 * clipRect() and clipPath() which transform their arguments by the 673 * current matrix, clipRegion() assumes its argument is already in the 674 * coordinate system of the current layer's bitmap, and so not 675 * transformation is performed. 676 * 677 * @param region The region to operate on the current clip, based on op 678 * @return true if the resulting is non-empty 679 */ 680 public boolean clipRegion(Region region) { 681 return clipRegion(region, Region.Op.INTERSECT); 682 } 683 684 public DrawFilter getDrawFilter() { 685 return mDrawFilter; 686 } 687 688 public void setDrawFilter(DrawFilter filter) { 689 int nativeFilter = 0; 690 if (filter != null) { 691 nativeFilter = filter.mNativeInt; 692 } 693 mDrawFilter = filter; 694 nativeSetDrawFilter(mNativeCanvas, nativeFilter); 695 } 696 697 public enum EdgeType { 698 BW(0), //!< treat edges by just rounding to nearest pixel boundary 699 AA(1); //!< treat edges by rounding-out, since they may be antialiased 700 701 EdgeType(int nativeInt) { 702 this.nativeInt = nativeInt; 703 } 704 705 /** 706 * @hide 707 */ 708 public final int nativeInt; 709 } 710 711 /** 712 * Return true if the specified rectangle, after being transformed by the 713 * current matrix, would lie completely outside of the current clip. Call 714 * this to check if an area you intend to draw into is clipped out (and 715 * therefore you can skip making the draw calls). 716 * 717 * @param rect the rect to compare with the current clip 718 * @param type specifies how to treat the edges (BW or antialiased) 719 * @return true if the rect (transformed by the canvas' matrix) 720 * does not intersect with the canvas' clip 721 */ 722 public boolean quickReject(RectF rect, EdgeType type) { 723 return native_quickReject(mNativeCanvas, rect); 724 } 725 726 /** 727 * Return true if the specified path, after being transformed by the 728 * current matrix, would lie completely outside of the current clip. Call 729 * this to check if an area you intend to draw into is clipped out (and 730 * therefore you can skip making the draw calls). Note: for speed it may 731 * return false even if the path itself might not intersect the clip 732 * (i.e. the bounds of the path intersects, but the path does not). 733 * 734 * @param path The path to compare with the current clip 735 * @param type true if the path should be considered antialiased, 736 * since that means it may 737 * affect a larger area (more pixels) than 738 * non-antialiased. 739 * @return true if the path (transformed by the canvas' matrix) 740 * does not intersect with the canvas' clip 741 */ 742 public boolean quickReject(Path path, EdgeType type) { 743 return native_quickReject(mNativeCanvas, path.ni()); 744 } 745 746 /** 747 * Return true if the specified rectangle, after being transformed by the 748 * current matrix, would lie completely outside of the current clip. Call 749 * this to check if an area you intend to draw into is clipped out (and 750 * therefore you can skip making the draw calls). 751 * 752 * @param left The left side of the rectangle to compare with the 753 * current clip 754 * @param top The top of the rectangle to compare with the current 755 * clip 756 * @param right The right side of the rectangle to compare with the 757 * current clip 758 * @param bottom The bottom of the rectangle to compare with the 759 * current clip 760 * @param type true if the rect should be considered antialiased, 761 * since that means it may affect a larger area (more 762 * pixels) than non-antialiased. 763 * @return true if the rect (transformed by the canvas' matrix) 764 * does not intersect with the canvas' clip 765 */ 766 public boolean quickReject(float left, float top, float right, float bottom, 767 EdgeType type) { 768 return native_quickReject(mNativeCanvas, left, top, right, bottom); 769 } 770 771 /** 772 * Retrieve the clip bounds, returning true if they are non-empty. 773 * 774 * @param bounds Return the clip bounds here. If it is null, ignore it but 775 * still return true if the current clip is non-empty. 776 * @return true if the current clip is non-empty. 777 */ 778 public boolean getClipBounds(Rect bounds) { 779 return native_getClipBounds(mNativeCanvas, bounds); 780 } 781 782 /** 783 * Retrieve the clip bounds. 784 * 785 * @return the clip bounds, or [0, 0, 0, 0] if the clip is empty. 786 */ 787 public final Rect getClipBounds() { 788 Rect r = new Rect(); 789 getClipBounds(r); 790 return r; 791 } 792 793 /** 794 * Fill the entire canvas' bitmap (restricted to the current clip) with the 795 * specified RGB color, using srcover porterduff mode. 796 * 797 * @param r red component (0..255) of the color to draw onto the canvas 798 * @param g green component (0..255) of the color to draw onto the canvas 799 * @param b blue component (0..255) of the color to draw onto the canvas 800 */ 801 public void drawRGB(int r, int g, int b) { 802 native_drawRGB(mNativeCanvas, r, g, b); 803 } 804 805 /** 806 * Fill the entire canvas' bitmap (restricted to the current clip) with the 807 * specified ARGB color, using srcover porterduff mode. 808 * 809 * @param a alpha component (0..255) of the color to draw onto the canvas 810 * @param r red component (0..255) of the color to draw onto the canvas 811 * @param g green component (0..255) of the color to draw onto the canvas 812 * @param b blue component (0..255) of the color to draw onto the canvas 813 */ 814 public void drawARGB(int a, int r, int g, int b) { 815 native_drawARGB(mNativeCanvas, a, r, g, b); 816 } 817 818 /** 819 * Fill the entire canvas' bitmap (restricted to the current clip) with the 820 * specified color, using srcover porterduff mode. 821 * 822 * @param color the color to draw onto the canvas 823 */ 824 public void drawColor(int color) { 825 native_drawColor(mNativeCanvas, color); 826 } 827 828 /** 829 * Fill the entire canvas' bitmap (restricted to the current clip) with the 830 * specified color and porter-duff xfermode. 831 * 832 * @param color the color to draw with 833 * @param mode the porter-duff mode to apply to the color 834 */ 835 public void drawColor(int color, PorterDuff.Mode mode) { 836 native_drawColor(mNativeCanvas, color, mode.nativeInt); 837 } 838 839 /** 840 * Fill the entire canvas' bitmap (restricted to the current clip) with 841 * the specified paint. This is equivalent (but faster) to drawing an 842 * infinitely large rectangle with the specified paint. 843 * 844 * @param paint The paint used to draw onto the canvas 845 */ 846 public void drawPaint(Paint paint) { 847 native_drawPaint(mNativeCanvas, paint.mNativePaint); 848 } 849 850 /** 851 * Draw a series of points. Each point is centered at the coordinate 852 * specified by pts[], and its diameter is specified by the paint's stroke 853 * width (as transformed by the canvas' CTM), with special treatment for 854 * a stroke width of 0, which always draws exactly 1 pixel (or at most 4 855 * if antialiasing is enabled). The shape of the point is controlled by 856 * the paint's Cap type. The shape is a square, unless the cap type is 857 * Round, in which case the shape is a circle. 858 * 859 * @param pts Array of points to draw [x0 y0 x1 y1 x2 y2 ...] 860 * @param offset Number of values to skip before starting to draw. 861 * @param count The number of values to process, after skipping offset 862 * of them. Since one point uses two values, the number of 863 * "points" that are drawn is really (count >> 1). 864 * @param paint The paint used to draw the points 865 */ 866 public native void drawPoints(float[] pts, int offset, int count, Paint paint); 867 868 /** 869 * Helper for drawPoints() that assumes you want to draw the entire array 870 */ 871 public void drawPoints(float[] pts, Paint paint) { 872 drawPoints(pts, 0, pts.length, paint); 873 } 874 875 /** 876 * Helper for drawPoints() for drawing a single point. 877 */ 878 public native void drawPoint(float x, float y, Paint paint); 879 880 /** 881 * Draw a line segment with the specified start and stop x,y coordinates, 882 * using the specified paint. 883 * 884 * <p>Note that since a line is always "framed", the Style is ignored in the paint.</p> 885 * 886 * <p>Degenerate lines (length is 0) will not be drawn.</p> 887 * 888 * @param startX The x-coordinate of the start point of the line 889 * @param startY The y-coordinate of the start point of the line 890 * @param paint The paint used to draw the line 891 */ 892 public void drawLine(float startX, float startY, float stopX, float stopY, Paint paint) { 893 native_drawLine(mNativeCanvas, startX, startY, stopX, stopY, paint.mNativePaint); 894 } 895 896 /** 897 * Draw a series of lines. Each line is taken from 4 consecutive values 898 * in the pts array. Thus to draw 1 line, the array must contain at least 4 899 * values. This is logically the same as drawing the array as follows: 900 * drawLine(pts[0], pts[1], pts[2], pts[3]) followed by 901 * drawLine(pts[4], pts[5], pts[6], pts[7]) and so on. 902 * 903 * @param pts Array of points to draw [x0 y0 x1 y1 x2 y2 ...] 904 * @param offset Number of values in the array to skip before drawing. 905 * @param count The number of values in the array to process, after 906 * skipping "offset" of them. Since each line uses 4 values, 907 * the number of "lines" that are drawn is really 908 * (count >> 2). 909 * @param paint The paint used to draw the points 910 */ 911 public native void drawLines(float[] pts, int offset, int count, Paint paint); 912 913 public void drawLines(float[] pts, Paint paint) { 914 drawLines(pts, 0, pts.length, paint); 915 } 916 917 /** 918 * Draw the specified Rect using the specified paint. The rectangle will 919 * be filled or framed based on the Style in the paint. 920 * 921 * @param rect The rect to be drawn 922 * @param paint The paint used to draw the rect 923 */ 924 public void drawRect(RectF rect, Paint paint) { 925 native_drawRect(mNativeCanvas, rect, paint.mNativePaint); 926 } 927 928 /** 929 * Draw the specified Rect using the specified Paint. The rectangle 930 * will be filled or framed based on the Style in the paint. 931 * 932 * @param r The rectangle to be drawn. 933 * @param paint The paint used to draw the rectangle 934 */ 935 public void drawRect(Rect r, Paint paint) { 936 drawRect(r.left, r.top, r.right, r.bottom, paint); 937 } 938 939 940 /** 941 * Draw the specified Rect using the specified paint. The rectangle will 942 * be filled or framed based on the Style in the paint. 943 * 944 * @param left The left side of the rectangle to be drawn 945 * @param top The top side of the rectangle to be drawn 946 * @param right The right side of the rectangle to be drawn 947 * @param bottom The bottom side of the rectangle to be drawn 948 * @param paint The paint used to draw the rect 949 */ 950 public void drawRect(float left, float top, float right, float bottom, Paint paint) { 951 native_drawRect(mNativeCanvas, left, top, right, bottom, paint.mNativePaint); 952 } 953 954 /** 955 * Draw the specified oval using the specified paint. The oval will be 956 * filled or framed based on the Style in the paint. 957 * 958 * @param oval The rectangle bounds of the oval to be drawn 959 */ 960 public void drawOval(RectF oval, Paint paint) { 961 if (oval == null) { 962 throw new NullPointerException(); 963 } 964 native_drawOval(mNativeCanvas, oval, paint.mNativePaint); 965 } 966 967 /** 968 * Draw the specified circle using the specified paint. If radius is <= 0, 969 * then nothing will be drawn. The circle will be filled or framed based 970 * on the Style in the paint. 971 * 972 * @param cx The x-coordinate of the center of the cirle to be drawn 973 * @param cy The y-coordinate of the center of the cirle to be drawn 974 * @param radius The radius of the cirle to be drawn 975 * @param paint The paint used to draw the circle 976 */ 977 public void drawCircle(float cx, float cy, float radius, Paint paint) { 978 native_drawCircle(mNativeCanvas, cx, cy, radius, paint.mNativePaint); 979 } 980 981 /** 982 * <p>Draw the specified arc, which will be scaled to fit inside the 983 * specified oval.</p> 984 * 985 * <p>If the start angle is negative or >= 360, the start angle is treated 986 * as start angle modulo 360.</p> 987 * 988 * <p>If the sweep angle is >= 360, then the oval is drawn 989 * completely. Note that this differs slightly from SkPath::arcTo, which 990 * treats the sweep angle modulo 360. If the sweep angle is negative, 991 * the sweep angle is treated as sweep angle modulo 360</p> 992 * 993 * <p>The arc is drawn clockwise. An angle of 0 degrees correspond to the 994 * geometric angle of 0 degrees (3 o'clock on a watch.)</p> 995 * 996 * @param oval The bounds of oval used to define the shape and size 997 * of the arc 998 * @param startAngle Starting angle (in degrees) where the arc begins 999 * @param sweepAngle Sweep angle (in degrees) measured clockwise 1000 * @param useCenter If true, include the center of the oval in the arc, and 1001 close it if it is being stroked. This will draw a wedge 1002 * @param paint The paint used to draw the arc 1003 */ 1004 public void drawArc(RectF oval, float startAngle, float sweepAngle, boolean useCenter, 1005 Paint paint) { 1006 if (oval == null) { 1007 throw new NullPointerException(); 1008 } 1009 native_drawArc(mNativeCanvas, oval, startAngle, sweepAngle, 1010 useCenter, paint.mNativePaint); 1011 } 1012 1013 /** 1014 * Draw the specified round-rect using the specified paint. The roundrect 1015 * will be filled or framed based on the Style in the paint. 1016 * 1017 * @param rect The rectangular bounds of the roundRect to be drawn 1018 * @param rx The x-radius of the oval used to round the corners 1019 * @param ry The y-radius of the oval used to round the corners 1020 * @param paint The paint used to draw the roundRect 1021 */ 1022 public void drawRoundRect(RectF rect, float rx, float ry, Paint paint) { 1023 if (rect == null) { 1024 throw new NullPointerException(); 1025 } 1026 native_drawRoundRect(mNativeCanvas, rect, rx, ry, 1027 paint.mNativePaint); 1028 } 1029 1030 /** 1031 * Draw the specified path using the specified paint. The path will be 1032 * filled or framed based on the Style in the paint. 1033 * 1034 * @param path The path to be drawn 1035 * @param paint The paint used to draw the path 1036 */ 1037 public void drawPath(Path path, Paint paint) { 1038 native_drawPath(mNativeCanvas, path.ni(), paint.mNativePaint); 1039 } 1040 1041 private static void throwIfRecycled(Bitmap bitmap) { 1042 if (bitmap.isRecycled()) { 1043 throw new RuntimeException("Canvas: trying to use a recycled bitmap " + bitmap); 1044 } 1045 } 1046 1047 /** 1048 * Draws the specified bitmap as an N-patch (most often, a 9-patches.) 1049 * 1050 * Note: Only supported by hardware accelerated canvas at the moment. 1051 * 1052 * @param bitmap The bitmap to draw as an N-patch 1053 * @param chunks The patches information (matches the native struct Res_png_9patch) 1054 * @param dst The destination rectangle. 1055 * @param paint The paint to draw the bitmap with. may be null 1056 * 1057 * @hide 1058 */ 1059 public void drawPatch(Bitmap bitmap, byte[] chunks, RectF dst, Paint paint) { 1060 } 1061 1062 /** 1063 * Draw the specified bitmap, with its top/left corner at (x,y), using 1064 * the specified paint, transformed by the current matrix. 1065 * 1066 * <p>Note: if the paint contains a maskfilter that generates a mask which 1067 * extends beyond the bitmap's original width/height (e.g. BlurMaskFilter), 1068 * then the bitmap will be drawn as if it were in a Shader with CLAMP mode. 1069 * Thus the color outside of the original width/height will be the edge 1070 * color replicated. 1071 * 1072 * <p>If the bitmap and canvas have different densities, this function 1073 * will take care of automatically scaling the bitmap to draw at the 1074 * same density as the canvas. 1075 * 1076 * @param bitmap The bitmap to be drawn 1077 * @param left The position of the left side of the bitmap being drawn 1078 * @param top The position of the top side of the bitmap being drawn 1079 * @param paint The paint used to draw the bitmap (may be null) 1080 */ 1081 public void drawBitmap(Bitmap bitmap, float left, float top, Paint paint) { 1082 throwIfRecycled(bitmap); 1083 native_drawBitmap(mNativeCanvas, bitmap.ni(), left, top, 1084 paint != null ? paint.mNativePaint : 0, mDensity, mScreenDensity, bitmap.mDensity); 1085 } 1086 1087 /** 1088 * Draw the specified bitmap, scaling/translating automatically to fill 1089 * the destination rectangle. If the source rectangle is not null, it 1090 * specifies the subset of the bitmap to draw. 1091 * 1092 * <p>Note: if the paint contains a maskfilter that generates a mask which 1093 * extends beyond the bitmap's original width/height (e.g. BlurMaskFilter), 1094 * then the bitmap will be drawn as if it were in a Shader with CLAMP mode. 1095 * Thus the color outside of the original width/height will be the edge 1096 * color replicated. 1097 * 1098 * <p>This function <em>ignores the density associated with the bitmap</em>. 1099 * This is because the source and destination rectangle coordinate 1100 * spaces are in their respective densities, so must already have the 1101 * appropriate scaling factor applied. 1102 * 1103 * @param bitmap The bitmap to be drawn 1104 * @param src May be null. The subset of the bitmap to be drawn 1105 * @param dst The rectangle that the bitmap will be scaled/translated 1106 * to fit into 1107 * @param paint May be null. The paint used to draw the bitmap 1108 */ 1109 public void drawBitmap(Bitmap bitmap, Rect src, RectF dst, Paint paint) { 1110 if (dst == null) { 1111 throw new NullPointerException(); 1112 } 1113 throwIfRecycled(bitmap); 1114 native_drawBitmap(mNativeCanvas, bitmap.ni(), src, dst, 1115 paint != null ? paint.mNativePaint : 0, mScreenDensity, bitmap.mDensity); 1116 } 1117 1118 /** 1119 * Draw the specified bitmap, scaling/translating automatically to fill 1120 * the destination rectangle. If the source rectangle is not null, it 1121 * specifies the subset of the bitmap to draw. 1122 * 1123 * <p>Note: if the paint contains a maskfilter that generates a mask which 1124 * extends beyond the bitmap's original width/height (e.g. BlurMaskFilter), 1125 * then the bitmap will be drawn as if it were in a Shader with CLAMP mode. 1126 * Thus the color outside of the original width/height will be the edge 1127 * color replicated. 1128 * 1129 * <p>This function <em>ignores the density associated with the bitmap</em>. 1130 * This is because the source and destination rectangle coordinate 1131 * spaces are in their respective densities, so must already have the 1132 * appropriate scaling factor applied. 1133 * 1134 * @param bitmap The bitmap to be drawn 1135 * @param src May be null. The subset of the bitmap to be drawn 1136 * @param dst The rectangle that the bitmap will be scaled/translated 1137 * to fit into 1138 * @param paint May be null. The paint used to draw the bitmap 1139 */ 1140 public void drawBitmap(Bitmap bitmap, Rect src, Rect dst, Paint paint) { 1141 if (dst == null) { 1142 throw new NullPointerException(); 1143 } 1144 throwIfRecycled(bitmap); 1145 native_drawBitmap(mNativeCanvas, bitmap.ni(), src, dst, 1146 paint != null ? paint.mNativePaint : 0, mScreenDensity, bitmap.mDensity); 1147 } 1148 1149 /** 1150 * Treat the specified array of colors as a bitmap, and draw it. This gives 1151 * the same result as first creating a bitmap from the array, and then 1152 * drawing it, but this method avoids explicitly creating a bitmap object 1153 * which can be more efficient if the colors are changing often. 1154 * 1155 * @param colors Array of colors representing the pixels of the bitmap 1156 * @param offset Offset into the array of colors for the first pixel 1157 * @param stride The number of colors in the array between rows (must be 1158 * >= width or <= -width). 1159 * @param x The X coordinate for where to draw the bitmap 1160 * @param y The Y coordinate for where to draw the bitmap 1161 * @param width The width of the bitmap 1162 * @param height The height of the bitmap 1163 * @param hasAlpha True if the alpha channel of the colors contains valid 1164 * values. If false, the alpha byte is ignored (assumed to 1165 * be 0xFF for every pixel). 1166 * @param paint May be null. The paint used to draw the bitmap 1167 */ 1168 public void drawBitmap(int[] colors, int offset, int stride, float x, float y, 1169 int width, int height, boolean hasAlpha, Paint paint) { 1170 // check for valid input 1171 if (width < 0) { 1172 throw new IllegalArgumentException("width must be >= 0"); 1173 } 1174 if (height < 0) { 1175 throw new IllegalArgumentException("height must be >= 0"); 1176 } 1177 if (Math.abs(stride) < width) { 1178 throw new IllegalArgumentException("abs(stride) must be >= width"); 1179 } 1180 int lastScanline = offset + (height - 1) * stride; 1181 int length = colors.length; 1182 if (offset < 0 || (offset + width > length) || lastScanline < 0 1183 || (lastScanline + width > length)) { 1184 throw new ArrayIndexOutOfBoundsException(); 1185 } 1186 // quick escape if there's nothing to draw 1187 if (width == 0 || height == 0) { 1188 return; 1189 } 1190 // punch down to native for the actual draw 1191 native_drawBitmap(mNativeCanvas, colors, offset, stride, x, y, width, height, hasAlpha, 1192 paint != null ? paint.mNativePaint : 0); 1193 } 1194 1195 /** Legacy version of drawBitmap(int[] colors, ...) that took ints for x,y 1196 */ 1197 public void drawBitmap(int[] colors, int offset, int stride, int x, int y, 1198 int width, int height, boolean hasAlpha, Paint paint) { 1199 // call through to the common float version 1200 drawBitmap(colors, offset, stride, (float)x, (float)y, width, height, 1201 hasAlpha, paint); 1202 } 1203 1204 /** 1205 * Draw the bitmap using the specified matrix. 1206 * 1207 * @param bitmap The bitmap to draw 1208 * @param matrix The matrix used to transform the bitmap when it is drawn 1209 * @param paint May be null. The paint used to draw the bitmap 1210 */ 1211 public void drawBitmap(Bitmap bitmap, Matrix matrix, Paint paint) { 1212 nativeDrawBitmapMatrix(mNativeCanvas, bitmap.ni(), matrix.ni(), 1213 paint != null ? paint.mNativePaint : 0); 1214 } 1215 1216 /** 1217 * @hide 1218 */ 1219 protected static void checkRange(int length, int offset, int count) { 1220 if ((offset | count) < 0 || offset + count > length) { 1221 throw new ArrayIndexOutOfBoundsException(); 1222 } 1223 } 1224 1225 /** 1226 * Draw the bitmap through the mesh, where mesh vertices are evenly 1227 * distributed across the bitmap. There are meshWidth+1 vertices across, and 1228 * meshHeight+1 vertices down. The verts array is accessed in row-major 1229 * order, so that the first meshWidth+1 vertices are distributed across the 1230 * top of the bitmap from left to right. A more general version of this 1231 * method is drawVertices(). 1232 * 1233 * @param bitmap The bitmap to draw using the mesh 1234 * @param meshWidth The number of columns in the mesh. Nothing is drawn if 1235 * this is 0 1236 * @param meshHeight The number of rows in the mesh. Nothing is drawn if 1237 * this is 0 1238 * @param verts Array of x,y pairs, specifying where the mesh should be 1239 * drawn. There must be at least 1240 * (meshWidth+1) * (meshHeight+1) * 2 + vertOffset values 1241 * in the array 1242 * @param vertOffset Number of verts elements to skip before drawing 1243 * @param colors May be null. Specifies a color at each vertex, which is 1244 * interpolated across the cell, and whose values are 1245 * multiplied by the corresponding bitmap colors. If not null, 1246 * there must be at least (meshWidth+1) * (meshHeight+1) + 1247 * colorOffset values in the array. 1248 * @param colorOffset Number of color elements to skip before drawing 1249 * @param paint May be null. The paint used to draw the bitmap 1250 */ 1251 public void drawBitmapMesh(Bitmap bitmap, int meshWidth, int meshHeight, 1252 float[] verts, int vertOffset, int[] colors, int colorOffset, Paint paint) { 1253 if ((meshWidth | meshHeight | vertOffset | colorOffset) < 0) { 1254 throw new ArrayIndexOutOfBoundsException(); 1255 } 1256 if (meshWidth == 0 || meshHeight == 0) { 1257 return; 1258 } 1259 int count = (meshWidth + 1) * (meshHeight + 1); 1260 // we mul by 2 since we need two floats per vertex 1261 checkRange(verts.length, vertOffset, count * 2); 1262 if (colors != null) { 1263 // no mul by 2, since we need only 1 color per vertex 1264 checkRange(colors.length, colorOffset, count); 1265 } 1266 nativeDrawBitmapMesh(mNativeCanvas, bitmap.ni(), meshWidth, meshHeight, 1267 verts, vertOffset, colors, colorOffset, 1268 paint != null ? paint.mNativePaint : 0); 1269 } 1270 1271 public enum VertexMode { 1272 TRIANGLES(0), 1273 TRIANGLE_STRIP(1), 1274 TRIANGLE_FAN(2); 1275 1276 VertexMode(int nativeInt) { 1277 this.nativeInt = nativeInt; 1278 } 1279 1280 /** 1281 * @hide 1282 */ 1283 public final int nativeInt; 1284 } 1285 1286 /** 1287 * Draw the array of vertices, interpreted as triangles (based on mode). The 1288 * verts array is required, and specifies the x,y pairs for each vertex. If 1289 * texs is non-null, then it is used to specify the coordinate in shader 1290 * coordinates to use at each vertex (the paint must have a shader in this 1291 * case). If there is no texs array, but there is a color array, then each 1292 * color is interpolated across its corresponding triangle in a gradient. If 1293 * both texs and colors arrays are present, then they behave as before, but 1294 * the resulting color at each pixels is the result of multiplying the 1295 * colors from the shader and the color-gradient together. The indices array 1296 * is optional, but if it is present, then it is used to specify the index 1297 * of each triangle, rather than just walking through the arrays in order. 1298 * 1299 * @param mode How to interpret the array of vertices 1300 * @param vertexCount The number of values in the vertices array (and 1301 * corresponding texs and colors arrays if non-null). Each logical 1302 * vertex is two values (x, y), vertexCount must be a multiple of 2. 1303 * @param verts Array of vertices for the mesh 1304 * @param vertOffset Number of values in the verts to skip before drawing. 1305 * @param texs May be null. If not null, specifies the coordinates to sample 1306 * into the current shader (e.g. bitmap tile or gradient) 1307 * @param texOffset Number of values in texs to skip before drawing. 1308 * @param colors May be null. If not null, specifies a color for each 1309 * vertex, to be interpolated across the triangle. 1310 * @param colorOffset Number of values in colors to skip before drawing. 1311 * @param indices If not null, array of indices to reference into the 1312 * vertex (texs, colors) array. 1313 * @param indexCount number of entries in the indices array (if not null). 1314 * @param paint Specifies the shader to use if the texs array is non-null. 1315 */ 1316 public void drawVertices(VertexMode mode, int vertexCount, float[] verts, int vertOffset, 1317 float[] texs, int texOffset, int[] colors, int colorOffset, 1318 short[] indices, int indexOffset, int indexCount, Paint paint) { 1319 checkRange(verts.length, vertOffset, vertexCount); 1320 if (texs != null) { 1321 checkRange(texs.length, texOffset, vertexCount); 1322 } 1323 if (colors != null) { 1324 checkRange(colors.length, colorOffset, vertexCount / 2); 1325 } 1326 if (indices != null) { 1327 checkRange(indices.length, indexOffset, indexCount); 1328 } 1329 nativeDrawVertices(mNativeCanvas, mode.nativeInt, vertexCount, verts, 1330 vertOffset, texs, texOffset, colors, colorOffset, 1331 indices, indexOffset, indexCount, paint.mNativePaint); 1332 } 1333 1334 /** 1335 * Draw the text, with origin at (x,y), using the specified paint. The 1336 * origin is interpreted based on the Align setting in the paint. 1337 * 1338 * @param text The text to be drawn 1339 * @param x The x-coordinate of the origin of the text being drawn 1340 * @param y The y-coordinate of the origin of the text being drawn 1341 * @param paint The paint used for the text (e.g. color, size, style) 1342 */ 1343 public void drawText(char[] text, int index, int count, float x, float y, Paint paint) { 1344 if ((index | count | (index + count) | 1345 (text.length - index - count)) < 0) { 1346 throw new IndexOutOfBoundsException(); 1347 } 1348 native_drawText(mNativeCanvas, text, index, count, x, y, paint.mBidiFlags, 1349 paint.mNativePaint); 1350 } 1351 1352 /** 1353 * Draw the text, with origin at (x,y), using the specified paint. The 1354 * origin is interpreted based on the Align setting in the paint. 1355 * 1356 * @param text The text to be drawn 1357 * @param x The x-coordinate of the origin of the text being drawn 1358 * @param y The y-coordinate of the origin of the text being drawn 1359 * @param paint The paint used for the text (e.g. color, size, style) 1360 */ 1361 public void drawText(String text, float x, float y, Paint paint) { 1362 native_drawText(mNativeCanvas, text, 0, text.length(), x, y, paint.mBidiFlags, 1363 paint.mNativePaint); 1364 } 1365 1366 /** 1367 * Draw the text, with origin at (x,y), using the specified paint. 1368 * The origin is interpreted based on the Align setting in the paint. 1369 * 1370 * @param text The text to be drawn 1371 * @param start The index of the first character in text to draw 1372 * @param end (end - 1) is the index of the last character in text to draw 1373 * @param x The x-coordinate of the origin of the text being drawn 1374 * @param y The y-coordinate of the origin of the text being drawn 1375 * @param paint The paint used for the text (e.g. color, size, style) 1376 */ 1377 public void drawText(String text, int start, int end, float x, float y, Paint paint) { 1378 if ((start | end | (end - start) | (text.length() - end)) < 0) { 1379 throw new IndexOutOfBoundsException(); 1380 } 1381 native_drawText(mNativeCanvas, text, start, end, x, y, paint.mBidiFlags, 1382 paint.mNativePaint); 1383 } 1384 1385 /** 1386 * Draw the specified range of text, specified by start/end, with its 1387 * origin at (x,y), in the specified Paint. The origin is interpreted 1388 * based on the Align setting in the Paint. 1389 * 1390 * @param text The text to be drawn 1391 * @param start The index of the first character in text to draw 1392 * @param end (end - 1) is the index of the last character in text 1393 * to draw 1394 * @param x The x-coordinate of origin for where to draw the text 1395 * @param y The y-coordinate of origin for where to draw the text 1396 * @param paint The paint used for the text (e.g. color, size, style) 1397 */ 1398 public void drawText(CharSequence text, int start, int end, float x, float y, Paint paint) { 1399 if (text instanceof String || text instanceof SpannedString || 1400 text instanceof SpannableString) { 1401 native_drawText(mNativeCanvas, text.toString(), start, end, x, y, 1402 paint.mBidiFlags, paint.mNativePaint); 1403 } else if (text instanceof GraphicsOperations) { 1404 ((GraphicsOperations) text).drawText(this, start, end, x, y, 1405 paint); 1406 } else { 1407 char[] buf = TemporaryBuffer.obtain(end - start); 1408 TextUtils.getChars(text, start, end, buf, 0); 1409 native_drawText(mNativeCanvas, buf, 0, end - start, x, y, 1410 paint.mBidiFlags, paint.mNativePaint); 1411 TemporaryBuffer.recycle(buf); 1412 } 1413 } 1414 1415 /** 1416 * Render a run of all LTR or all RTL text, with shaping. This does not run 1417 * bidi on the provided text, but renders it as a uniform right-to-left or 1418 * left-to-right run, as indicated by dir. Alignment of the text is as 1419 * determined by the Paint's TextAlign value. 1420 * 1421 * @param text the text to render 1422 * @param index the start of the text to render 1423 * @param count the count of chars to render 1424 * @param contextIndex the start of the context for shaping. Must be 1425 * no greater than index. 1426 * @param contextCount the number of characters in the context for shaping. 1427 * ContexIndex + contextCount must be no less than index 1428 * + count. 1429 * @param x the x position at which to draw the text 1430 * @param y the y position at which to draw the text 1431 * @param dir the run direction, either {@link #DIRECTION_LTR} or 1432 * {@link #DIRECTION_RTL}. 1433 * @param paint the paint 1434 * @hide 1435 */ 1436 public void drawTextRun(char[] text, int index, int count, int contextIndex, int contextCount, 1437 float x, float y, int dir, Paint paint) { 1438 1439 if (text == null) { 1440 throw new NullPointerException("text is null"); 1441 } 1442 if (paint == null) { 1443 throw new NullPointerException("paint is null"); 1444 } 1445 if ((index | count | text.length - index - count) < 0) { 1446 throw new IndexOutOfBoundsException(); 1447 } 1448 if (dir != DIRECTION_LTR && dir != DIRECTION_RTL) { 1449 throw new IllegalArgumentException("unknown dir: " + dir); 1450 } 1451 1452 native_drawTextRun(mNativeCanvas, text, index, count, 1453 contextIndex, contextCount, x, y, dir, paint.mNativePaint); 1454 } 1455 1456 /** 1457 * Render a run of all LTR or all RTL text, with shaping. This does not run 1458 * bidi on the provided text, but renders it as a uniform right-to-left or 1459 * left-to-right run, as indicated by dir. Alignment of the text is as 1460 * determined by the Paint's TextAlign value. 1461 * 1462 * @param text the text to render 1463 * @param start the start of the text to render. Data before this position 1464 * can be used for shaping context. 1465 * @param end the end of the text to render. Data at or after this 1466 * position can be used for shaping context. 1467 * @param x the x position at which to draw the text 1468 * @param y the y position at which to draw the text 1469 * @param dir the run direction, either 0 for LTR or 1 for RTL. 1470 * @param paint the paint 1471 * @hide 1472 */ 1473 public void drawTextRun(CharSequence text, int start, int end, int contextStart, int contextEnd, 1474 float x, float y, int dir, Paint paint) { 1475 1476 if (text == null) { 1477 throw new NullPointerException("text is null"); 1478 } 1479 if (paint == null) { 1480 throw new NullPointerException("paint is null"); 1481 } 1482 if ((start | end | end - start | text.length() - end) < 0) { 1483 throw new IndexOutOfBoundsException(); 1484 } 1485 1486 int flags = dir == 0 ? 0 : 1; 1487 1488 if (text instanceof String || text instanceof SpannedString || 1489 text instanceof SpannableString) { 1490 native_drawTextRun(mNativeCanvas, text.toString(), start, end, 1491 contextStart, contextEnd, x, y, flags, paint.mNativePaint); 1492 } else if (text instanceof GraphicsOperations) { 1493 ((GraphicsOperations) text).drawTextRun(this, start, end, 1494 contextStart, contextEnd, x, y, flags, paint); 1495 } else { 1496 int contextLen = contextEnd - contextStart; 1497 int len = end - start; 1498 char[] buf = TemporaryBuffer.obtain(contextLen); 1499 TextUtils.getChars(text, contextStart, contextEnd, buf, 0); 1500 native_drawTextRun(mNativeCanvas, buf, start - contextStart, len, 1501 0, contextLen, x, y, flags, paint.mNativePaint); 1502 TemporaryBuffer.recycle(buf); 1503 } 1504 } 1505 1506 /** 1507 * Draw the text in the array, with each character's origin specified by 1508 * the pos array. 1509 * 1510 * This method does not support glyph composition and decomposition and 1511 * should therefore not be used to render complex scripts. 1512 * 1513 * @param text The text to be drawn 1514 * @param index The index of the first character to draw 1515 * @param count The number of characters to draw, starting from index. 1516 * @param pos Array of [x,y] positions, used to position each 1517 * character 1518 * @param paint The paint used for the text (e.g. color, size, style) 1519 */ 1520 @Deprecated 1521 public void drawPosText(char[] text, int index, int count, float[] pos, Paint paint) { 1522 if (index < 0 || index + count > text.length || count*2 > pos.length) { 1523 throw new IndexOutOfBoundsException(); 1524 } 1525 native_drawPosText(mNativeCanvas, text, index, count, pos, 1526 paint.mNativePaint); 1527 } 1528 1529 /** 1530 * Draw the text in the array, with each character's origin specified by 1531 * the pos array. 1532 * 1533 * This method does not support glyph composition and decomposition and 1534 * should therefore not be used to render complex scripts. 1535 * 1536 * @param text The text to be drawn 1537 * @param pos Array of [x,y] positions, used to position each character 1538 * @param paint The paint used for the text (e.g. color, size, style) 1539 */ 1540 @Deprecated 1541 public void drawPosText(String text, float[] pos, Paint paint) { 1542 if (text.length()*2 > pos.length) { 1543 throw new ArrayIndexOutOfBoundsException(); 1544 } 1545 native_drawPosText(mNativeCanvas, text, pos, paint.mNativePaint); 1546 } 1547 1548 /** 1549 * Draw the text, with origin at (x,y), using the specified paint, along 1550 * the specified path. The paint's Align setting determins where along the 1551 * path to start the text. 1552 * 1553 * @param text The text to be drawn 1554 * @param path The path the text should follow for its baseline 1555 * @param hOffset The distance along the path to add to the text's 1556 * starting position 1557 * @param vOffset The distance above(-) or below(+) the path to position 1558 * the text 1559 * @param paint The paint used for the text (e.g. color, size, style) 1560 */ 1561 public void drawTextOnPath(char[] text, int index, int count, Path path, 1562 float hOffset, float vOffset, Paint paint) { 1563 if (index < 0 || index + count > text.length) { 1564 throw new ArrayIndexOutOfBoundsException(); 1565 } 1566 native_drawTextOnPath(mNativeCanvas, text, index, count, 1567 path.ni(), hOffset, vOffset, 1568 paint.mBidiFlags, paint.mNativePaint); 1569 } 1570 1571 /** 1572 * Draw the text, with origin at (x,y), using the specified paint, along 1573 * the specified path. The paint's Align setting determins where along the 1574 * path to start the text. 1575 * 1576 * @param text The text to be drawn 1577 * @param path The path the text should follow for its baseline 1578 * @param hOffset The distance along the path to add to the text's 1579 * starting position 1580 * @param vOffset The distance above(-) or below(+) the path to position 1581 * the text 1582 * @param paint The paint used for the text (e.g. color, size, style) 1583 */ 1584 public void drawTextOnPath(String text, Path path, float hOffset, float vOffset, Paint paint) { 1585 if (text.length() > 0) { 1586 native_drawTextOnPath(mNativeCanvas, text, path.ni(), hOffset, vOffset, 1587 paint.mBidiFlags, paint.mNativePaint); 1588 } 1589 } 1590 1591 /** 1592 * Save the canvas state, draw the picture, and restore the canvas state. 1593 * This differs from picture.draw(canvas), which does not perform any 1594 * save/restore. 1595 * 1596 * <p> 1597 * <strong>Note:</strong> This forces the picture to internally call 1598 * {@link Picture#endRecording} in order to prepare for playback. 1599 * 1600 * @param picture The picture to be drawn 1601 */ 1602 public void drawPicture(Picture picture) { 1603 picture.endRecording(); 1604 native_drawPicture(mNativeCanvas, picture.ni()); 1605 } 1606 1607 /** 1608 * Draw the picture, stretched to fit into the dst rectangle. 1609 */ 1610 public void drawPicture(Picture picture, RectF dst) { 1611 save(); 1612 translate(dst.left, dst.top); 1613 if (picture.getWidth() > 0 && picture.getHeight() > 0) { 1614 scale(dst.width() / picture.getWidth(), dst.height() / picture.getHeight()); 1615 } 1616 drawPicture(picture); 1617 restore(); 1618 } 1619 1620 /** 1621 * Draw the picture, stretched to fit into the dst rectangle. 1622 */ 1623 public void drawPicture(Picture picture, Rect dst) { 1624 save(); 1625 translate(dst.left, dst.top); 1626 if (picture.getWidth() > 0 && picture.getHeight() > 0) { 1627 scale((float) dst.width() / picture.getWidth(), 1628 (float) dst.height() / picture.getHeight()); 1629 } 1630 drawPicture(picture); 1631 restore(); 1632 } 1633 1634 /** 1635 * Free up as much memory as possible from private caches (e.g. fonts, images) 1636 * 1637 * @hide 1638 */ 1639 public static native void freeCaches(); 1640 1641 /** 1642 * Free up text layout caches 1643 * 1644 * @hide 1645 */ 1646 public static native void freeTextLayoutCaches(); 1647 1648 private static native int initRaster(int nativeBitmapOrZero); 1649 private static native void copyNativeCanvasState(int srcCanvas, int dstCanvas); 1650 private static native int native_saveLayer(int nativeCanvas, RectF bounds, 1651 int paint, int layerFlags); 1652 private static native int native_saveLayer(int nativeCanvas, float l, 1653 float t, float r, float b, 1654 int paint, int layerFlags); 1655 private static native int native_saveLayerAlpha(int nativeCanvas, 1656 RectF bounds, int alpha, 1657 int layerFlags); 1658 private static native int native_saveLayerAlpha(int nativeCanvas, float l, 1659 float t, float r, float b, 1660 int alpha, int layerFlags); 1661 1662 private static native void native_concat(int nCanvas, int nMatrix); 1663 private static native void native_setMatrix(int nCanvas, int nMatrix); 1664 private static native boolean native_clipRect(int nCanvas, 1665 float left, float top, 1666 float right, float bottom, 1667 int regionOp); 1668 private static native boolean native_clipPath(int nativeCanvas, 1669 int nativePath, 1670 int regionOp); 1671 private static native boolean native_clipRegion(int nativeCanvas, 1672 int nativeRegion, 1673 int regionOp); 1674 private static native void nativeSetDrawFilter(int nativeCanvas, 1675 int nativeFilter); 1676 private static native boolean native_getClipBounds(int nativeCanvas, 1677 Rect bounds); 1678 private static native void native_getCTM(int canvas, int matrix); 1679 private static native boolean native_quickReject(int nativeCanvas, 1680 RectF rect); 1681 private static native boolean native_quickReject(int nativeCanvas, 1682 int path); 1683 private static native boolean native_quickReject(int nativeCanvas, 1684 float left, float top, 1685 float right, float bottom); 1686 private static native void native_drawRGB(int nativeCanvas, int r, int g, 1687 int b); 1688 private static native void native_drawARGB(int nativeCanvas, int a, int r, 1689 int g, int b); 1690 private static native void native_drawColor(int nativeCanvas, int color); 1691 private static native void native_drawColor(int nativeCanvas, int color, 1692 int mode); 1693 private static native void native_drawPaint(int nativeCanvas, int paint); 1694 private static native void native_drawLine(int nativeCanvas, float startX, 1695 float startY, float stopX, 1696 float stopY, int paint); 1697 private static native void native_drawRect(int nativeCanvas, RectF rect, 1698 int paint); 1699 private static native void native_drawRect(int nativeCanvas, float left, 1700 float top, float right, 1701 float bottom, int paint); 1702 private static native void native_drawOval(int nativeCanvas, RectF oval, 1703 int paint); 1704 private static native void native_drawCircle(int nativeCanvas, float cx, 1705 float cy, float radius, 1706 int paint); 1707 private static native void native_drawArc(int nativeCanvas, RectF oval, 1708 float startAngle, float sweep, 1709 boolean useCenter, int paint); 1710 private static native void native_drawRoundRect(int nativeCanvas, 1711 RectF rect, float rx, 1712 float ry, int paint); 1713 private static native void native_drawPath(int nativeCanvas, int path, 1714 int paint); 1715 private native void native_drawBitmap(int nativeCanvas, int bitmap, 1716 float left, float top, 1717 int nativePaintOrZero, 1718 int canvasDensity, 1719 int screenDensity, 1720 int bitmapDensity); 1721 private native void native_drawBitmap(int nativeCanvas, int bitmap, 1722 Rect src, RectF dst, 1723 int nativePaintOrZero, 1724 int screenDensity, 1725 int bitmapDensity); 1726 private static native void native_drawBitmap(int nativeCanvas, int bitmap, 1727 Rect src, Rect dst, 1728 int nativePaintOrZero, 1729 int screenDensity, 1730 int bitmapDensity); 1731 private static native void native_drawBitmap(int nativeCanvas, int[] colors, 1732 int offset, int stride, float x, 1733 float y, int width, int height, 1734 boolean hasAlpha, 1735 int nativePaintOrZero); 1736 private static native void nativeDrawBitmapMatrix(int nCanvas, int nBitmap, 1737 int nMatrix, int nPaint); 1738 private static native void nativeDrawBitmapMesh(int nCanvas, int nBitmap, 1739 int meshWidth, int meshHeight, 1740 float[] verts, int vertOffset, 1741 int[] colors, int colorOffset, int nPaint); 1742 private static native void nativeDrawVertices(int nCanvas, int mode, int n, 1743 float[] verts, int vertOffset, float[] texs, int texOffset, 1744 int[] colors, int colorOffset, short[] indices, 1745 int indexOffset, int indexCount, int nPaint); 1746 1747 private static native void native_drawText(int nativeCanvas, char[] text, 1748 int index, int count, float x, 1749 float y, int flags, int paint); 1750 private static native void native_drawText(int nativeCanvas, String text, 1751 int start, int end, float x, 1752 float y, int flags, int paint); 1753 1754 private static native void native_drawTextRun(int nativeCanvas, String text, 1755 int start, int end, int contextStart, int contextEnd, 1756 float x, float y, int flags, int paint); 1757 1758 private static native void native_drawTextRun(int nativeCanvas, char[] text, 1759 int start, int count, int contextStart, int contextCount, 1760 float x, float y, int flags, int paint); 1761 1762 private static native void native_drawPosText(int nativeCanvas, 1763 char[] text, int index, 1764 int count, float[] pos, 1765 int paint); 1766 private static native void native_drawPosText(int nativeCanvas, 1767 String text, float[] pos, 1768 int paint); 1769 private static native void native_drawTextOnPath(int nativeCanvas, 1770 char[] text, int index, 1771 int count, int path, 1772 float hOffset, 1773 float vOffset, int bidiFlags, 1774 int paint); 1775 private static native void native_drawTextOnPath(int nativeCanvas, 1776 String text, int path, 1777 float hOffset, 1778 float vOffset, 1779 int flags, int paint); 1780 private static native void native_drawPicture(int nativeCanvas, 1781 int nativePicture); 1782 private static native void finalizer(int nativeCanvas); 1783} 1784