diff options
Diffstat (limited to 'include/core/SkCanvas.h')
| -rw-r--r-- | include/core/SkCanvas.h | 205 |
1 files changed, 101 insertions, 104 deletions
diff --git a/include/core/SkCanvas.h b/include/core/SkCanvas.h index bd9591117e..d89dd52547 100644 --- a/include/core/SkCanvas.h +++ b/include/core/SkCanvas.h @@ -6,7 +6,7 @@ */ /* Generated by tools/bookmaker from include/core/SkCanvas.h and docs/SkCanvas_Reference.bmh - on 2018-07-03 11:34:22. Additional documentation and examples can be found at: + on 2018-07-13 08:15:10. Additional documentation and examples can be found at: https://skia.org/user/api/SkCanvas_Reference You may edit either file directly. Structural changes to public interfaces require @@ -168,7 +168,7 @@ public: */ explicit SkCanvas(sk_sp<SkBaseDevice> device); - /** Construct a canvas that draws into bitmap. + /** Constructs a canvas that draws into bitmap. Sets SkSurfaceProps::kLegacyFontHost_InitType in constructed SkSurface. SkBitmap is copied so that subsequently editing bitmap will not affect @@ -187,7 +187,7 @@ public: kLegacy, //!< placeholder }; - /** Android framework only. + /** For use by Android framework only. @param bitmap specifies a bitmap for the canvas to draw into @param behavior specializes this constructor; value is unused @@ -196,7 +196,7 @@ public: SkCanvas(const SkBitmap& bitmap, ColorBehavior behavior); #endif - /** Construct a canvas that draws into bitmap. + /** Constructs a canvas that draws into bitmap. Use props to match the device characteristics, like LCD striping. bitmap is copied so that subsequently editing bitmap will not affect @@ -229,9 +229,8 @@ public: */ SkImageInfo imageInfo() const; - /** If SkCanvas is associated with raster surface or - GPU surface, copies SkSurfaceProps and returns true. Otherwise, - return false and leave props unchanged. + /** Copies SkSurfaceProps, if SkCanvas is associated with raster surface or + GPU surface, and returns true. Otherwise, returns false and leave props unchanged. @param props storage for writable SkSurfaceProps @return true if SkSurfaceProps was copied @@ -492,8 +491,8 @@ public: bool writePixels(const SkBitmap& bitmap, int x, int y); /** Saves SkMatrix and clip. - Calling restore() discards changes to SkMatrix and clip, restoring the SkMatrix and clip to - their state when save() was called. + Calling restore() discards changes to SkMatrix and clip, + restoring the SkMatrix and clip to their state when save() was called. SkMatrix may be changed by translate(), scale(), rotate(), skew(), concat(), setMatrix(), and resetMatrix(). Clip may be changed by clipRect(), clipRRect(), clipPath(), clipRegion(). @@ -580,8 +579,8 @@ public: /** Saves SkMatrix and clip, and allocates SkBitmap for subsequent drawing. - Calling restore() discards changes to SkMatrix and clip, and blends layer with alpha opacity - onto prior layer. + Calling restore() discards changes to SkMatrix and clip, + and blends layer with alpha opacity onto prior layer. SkMatrix may be changed by translate(), scale(), rotate(), skew(), concat(), setMatrix(), and resetMatrix(). Clip may be changed by clipRect(), clipRRect(), @@ -726,8 +725,8 @@ public: */ int saveLayer(const SaveLayerRec& layerRec); - /** Removes changes to SkMatrix and clip since SkCanvas state was last saved. - The state is removed from the stack. + /** Removes changes to SkMatrix and clip since SkCanvas state was + last saved. The state is removed from the stack. Does nothing if the stack is empty. */ @@ -751,9 +750,9 @@ public: */ void restoreToCount(int saveCount); - /** Translate SkMatrix by dx along the x-axis and dy along the y-axis. + /** Translates SkMatrix by dx along the x-axis and dy along the y-axis. - Mathematically, replace SkMatrix with a translation matrix + Mathematically, replaces SkMatrix with a translation matrix premultiplied with SkMatrix. This has the effect of moving the drawing by (dx, dy) before transforming @@ -764,9 +763,9 @@ public: */ void translate(SkScalar dx, SkScalar dy); - /** Scale SkMatrix by sx on the x-axis and sy on the y-axis. + /** Scales SkMatrix by sx on the x-axis and sy on the y-axis. - Mathematically, replace SkMatrix with a scale matrix + Mathematically, replaces SkMatrix with a scale matrix premultiplied with SkMatrix. This has the effect of scaling the drawing by (sx, sy) before transforming @@ -777,9 +776,9 @@ public: */ void scale(SkScalar sx, SkScalar sy); - /** Rotate SkMatrix by degrees. Positive degrees rotates clockwise. + /** Rotates SkMatrix by degrees. Positive degrees rotates clockwise. - Mathematically, replace SkMatrix with a rotation matrix + Mathematically, replaces SkMatrix with a rotation matrix premultiplied with SkMatrix. This has the effect of rotating the drawing by degrees before transforming @@ -789,11 +788,11 @@ public: */ void rotate(SkScalar degrees); - /** Rotate SkMatrix by degrees about a point at (px, py). Positive degrees rotates + /** Rotates SkMatrix by degrees about a point at (px, py). Positive degrees rotates clockwise. - Mathematically, construct a rotation matrix. Premultiply the rotation matrix by - a translation matrix, then replace SkMatrix with the resulting matrix + Mathematically, constructs a rotation matrix; premultiplies the rotation matrix by + a translation matrix; then replaces SkMatrix with the resulting matrix premultiplied with SkMatrix. This has the effect of rotating the drawing about a given point before @@ -805,11 +804,11 @@ public: */ void rotate(SkScalar degrees, SkScalar px, SkScalar py); - /** Skew SkMatrix by sx on the x-axis and sy on the y-axis. A positive value of sx + /** Skews SkMatrix by sx on the x-axis and sy on the y-axis. A positive value of sx skews the drawing right as y-axis values increase; a positive value of sy skews the drawing down as x-axis values increase. - Mathematically, replace SkMatrix with a skew matrix premultiplied with SkMatrix. + Mathematically, replaces SkMatrix with a skew matrix premultiplied with SkMatrix. This has the effect of skewing the drawing by (sx, sy) before transforming the result with SkMatrix. @@ -819,7 +818,7 @@ public: */ void skew(SkScalar sx, SkScalar sy); - /** Replace SkMatrix with matrix premultiplied with existing SkMatrix. + /** Replaces SkMatrix with matrix premultiplied with existing SkMatrix. This has the effect of transforming the drawn geometry by matrix, before transforming the result with existing SkMatrix. @@ -828,7 +827,7 @@ public: */ void concat(const SkMatrix& matrix); - /** Replace SkMatrix with matrix. + /** Replaces SkMatrix with matrix. Unlike concat(), any prior matrix state is overwritten. @param matrix matrix to copy, replacing existing SkMatrix @@ -840,7 +839,7 @@ public: */ void resetMatrix(); - /** Replace clip with the intersection or difference of clip and rect, + /** Replaces clip with the intersection or difference of clip and rect, with an aliased or anti-aliased clip edge. rect is transformed by SkMatrix before it is combined with clip. @@ -850,7 +849,7 @@ public: */ void clipRect(const SkRect& rect, SkClipOp op, bool doAntiAlias); - /** Replace clip with the intersection or difference of clip and rect. + /** Replaces clip with the intersection or difference of clip and rect. Resulting clip is aliased; pixels are fully contained by the clip. rect is transformed by SkMatrix before it is combined with clip. @@ -861,7 +860,7 @@ public: this->clipRect(rect, op, false); } - /** Replace clip with the intersection of clip and rect. + /** Replaces clip with the intersection of clip and rect. Resulting clip is aliased; pixels are fully contained by the clip. rect is transformed by SkMatrix before it is combined with clip. @@ -885,7 +884,7 @@ public: */ void androidFramework_setDeviceClipRestriction(const SkIRect& rect); - /** Replace clip with the intersection or difference of clip and rrect, + /** Replaces clip with the intersection or difference of clip and rrect, with an aliased or anti-aliased clip edge. rrect is transformed by SkMatrix before it is combined with clip. @@ -896,7 +895,7 @@ public: */ void clipRRect(const SkRRect& rrect, SkClipOp op, bool doAntiAlias); - /** Replace clip with the intersection or difference of clip and rrect. + /** Replaces clip with the intersection or difference of clip and rrect. Resulting clip is aliased; pixels are fully contained by the clip. rrect is transformed by SkMatrix before it is combined with clip. @@ -907,7 +906,7 @@ public: this->clipRRect(rrect, op, false); } - /** Replace clip with the intersection of clip and rrect, + /** Replaces clip with the intersection of clip and rrect, with an aliased or anti-aliased clip edge. rrect is transformed by SkMatrix before it is combined with clip. @@ -918,7 +917,7 @@ public: this->clipRRect(rrect, SkClipOp::kIntersect, doAntiAlias); } - /** Replace clip with the intersection or difference of clip and path, + /** Replaces clip with the intersection or difference of clip and path, with an aliased or anti-aliased clip edge. SkPath::FillType determines if path describes the area inside or outside its contours; and if path contour overlaps itself or another path contour, whether the overlaps form part of the area. @@ -930,7 +929,7 @@ public: */ void clipPath(const SkPath& path, SkClipOp op, bool doAntiAlias); - /** Replace clip with the intersection or difference of clip and path. + /** Replaces clip with the intersection or difference of clip and path. Resulting clip is aliased; pixels are fully contained by the clip. SkPath::FillType determines if path describes the area inside or outside its contours; and if path contour overlaps @@ -945,7 +944,7 @@ public: this->clipPath(path, op, false); } - /** Replace clip with the intersection of clip and path. + /** Replaces clip with the intersection of clip and path. Resulting clip is aliased; pixels are fully contained by the clip. SkPath::FillType determines if path describes the area inside or outside its contours; and if path contour overlaps @@ -966,7 +965,7 @@ public: fAllowSimplifyClip = allow; } - /** Replace clip with the intersection or difference of clip and SkRegion deviceRgn. + /** Replaces clip with the intersection or difference of clip and SkRegion deviceRgn. Resulting clip is aliased; pixels are fully contained by the clip. deviceRgn is unaffected by SkMatrix. @@ -975,7 +974,7 @@ public: */ void clipRegion(const SkRegion& deviceRgn, SkClipOp op = SkClipOp::kIntersect); - /** Return true if SkRect rect, transformed by SkMatrix, can be quickly determined to be + /** Returns true if SkRect rect, transformed by SkMatrix, can be quickly determined to be outside of clip. May return false even though rect is outside of clip. Use to check if an area to be drawn is clipped out, to skip subsequent draw calls. @@ -985,7 +984,7 @@ public: */ bool quickReject(const SkRect& rect) const; - /** Return true if path, transformed by SkMatrix, can be quickly determined to be + /** Returns true if path, transformed by SkMatrix, can be quickly determined to be outside of clip. May return false even though path is outside of clip. Use to check if an area to be drawn is clipped out, to skip subsequent draw calls. @@ -995,7 +994,7 @@ public: */ bool quickReject(const SkPath& path) const; - /** Return bounds of clip, transformed by inverse of SkMatrix. If clip is empty, + /** Returns bounds of clip, transformed by inverse of SkMatrix. If clip is empty, return SkRect::MakeEmpty, where all SkRect sides equal zero. SkRect returned is outset by one to account for partial pixel coverage if clip @@ -1005,7 +1004,7 @@ public: */ SkRect getLocalClipBounds() const; - /** Return bounds of clip, transformed by inverse of SkMatrix. If clip is empty, + /** Returns bounds of clip, transformed by inverse of SkMatrix. If clip is empty, return false, and set bounds to SkRect::MakeEmpty, where all SkRect sides equal zero. bounds is outset by one to account for partial pixel coverage if clip @@ -1019,7 +1018,7 @@ public: return !bounds->isEmpty(); } - /** Return SkIRect bounds of clip, unaffected by SkMatrix. If clip is empty, + /** Returns SkIRect bounds of clip, unaffected by SkMatrix. If clip is empty, return SkRect::MakeEmpty, where all SkRect sides equal zero. Unlike getLocalClipBounds(), returned SkIRect is not outset. @@ -1028,7 +1027,7 @@ public: */ SkIRect getDeviceClipBounds() const; - /** Return SkIRect bounds of clip, unaffected by SkMatrix. If clip is empty, + /** Returns SkIRect bounds of clip, unaffected by SkMatrix. If clip is empty, return false, and set bounds to SkRect::MakeEmpty, where all SkRect sides equal zero. Unlike getLocalClipBounds(), bounds is not outset. @@ -1041,7 +1040,7 @@ public: return !bounds->isEmpty(); } - /** Fill clip with color color. + /** Fills clip with color color. mode determines how ARGB is combined with destination. @param color unpremultiplied ARGB @@ -1049,7 +1048,7 @@ public: */ void drawColor(SkColor color, SkBlendMode mode = SkBlendMode::kSrcOver); - /** Fill clip with color color using SkBlendMode::kSrc. + /** Fills clip with color color using SkBlendMode::kSrc. This has the effect of replacing all pixels contained by clip with color. @param color unpremultiplied ARGB @@ -1058,7 +1057,7 @@ public: this->drawColor(color, SkBlendMode::kSrc); } - /** Make SkCanvas contents undefined. Subsequent calls that read SkCanvas pixels, + /** Makes SkCanvas contents undefined. Subsequent calls that read SkCanvas pixels, such as drawing with SkBlendMode, return undefined results. discard() does not change clip or SkMatrix. @@ -1072,7 +1071,7 @@ public: */ void discard() { this->onDiscard(); } - /** Fill clip with SkPaint paint. SkPaint components SkMaskFilter, SkShader, + /** Fills clip with SkPaint paint. SkPaint components SkMaskFilter, SkShader, SkColorFilter, SkImageFilter, and SkBlendMode affect drawing; SkPathEffect in paint is ignored. @@ -1090,7 +1089,7 @@ public: kPolygon_PointMode, //!< draw the array of points as a open polygon }; - /** Draw pts using clip, SkMatrix and SkPaint paint. + /** Draws pts using clip, SkMatrix and SkPaint paint. count is the number of points; if count is less than one, has no effect. mode may be one of: kPoints_PointMode, kLines_PointMode, or kPolygon_PointMode. @@ -1121,7 +1120,7 @@ public: */ void drawPoints(PointMode mode, size_t count, const SkPoint pts[], const SkPaint& paint); - /** Draw point at (x, y) using clip, SkMatrix and SkPaint paint. + /** Draws point at (x, y) using clip, SkMatrix and SkPaint paint. The shape of point drawn depends on paint SkPaint::Cap. If paint is set to SkPaint::kRound_Cap, draw a circle of diameter @@ -1135,7 +1134,7 @@ public: */ void drawPoint(SkScalar x, SkScalar y, const SkPaint& paint); - /** Draw point p using clip, SkMatrix and SkPaint paint. + /** Draws point p using clip, SkMatrix and SkPaint paint. The shape of point drawn depends on paint SkPaint::Cap. If paint is set to SkPaint::kRound_Cap, draw a circle of diameter @@ -1176,7 +1175,7 @@ public: this->drawLine(p0.x(), p0.y(), p1.x(), p1.y(), paint); } - /** Draw SkRect rect using clip, SkMatrix, and SkPaint paint. + /** Draws SkRect rect using clip, SkMatrix, and SkPaint paint. In paint: SkPaint::Style determines if rectangle is stroked or filled; if stroked, SkPaint stroke width describes the line thickness, and SkPaint::Join draws the corners rounded or square. @@ -1186,7 +1185,7 @@ public: */ void drawRect(const SkRect& rect, const SkPaint& paint); - /** Draw SkIRect rect using clip, SkMatrix, and SkPaint paint. + /** Draws SkIRect rect using clip, SkMatrix, and SkPaint paint. In paint: SkPaint::Style determines if rectangle is stroked or filled; if stroked, SkPaint stroke width describes the line thickness, and SkPaint::Join draws the corners rounded or square. @@ -1200,7 +1199,7 @@ public: this->drawRect(r, paint); } - /** Draw SkRegion region using clip, SkMatrix, and SkPaint paint. + /** Draws SkRegion region using clip, SkMatrix, and SkPaint paint. In paint: SkPaint::Style determines if rectangle is stroked or filled; if stroked, SkPaint stroke width describes the line thickness, and SkPaint::Join draws the corners rounded or square. @@ -1210,7 +1209,7 @@ public: */ void drawRegion(const SkRegion& region, const SkPaint& paint); - /** Draw oval oval using clip, SkMatrix, and SkPaint. + /** Draws oval oval using clip, SkMatrix, and SkPaint. In paint: SkPaint::Style determines if oval is stroked or filled; if stroked, SkPaint stroke width describes the line thickness. @@ -1219,7 +1218,7 @@ public: */ void drawOval(const SkRect& oval, const SkPaint& paint); - /** Draw SkRRect rrect using clip, SkMatrix, and SkPaint paint. + /** Draws SkRRect rrect using clip, SkMatrix, and SkPaint paint. In paint: SkPaint::Style determines if rrect is stroked or filled; if stroked, SkPaint stroke width describes the line thickness. @@ -1231,7 +1230,7 @@ public: */ void drawRRect(const SkRRect& rrect, const SkPaint& paint); - /** Draw SkRRect outer and inner + /** Draws SkRRect outer and inner using clip, SkMatrix, and SkPaint paint. outer must contain inner or the drawing is undefined. In paint: SkPaint::Style determines if SkRRect is stroked or filled; @@ -1249,7 +1248,7 @@ public: */ void drawDRRect(const SkRRect& outer, const SkRRect& inner, const SkPaint& paint); - /** Draw circle at (cx, cy) with radius using clip, SkMatrix, and SkPaint paint. + /** Draws circle at (cx, cy) with radius using clip, SkMatrix, and SkPaint paint. If radius is zero or less, nothing is drawn. In paint: SkPaint::Style determines if circle is stroked or filled; if stroked, SkPaint stroke width describes the line thickness. @@ -1261,7 +1260,7 @@ public: */ void drawCircle(SkScalar cx, SkScalar cy, SkScalar radius, const SkPaint& paint); - /** Draw circle at center with radius using clip, SkMatrix, and SkPaint paint. + /** Draws circle at center with radius using clip, SkMatrix, and SkPaint paint. If radius is zero or less, nothing is drawn. In paint: SkPaint::Style determines if circle is stroked or filled; if stroked, SkPaint stroke width describes the line thickness. @@ -1274,7 +1273,7 @@ public: this->drawCircle(center.x(), center.y(), radius, paint); } - /** Draw arc using clip, SkMatrix, and SkPaint paint. + /** Draws arc using clip, SkMatrix, and SkPaint paint. Arc is part of oval bounded by oval, sweeping from startAngle to startAngle plus sweepAngle. startAngle and sweepAngle are in degrees. @@ -1297,7 +1296,7 @@ public: void drawArc(const SkRect& oval, SkScalar startAngle, SkScalar sweepAngle, bool useCenter, const SkPaint& paint); - /** Draw SkRRect bounded by SkRect rect, with corner radii (rx, ry) using clip, + /** Draws SkRRect bounded by SkRect rect, with corner radii (rx, ry) using clip, SkMatrix, and SkPaint paint. In paint: SkPaint::Style determines if SkRRect is stroked or filled; @@ -1314,7 +1313,7 @@ public: */ void drawRoundRect(const SkRect& rect, SkScalar rx, SkScalar ry, const SkPaint& paint); - /** Draw SkPath path using clip, SkMatrix, and SkPaint paint. + /** Draws SkPath path using clip, SkMatrix, and SkPaint paint. SkPath contains an array of path contour, each of which may be open or closed. In paint: SkPaint::Style determines if SkRRect is stroked or filled: @@ -1328,7 +1327,7 @@ public: */ void drawPath(const SkPath& path, const SkPaint& paint); - /** Draw SkImage image, with its top-left corner at (left, top), + /** Draws SkImage image, with its top-left corner at (left, top), using clip, SkMatrix, and optional SkPaint paint. If paint is supplied, apply SkColorFilter, alpha, SkImageFilter, SkBlendMode, @@ -1347,7 +1346,7 @@ public: void drawImage(const SkImage* image, SkScalar left, SkScalar top, const SkPaint* paint = nullptr); - /** Draw SkImage image, with its top-left corner at (left, top), + /** Draws SkImage image, with its top-left corner at (left, top), using clip, SkMatrix, and optional SkPaint paint. If SkPaint paint is supplied, apply SkColorFilter, alpha, SkImageFilter, @@ -1383,7 +1382,7 @@ public: kFast_SrcRectConstraint, //!< sample outside bounds; faster }; - /** Draw SkRect src of SkImage image, scaled and translated to fill SkRect dst. + /** Draws SkRect src of SkImage image, scaled and translated to fill SkRect dst. Additionally transform draw using clip, SkMatrix, and optional SkPaint paint. If SkPaint paint is supplied, apply SkColorFilter, alpha, SkImageFilter, @@ -1409,7 +1408,7 @@ public: const SkPaint* paint, SrcRectConstraint constraint = kStrict_SrcRectConstraint); - /** Draw SkIRect isrc of SkImage image, scaled and translated to fill SkRect dst. + /** Draws SkIRect isrc of SkImage image, scaled and translated to fill SkRect dst. Note that isrc is on integer pixel boundaries; dst may include fractional boundaries. Additionally transform draw using clip, SkMatrix, and optional SkPaint paint. @@ -1437,7 +1436,7 @@ public: const SkPaint* paint, SrcRectConstraint constraint = kStrict_SrcRectConstraint); - /** Draw SkImage image, scaled and translated to fill SkRect dst, using clip, SkMatrix, + /** Draws SkImage image, scaled and translated to fill SkRect dst, using clip, SkMatrix, and optional SkPaint paint. If SkPaint paint is supplied, apply SkColorFilter, alpha, SkImageFilter, @@ -1461,7 +1460,7 @@ public: void drawImageRect(const SkImage* image, const SkRect& dst, const SkPaint* paint, SrcRectConstraint constraint = kStrict_SrcRectConstraint); - /** Draw SkRect src of SkImage image, scaled and translated to fill SkRect dst. + /** Draws SkRect src of SkImage image, scaled and translated to fill SkRect dst. Additionally transform draw using clip, SkMatrix, and optional SkPaint paint. If SkPaint paint is supplied, apply SkColorFilter, alpha, SkImageFilter, @@ -1489,7 +1488,7 @@ public: this->drawImageRect(image.get(), src, dst, paint, constraint); } - /** Draw SkIRect isrc of SkImage image, scaled and translated to fill SkRect dst. + /** Draws SkIRect isrc of SkImage image, scaled and translated to fill SkRect dst. isrc is on integer pixel boundaries; dst may include fractional boundaries. Additionally transform draw using clip, SkMatrix, and optional SkPaint paint. @@ -1518,7 +1517,7 @@ public: this->drawImageRect(image.get(), isrc, dst, paint, constraint); } - /** Draw SkImage image, scaled and translated to fill SkRect dst, + /** Draws SkImage image, scaled and translated to fill SkRect dst, using clip, SkMatrix, and optional SkPaint paint. If SkPaint paint is supplied, apply SkColorFilter, alpha, SkImageFilter, @@ -1544,7 +1543,7 @@ public: this->drawImageRect(image.get(), dst, paint, constraint); } - /** Draw SkImage image stretched proportionally to fit into SkRect dst. + /** Draws SkImage image stretched proportionally to fit into SkRect dst. SkIRect center divides the image into nine sections: four sides, four corners, and the center. Corners are unmodified or scaled down proportionately if their sides are larger than dst; center and four sides are scaled to fit remaining space, if any. @@ -1571,7 +1570,7 @@ public: void drawImageNine(const SkImage* image, const SkIRect& center, const SkRect& dst, const SkPaint* paint = nullptr); - /** Draw SkImage image stretched proportionally to fit into SkRect dst. + /** Draws SkImage image stretched proportionally to fit into SkRect dst. SkIRect center divides the image into nine sections: four sides, four corners, and the center. Corners are not scaled, or scaled down proportionately if their sides are larger than dst; center and four sides are scaled to fit remaining space, if any. @@ -1600,7 +1599,7 @@ public: this->drawImageNine(image.get(), center, dst, paint); } - /** Draw SkBitmap bitmap, with its top-left corner at (left, top), + /** Draws SkBitmap bitmap, with its top-left corner at (left, top), using clip, SkMatrix, and optional SkPaint paint. If SkPaint paint is not nullptr, apply SkColorFilter, alpha, SkImageFilter, @@ -1621,7 +1620,7 @@ public: void drawBitmap(const SkBitmap& bitmap, SkScalar left, SkScalar top, const SkPaint* paint = nullptr); - /** Draw SkRect src of SkBitmap bitmap, scaled and translated to fill SkRect dst. + /** Draws SkRect src of SkBitmap bitmap, scaled and translated to fill SkRect dst. Additionally transform draw using clip, SkMatrix, and optional SkPaint paint. If SkPaint paint is supplied, apply SkColorFilter, alpha, SkImageFilter, @@ -1648,7 +1647,7 @@ public: const SkPaint* paint, SrcRectConstraint constraint = kStrict_SrcRectConstraint); - /** Draw SkIRect isrc of SkBitmap bitmap, scaled and translated to fill SkRect dst. + /** Draws SkIRect isrc of SkBitmap bitmap, scaled and translated to fill SkRect dst. isrc is on integer pixel boundaries; dst may include fractional boundaries. Additionally transform draw using clip, SkMatrix, and optional SkPaint paint. @@ -1676,7 +1675,7 @@ public: const SkPaint* paint, SrcRectConstraint constraint = kStrict_SrcRectConstraint); - /** Draw SkBitmap bitmap, scaled and translated to fill SkRect dst. + /** Draws SkBitmap bitmap, scaled and translated to fill SkRect dst. bitmap bounds is on integer pixel boundaries; dst may include fractional boundaries. Additionally transform draw using clip, SkMatrix, and optional SkPaint paint. @@ -1702,7 +1701,7 @@ public: void drawBitmapRect(const SkBitmap& bitmap, const SkRect& dst, const SkPaint* paint, SrcRectConstraint constraint = kStrict_SrcRectConstraint); - /** Draw SkBitmap bitmap stretched proportionally to fit into SkRect dst. + /** Draws SkBitmap bitmap stretched proportionally to fit into SkRect dst. SkIRect center divides the bitmap into nine sections: four sides, four corners, and the center. Corners are not scaled, or scaled down proportionately if their sides are larger than dst; center and four sides are scaled to fit remaining @@ -1761,7 +1760,7 @@ public: const SkColor* fColors; //!< array of colors }; - /** Draw SkBitmap bitmap stretched proportionally to fit into SkRect dst. + /** Draws SkBitmap bitmap stretched proportionally to fit into SkRect dst. SkCanvas::Lattice lattice divides bitmap into a rectangular grid. Each intersection of an even-numbered row and column is fixed; like the corners @@ -1792,7 +1791,7 @@ public: void drawBitmapLattice(const SkBitmap& bitmap, const Lattice& lattice, const SkRect& dst, const SkPaint* paint = nullptr); - /** Draw SkImage image stretched proportionally to fit into SkRect dst. + /** Draws SkImage image stretched proportionally to fit into SkRect dst. SkCanvas::Lattice lattice divides image into a rectangular grid. Each intersection of an even-numbered row and column is fixed; like the corners @@ -1823,7 +1822,7 @@ public: void drawImageLattice(const SkImage* image, const Lattice& lattice, const SkRect& dst, const SkPaint* paint = nullptr); - /** Draw text, with origin at (x, y), using clip, SkMatrix, and SkPaint paint. + /** Draws text, with origin at (x, y), using clip, SkMatrix, and SkPaint paint. text meaning depends on SkPaint::TextEncoding; by default, text is encoded as UTF-8. @@ -1873,7 +1872,7 @@ public: this->drawText(string, strlen(string), x, y, paint); } - /** Draw null terminated string, with origin at (x, y), using clip, SkMatrix, and + /** Draws null terminated string, with origin at (x, y), using clip, SkMatrix, and SkPaint paint. string meaning depends on SkPaint::TextEncoding; by default, strings are encoded @@ -1896,7 +1895,7 @@ public: */ void drawString(const SkString& string, SkScalar x, SkScalar y, const SkPaint& paint); - /** Draw each glyph in text with the origin in pos array, using clip, SkMatrix, and + /** Draws each glyph in text with the origin in pos array, using clip, SkMatrix, and SkPaint paint. The number of entries in pos array must match the number of glyphs described by byteLength of text. @@ -1920,7 +1919,7 @@ public: void drawPosText(const void* text, size_t byteLength, const SkPoint pos[], const SkPaint& paint); - /** Draw each glyph in text with its (x, y) origin composed from xpos array and + /** Draws each glyph in text with its (x, y) origin composed from xpos array and constY, using clip, SkMatrix, and SkPaint paint. The number of entries in xpos array must match the number of glyphs described by byteLength of text. @@ -1947,7 +1946,7 @@ public: void drawPosTextH(const void* text, size_t byteLength, const SkScalar xpos[], SkScalar constY, const SkPaint& paint); - /** Draw text on SkPath path, using clip, SkMatrix, and SkPaint paint. + /** Draws text on SkPath path, using clip, SkMatrix, and SkPaint paint. Origin of text is at distance hOffset along the path, offset by a perpendicular vector of length vOffset. If the path section corresponding the glyph advance is @@ -1974,7 +1973,7 @@ public: void drawTextOnPathHV(const void* text, size_t byteLength, const SkPath& path, SkScalar hOffset, SkScalar vOffset, const SkPaint& paint); - /** Draw text on SkPath path, using clip, SkMatrix, and SkPaint paint. + /** Draws text on SkPath path, using clip, SkMatrix, and SkPaint paint. Origin of text is at beginning of path offset by matrix, if not nullptr. matrix transforms text before text is mapped to path. If the path section @@ -2004,7 +2003,7 @@ public: void drawTextOnPath(const void* text, size_t byteLength, const SkPath& path, const SkMatrix* matrix, const SkPaint& paint); - /** Draw text, transforming each glyph by the corresponding SkRSXform, + /** Draws text, transforming each glyph by the corresponding SkRSXform, using clip, SkMatrix, and SkPaint paint. SkRSXform xform array specifies a separate square scale, rotation, and translation @@ -2026,7 +2025,7 @@ public: void drawTextRSXform(const void* text, size_t byteLength, const SkRSXform xform[], const SkRect* cullRect, const SkPaint& paint); - /** Draw SkTextBlob blob at (x, y), using clip, SkMatrix, and SkPaint paint. + /** Draws SkTextBlob blob at (x, y), using clip, SkMatrix, and SkPaint paint. blob contains glyphs, their positions, and paint attributes specific to text: SkTypeface, SkPaint text size, SkPaint text scale x, SkPaint text skew x, @@ -2046,7 +2045,7 @@ public: */ void drawTextBlob(const SkTextBlob* blob, SkScalar x, SkScalar y, const SkPaint& paint); - /** Draw SkTextBlob blob at (x, y), using clip, SkMatrix, and SkPaint paint. + /** Draws SkTextBlob blob at (x, y), using clip, SkMatrix, and SkPaint paint. blob contains glyphs, their positions, and paint attributes specific to text: SkTypeface, SkPaint text size, SkPaint text scale x, SkPaint text skew x, @@ -2068,7 +2067,7 @@ public: this->drawTextBlob(blob.get(), x, y, paint); } - /** Draw SkPicture picture, using clip and SkMatrix. + /** Draws SkPicture picture, using clip and SkMatrix. Clip and SkMatrix are unchanged by picture contents, as if save() was called before and restore() was called after drawPicture(). @@ -2080,7 +2079,7 @@ public: this->drawPicture(picture, nullptr, nullptr); } - /** Draw SkPicture picture, using clip and SkMatrix. + /** Draws SkPicture picture, using clip and SkMatrix. Clip and SkMatrix are unchanged by picture contents, as if save() was called before and restore() was called after drawPicture(). @@ -2092,7 +2091,7 @@ public: this->drawPicture(picture.get()); } - /** Draw SkPicture picture, using clip and SkMatrix; transforming picture with + /** Draws SkPicture picture, using clip and SkMatrix; transforming picture with SkMatrix matrix, if provided; and use SkPaint paint alpha, SkColorFilter, SkImageFilter, and SkBlendMode, if provided. @@ -2105,7 +2104,7 @@ public: */ void drawPicture(const SkPicture* picture, const SkMatrix* matrix, const SkPaint* paint); - /** Draw SkPicture picture, using clip and SkMatrix; transforming picture with + /** Draws SkPicture picture, using clip and SkMatrix; transforming picture with SkMatrix matrix, if provided; and use SkPaint paint alpha, SkColorFilter, SkImageFilter, and SkBlendMode, if provided. @@ -2120,7 +2119,7 @@ public: this->drawPicture(picture.get(), matrix, paint); } - /** Draw SkVertices vertices, a triangle mesh, using clip and SkMatrix. + /** Draws SkVertices vertices, a triangle mesh, using clip and SkMatrix. If vertices texs and vertices colors are defined in vertices, and SkPaint paint contains SkShader, SkBlendMode mode combines vertices colors with SkShader. @@ -2130,7 +2129,7 @@ public: */ void drawVertices(const SkVertices* vertices, SkBlendMode mode, const SkPaint& paint); - /** Draw SkVertices vertices, a triangle mesh, using clip and SkMatrix. + /** Draws SkVertices vertices, a triangle mesh, using clip and SkMatrix. If vertices texs and vertices colors are defined in vertices, and SkPaint paint contains SkShader, SkBlendMode mode combines vertices colors with SkShader. @@ -2140,7 +2139,7 @@ public: */ void drawVertices(const sk_sp<SkVertices>& vertices, SkBlendMode mode, const SkPaint& paint); - /** Draw SkVertices vertices, a triangle mesh, using clip and SkMatrix. Bone data is used to + /** Draws SkVertices vertices, a triangle mesh, using clip and SkMatrix. Bone data is used to deform vertices with bone weights. If vertices texs and vertices colors are defined in vertices, and SkPaint paint contains SkShader, SkBlendMode mode combines vertices colors with SkShader. @@ -2158,7 +2157,7 @@ public: void drawVertices(const SkVertices* vertices, const SkMatrix* bones, int boneCount, SkBlendMode mode, const SkPaint& paint); - /** Draw SkVertices vertices, a triangle mesh, using clip and SkMatrix. Bone data is used to + /** Draws SkVertices vertices, a triangle mesh, using clip and SkMatrix. Bone data is used to deform vertices with bone weights. If vertices texs and vertices colors are defined in vertices, and SkPaint paint contains SkShader, SkBlendMode mode combines vertices colors with SkShader. @@ -2233,7 +2232,7 @@ public: this->drawPatch(cubics, colors, texCoords, SkBlendMode::kModulate, paint); } - /** Draw a set of sprites from atlas, using clip, SkMatrix, and optional SkPaint paint. + /** Draws a set of sprites from atlas, using clip, SkMatrix, and optional SkPaint paint. paint uses anti-alias, alpha, SkColorFilter, SkImageFilter, and SkBlendMode to draw, if present. For each entry in the array, SkRect tex locates sprite in atlas, and SkRSXform xform transforms it into destination space. @@ -2257,7 +2256,7 @@ public: const SkColor colors[], int count, SkBlendMode mode, const SkRect* cullRect, const SkPaint* paint); - /** Draw a set of sprites from atlas, using clip, SkMatrix, and optional SkPaint paint. + /** Draws a set of sprites from atlas, using clip, SkMatrix, and optional SkPaint paint. paint uses anti-alias, alpha, SkColorFilter, SkImageFilter, and SkBlendMode to draw, if present. For each entry in the array, SkRect tex locates sprite in atlas, and SkRSXform xform transforms it into destination space. @@ -2282,7 +2281,7 @@ public: this->drawAtlas(atlas.get(), xform, tex, colors, count, mode, cullRect, paint); } - /** Draw a set of sprites from atlas, using clip, SkMatrix, and optional SkPaint paint. + /** Draws a set of sprites from atlas, using clip, SkMatrix, and optional SkPaint paint. paint uses anti-alias, alpha, SkColorFilter, SkImageFilter, and SkBlendMode to draw, if present. For each entry in the array, SkRect tex locates sprite in atlas, and SkRSXform xform transforms it into destination space. @@ -2303,7 +2302,7 @@ public: this->drawAtlas(atlas, xform, tex, nullptr, count, SkBlendMode::kDst, cullRect, paint); } - /** Draw a set of sprites from atlas, using clip, SkMatrix, and optional SkPaint paint. + /** Draws a set of sprites from atlas, using clip, SkMatrix, and optional SkPaint paint. paint uses anti-alias, alpha, SkColorFilter, SkImageFilter, and SkBlendMode to draw, if present. For each entry in the array, SkRect tex locates sprite in atlas, and SkRSXform xform transforms it into destination space. @@ -2325,7 +2324,7 @@ public: cullRect, paint); } - /** Draw SkDrawable drawable using clip and SkMatrix, concatenated with + /** Draws SkDrawable drawable using clip and SkMatrix, concatenated with optional matrix. If SkCanvas has an asynchronous implementation, as is the case @@ -2338,7 +2337,7 @@ public: */ void drawDrawable(SkDrawable* drawable, const SkMatrix* matrix = nullptr); - /** Draw SkDrawable drawable using clip and SkMatrix, offset by (x, y). + /** Draws SkDrawable drawable using clip and SkMatrix, offset by (x, y). If SkCanvas has an asynchronous implementation, as is the case when it is recording into SkPicture, then drawable will be referenced, @@ -2351,7 +2350,7 @@ public: */ void drawDrawable(SkDrawable* drawable, SkScalar x, SkScalar y); - /** Associate SkRect on SkCanvas with an annotation; a key-value pair, where the key is + /** Associates SkRect on SkCanvas with an annotation; a key-value pair, where the key is a null-terminated utf8 string, and optional value is stored as SkData. Only some canvas implementations, such as recording to SkPicture, or drawing to @@ -2363,7 +2362,7 @@ public: */ void drawAnnotation(const SkRect& rect, const char key[], SkData* value); - /** Associate SkRect on SkCanvas when an annotation; a key-value pair, where the key is + /** Associates SkRect on SkCanvas when an annotation; a key-value pair, where the key is a null-terminated utf8 string, and optional value is stored as SkData. Only some canvas implementations, such as recording to SkPicture, or drawing to @@ -2377,8 +2376,6 @@ public: this->drawAnnotation(rect, key, value.get()); } - ////////////////////////////////////////////////////////////////////////// - /** Returns true if clip is empty; that is, nothing will draw. May do work when called; it should not be called |