diff options
| author |  Cary Clark <caryclark@skia.org> | 2018-07-11 16:18:41 -0400 |
|---|---|---|
| committer |  Skia Commit-Bot <skia-commit-bot@chromium.org> | 2018-07-11 21:21:28 +0000 |
| commit | 80247e594d1fb168e11a19ce6a73a7e7169ec1f5 (patch) | |
| tree | 005fe49ae8985ff6b80e73c71fd255220501c199 /docs/SkBitmap_Reference.bmh | |
| parent | 8885550dbc1972311cdf8f08b6fc8c0778fc1d33 (diff) | |
Publish docs for rrect, picture, blendmode
Complete basic docs for SkRRect, SkPicture, SkBlendMode.
Add a new rule that checks the main description tense.
Check for spelling errors.
R=caryclark@google.com
Docs-Preview: https://skia.org/?cl=138542
Bug: skia:6898
Change-Id: Iba547873775a89f1d652be9b0219b84ffa8d0628
Reviewed-on: https://skia-review.googlesource.com/138542
Commit-Queue: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
Diffstat (limited to 'docs/SkBitmap_Reference.bmh')
| -rw-r--r-- | docs/SkBitmap_Reference.bmh | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/docs/SkBitmap_Reference.bmh b/docs/SkBitmap_Reference.bmh index ab9d7c8730..d57f0b85b8 100644 --- a/docs/SkBitmap_Reference.bmh +++ b/docs/SkBitmap_Reference.bmh @@ -471,7 +471,7 @@ rowBytes() / info().bytesPerPixel() ## . -Maybe be less than pixelRef().width(). Will not exceed pixelRef().width() less +May be less than pixelRef().width(). Will not exceed pixelRef().width() less pixelRefOrigin().fX. #Return pixel width in Image_Info ## @@ -777,7 +777,7 @@ width: 2 height: 2 empty: false #Method bool isNull() const #In Property #Line # returns true if Pixel_Ref is nullptr ## -Return true if Pixel_Ref is nullptr. +Returns true if Pixel_Ref is nullptr. Does not check if width() or height() are zero; call drawsNothing to check width(), height(), and Pixel_Ref. @@ -807,7 +807,7 @@ allocated bitmap does have pixels #Method bool drawsNothing() const #In Property #Line # returns true if no width(), no height(), or no Pixel_Ref ## -Return true if width() or height() are zero, or if Pixel_Ref is nullptr. +Returns true if width() or height() are zero, or if Pixel_Ref is nullptr. If true, Bitmap has no effect when drawn or drawn into. #Return true if drawing has no effect ## @@ -1108,8 +1108,8 @@ isOpaque: true #Method bool isVolatile() const #In Property #Line # returns true if pixels should not be cached ## -If true, provides a hint to caller that pixels should not -be cached. Only true if setIsVolatile has been called to mark as volatile. +Provides a hint to caller that pixels should not be cached. Only true if +setIsVolatile has been called to mark as volatile. Volatile state is not shared by other bitmaps sharing the same Pixel_Ref. @@ -1404,6 +1404,7 @@ Calls reset() and returns false if: # imageInfo.height() is negative ## # rowBytes is positive and less than imageInfo.width() times imageInfo.bytesPerPixel ## ## +. #Param imageInfo contains width, height, Alpha_Type, Color_Type, Color_Space ## #Param rowBytes imageInfo.minRowBytes or larger; or zero ## @@ -2572,6 +2573,7 @@ Input is not validated. Triggers an assert() if built with SK_DEBUG defined and: # x is negative, or not less than width() ## # y is negative, or not less than height() ## ## +. #Param x column index, zero or greater, and less than width() ## #Param y row index, zero or greater, and less than height() ## @@ -2607,6 +2609,7 @@ Input is not validated. Triggers an assert() if built with SK_DEBUG defined and: # x is negative, or not less than width() ## # y is negative, or not less than height() ## ## +. #Param x column index, zero or greater, and less than width() ## #Param y row index, zero or greater, and less than height() ## @@ -2648,6 +2651,7 @@ Input is not validated. Triggers an assert() if built with SK_DEBUG defined and: # x is negative, or not less than width() ## # y is negative, or not less than height() ## ## +. #Param x column index, zero or greater, and less than width() ## #Param y row index, zero or greater, and less than height() ## @@ -2693,7 +2697,7 @@ Return false if: # Pixel_Ref is nullptr ## # subset does not intersect bounds() ## ## - +. #Param dst Bitmap set to subset ## #Param subset rectangle of pixels to reference ## @@ -2759,6 +2763,7 @@ row to the next. Returns true if pixels are copied. Returns false if: # dstRowBytes is less than dstInfo.minRowBytes ## # Pixel_Ref is nullptr ## ## +. Pixels are copied only if pixel conversion is possible. If Bitmap colorType is kGray_8_SkColorType, or kAlpha_8_SkColorType; dstInfo.colorType must match. |