From 5538c1390649811eb6498eeca53cc1db00877503 Mon Sep 17 00:00:00 2001 From: Cary Clark Date: Thu, 14 Jun 2018 12:28:14 -0400 Subject: docs fix external substitutions explict substitutions are required to distiguish words that preserve underscores R=caryclark@google.com Docs-Preview: https://skia.org/?cl=134841 Bug: skia:6898 Change-Id: Id1a5669c180e03e048de3c0251882bd06b297283 Reviewed-on: https://skia-review.googlesource.com/134841 Reviewed-by: Cary Clark Commit-Queue: Cary Clark Auto-Submit: Cary Clark --- docs/SkCanvas_Reference.bmh | 83 +++++++++++------------ docs/SkIRect_Reference.bmh | 34 +++++----- docs/SkImage_Reference.bmh | 18 ++--- docs/SkMatrix_Reference.bmh | 96 +++++++++++++-------------- docs/SkPaint_Reference.bmh | 18 ++--- docs/SkPath_Reference.bmh | 110 +++++++++++++++---------------- docs/SkPoint_Reference.bmh | 2 +- docs/SkRect_Reference.bmh | 26 ++++---- docs/SkSurface_Reference.bmh | 20 +++--- docs/undocumented.bmh | 112 +++++++++++++++++++++++++++++-- site/user/api/SkBitmap_Reference.md | 8 +-- site/user/api/SkCanvas_Reference.md | 95 ++++++++++++++------------- site/user/api/SkColor_Reference.md | 16 ++--- site/user/api/SkIRect_Reference.md | 34 +++++----- site/user/api/SkImageInfo_Reference.md | 12 ++-- site/user/api/SkImage_Reference.md | 34 +++++----- site/user/api/SkMatrix_Reference.md | 98 ++++++++++++++-------------- site/user/api/SkPaint_Reference.md | 18 ++--- site/user/api/SkPath_Reference.md | 116 ++++++++++++++++----------------- site/user/api/SkPoint_Reference.md | 10 +-- site/user/api/SkRect_Reference.md | 26 ++++---- site/user/api/SkSurface_Reference.md | 30 ++++----- site/user/api/undocumented.md | 45 +++++++++++++ tools/bookmaker/includeWriter.cpp | 4 -- tools/bookmaker/mdOut.cpp | 4 +- tools/bookmaker/spellCheck.cpp | 38 +++++------ 26 files changed, 622 insertions(+), 485 deletions(-) diff --git a/docs/SkCanvas_Reference.bmh b/docs/SkCanvas_Reference.bmh index ddf081cb1f..c026ffe649 100644 --- a/docs/SkCanvas_Reference.bmh +++ b/docs/SkCanvas_Reference.bmh @@ -948,8 +948,8 @@ Does not copy, and returns false if: #Param dstInfo width, height, Color_Type, and Alpha_Type of dstPixels ## #Param dstPixels storage for pixels; dstInfo.height() times dstRowBytes, or larger ## #Param dstRowBytes size of one destination row; dstInfo.width() times pixel size, or larger ## -#Param srcX offset into readable pixels in x; may be negative ## -#Param srcY offset into readable pixels in y; may be negative ## +#Param srcX offset into readable pixels on x-axis; may be negative ## +#Param srcY offset into readable pixels on y-axis; may be negative ## #Return true if pixels were copied ## @@ -1039,8 +1039,8 @@ Does not copy, and returns false if: ## #Param pixmap storage for pixels copied from Canvas ## -#Param srcX offset into readable pixels in x; may be negative ## -#Param srcY offset into readable pixels in y; may be negative ## +#Param srcX offset into readable pixels on x-axis; may be negative ## +#Param srcY offset into readable pixels on y-axis; may be negative ## #Return true if pixels were copied ## @@ -1102,8 +1102,8 @@ Does not copy, and returns false if: ## #Param bitmap storage for pixels copied from Canvas ## -#Param srcX offset into readable pixels in x; may be negative ## -#Param srcY offset into readable pixels in y; may be negative ## +#Param srcX offset into readable pixels on x-axis; may be negative ## +#Param srcY offset into readable pixels on y-axis; may be negative ## #Return true if pixels were copied ## @@ -1167,8 +1167,8 @@ Does not copy, and returns false if: #Param info width, height, Color_Type, and Alpha_Type of pixels ## #Param pixels pixels to copy, of size info.height() times rowBytes, or larger ## #Param rowBytes size of one row of pixels; info.width() times pixel size, or larger ## -#Param x offset into Canvas writable pixels in x; may be negative ## -#Param y offset into Canvas writable pixels in y; may be negative ## +#Param x offset into Canvas writable pixels on x-axis; may be negative ## +#Param y offset into Canvas writable pixels on y-axis; may be negative ## #Return true if pixels were written to Canvas ## @@ -2151,8 +2151,8 @@ This has the effect of rotating the drawing about a given point before transforming the result with Matrix. #Param degrees amount to rotate, in degrees ## -#Param px x-coordinate of the point to rotate about ## -#Param py y-coordinate of the point to rotate about ## +#Param px x-axis value of the point to rotate about ## +#Param py y-axis value of the point to rotate about ## #Example #Height 192 @@ -2176,24 +2176,24 @@ void draw(SkCanvas* canvas) { #In Matrix #Line # skews Matrix ## Skew Matrix by sx on the x-axis and sy on the y-axis. A positive value of sx -skews the drawing right as y increases; a positive value of sy skews the drawing -down as x increases. +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 Matrix with a skew matrix Premultiplied with Matrix. This has the effect of skewing the drawing by (sx, sy) before transforming the result with Matrix. -#Param sx amount to skew in x ## -#Param sy amount to skew in y ## +#Param sx amount to skew on x-axis ## +#Param sy amount to skew on y-axis ## #Example #Description - Black text mimics an oblique text style by using a negative skew in x that - shifts the geometry to the right as the y values decrease. - Red text uses a positive skew in y to shift the geometry down as the x values - increase. - Blue text combines x and y skew to rotate and scale. + Black text mimics an oblique text style by using a negative skew on x-axis + that shifts the geometry to the right as the y-axis values decrease. + Red text uses a positive skew on y-axis to shift the geometry down + as the x-axis values increase. + Blue text combines sx and sy skew to rotate and scale. ## SkPaint paint; paint.setTextSize(128); @@ -2858,7 +2858,8 @@ is Anti_Aliased. #Description Initial bounds is device bounds outset by 1 on all sides. Clipped bounds is clipPath bounds outset by 1 on all sides. - Scaling the canvas by two in x and y scales the local bounds by 1/2 in x and y. + Scaling the canvas by two on both axes scales the local bounds by 1/2 + on both axes. ## SkCanvas local(256, 256); canvas = &local; @@ -2942,7 +2943,8 @@ void draw(SkCanvas* canvas) { #Description Initial bounds is device bounds, not outset. Clipped bounds is clipPath bounds, not outset. - Scaling the canvas by 1/2 in x and y scales the device bounds by 1/2 in x and y. + Scaling the canvas by 1/2 on both axes scales the device bounds by 1/2 + on both axes. ## SkCanvas device(256, 256); canvas = &device; @@ -3751,8 +3753,8 @@ If rx and ry are zero, Round_Rect is drawn as Rect and if stroked is affected by Paint_Stroke_Join. #Param rect Rect bounds of Round_Rect to draw ## -#Param rx axis length in x of oval describing rounded corners ## -#Param ry axis length in y of oval describing rounded corners ## +#Param rx axis length on x-axis of oval describing rounded corners ## +#Param ry axis length on y-axis of oval describing rounded corners ## #Param paint stroke, blend, color, and so on, used to draw ## #Example @@ -4827,8 +4829,8 @@ remaining space, if any. ## #Member const int* fXDivs - #Line # x-coordinates dividing bitmap ## - Array of x-coordinates that divide the bitmap vertically. + #Line # x-axis values dividing bitmap ## + Array of x-axis values that divide the bitmap vertically. Array entries must be unique, increasing, greater than or equal to fBounds left edge, and less than fBounds right edge. Set the first element to fBounds left to collapse the left column of @@ -4836,8 +4838,8 @@ remaining space, if any. ## #Member const int* fYDivs - #Line # y-coordinates dividing bitmap ## - Array of y-coordinates that divide the bitmap horizontally. + #Line # y-axis values dividing bitmap ## + Array of y-axis values that divide the bitmap horizontally. Array entries must be unique, increasing, greater than or equal to fBounds top edge, and less than fBounds bottom edge. Set the first element to fBounds top to collapse the top row of fixed @@ -5191,10 +5193,9 @@ Paint paint. The number of entries in pos array must match the number of Glyphs described by byteLength of text. text meaning depends on Paint_Text_Encoding; by default, text is encoded as -UTF-8. pos elements meaning depends on Paint_Vertical_Text; -by default each glyph left side bearing is positioned at x and its -baseline is positioned at y. Text size is affected by Matrix and -Paint_Text_Size. +UTF-8. pos elements meaning depends on Paint_Vertical_Text; by default +glyph left side bearing and baseline are relative to Point in pos array. +Text size is affected by Matrix and Paint_Text_Size. All elements of paint: Path_Effect, Mask_Filter, Shader, Color_Filter, Image_Filter, and Draw_Looper; apply to text. By default, draws @@ -5252,8 +5253,8 @@ baseline. #Param text character code points or Glyphs drawn ## #Param byteLength byte length of text array ## -#Param xpos array of x positions, used to position each glyph ## -#Param constY shared y coordinate for all of x positions ## +#Param xpos array of x-axis positions, used to position each glyph ## +#Param constY shared y-axis value for all of x-axis positions ## #Param paint text size, blend, color, and so on, used to draw ## #Example @@ -5287,8 +5288,8 @@ than the path length, the excess text is clipped. text meaning depends on Paint_Text_Encoding; by default, text is encoded as UTF-8. Origin meaning depends on Paint_Text_Align and Paint_Vertical_Text; by -default text positions the first glyph left side bearing at origin x and its -baseline at origin y. Text size is affected by Matrix and Paint_Text_Size. +default text positions the first glyph left side bearing and baseline relative +to origin. Text size is affected by Matrix and Paint_Text_Size. All elements of paint: Path_Effect, Mask_Filter, Shader, Color_Filter, Image_Filter, and Draw_Looper; apply to text. By default, draws @@ -5340,8 +5341,8 @@ matrix does not effect paint Shader. text meaning depends on Paint_Text_Encoding; by default, text is encoded as UTF-8. Origin meaning depends on Paint_Text_Align and Paint_Vertical_Text; by -default text positions the first glyph left side bearing at origin x and its -baseline at origin y. Text size is affected by matrix parameter, Canvas Matrix, +default text positions the first glyph left side bearing and baseline relative +to origin. Text size is affected by matrix parameter, Canvas Matrix, and Paint_Text_Size. All elements of paint: Path_Effect, Mask_Filter, Shader, @@ -5756,7 +5757,7 @@ void draw(SkCanvas* canvas) { #Line # draws Coons_Patch ## Draws a Coons_Patch: the interpolation of four cubics with shared corners, -associating a color, and optionally a texture coordinate, with each corner. +associating a color, and optionally a texture Point, with each corner. Coons_Patch uses Clip and Matrix, paint Shader, Color_Filter, Color_Alpha, Image_Filter, and Blend_Mode. If Shader is provided it is treated @@ -5815,7 +5816,7 @@ void draw(SkCanvas* canvas) { const SkPoint texCoords[4], const SkPaint& paint) Draws Cubic Coons_Patch: the interpolation of four cubics with shared corners, -associating a color, and optionally a texture coordinate, with each corner. +associating a color, and optionally a texture Point, with each corner. Coons_Patch uses Clip and Matrix, paint Shader, Color_Filter, Color_Alpha, Image_Filter, and Blend_Mode. If Shader is provided it is treated @@ -6108,8 +6109,8 @@ so that SkDrawable::draw() can be called when the operation is finalized. To for immediate drawing, call SkDrawable::draw() instead. #Param drawable custom struct encapsulating drawing commands ## -#Param x offset into Canvas writable pixels in x ## -#Param y offset into Canvas writable pixels in y ## +#Param x offset into Canvas writable pixels on x-axis ## +#Param y offset into Canvas writable pixels on y-axis ## #Example #Height 100 diff --git a/docs/SkIRect_Reference.bmh b/docs/SkIRect_Reference.bmh index f3c269b294..bcca39e35b 100644 --- a/docs/SkIRect_Reference.bmh +++ b/docs/SkIRect_Reference.bmh @@ -790,7 +790,7 @@ If dy is positive, IRect returned is moved downward. #Param dx offset added to fLeft and fRight ## #Param dy offset added to fTop and fBottom ## -#Return IRect offset in x or y, with original width and height ## +#Return IRect offset by dx and dy, with original width and height ## #Example SkIRect rect = { 10, 50, 20, 60 }; @@ -1129,10 +1129,10 @@ construction. Returns true if IRect contains construction. Returns false if IRect is empty or construction is empty. -#Param left x minimum of constructed IRect ## -#Param top y minimum of constructed IRect ## -#Param right x maximum of constructed IRect ## -#Param bottom y maximum of constructed IRect ## +#Param left x-axis minimum of constructed IRect ## +#Param top y-axis minimum of constructed IRect ## +#Param right x-axis maximum of constructed IRect ## +#Param bottom y-axis maximum of constructed IRect ## #Return true if all sides of IRect are outside construction ## @@ -1241,10 +1241,10 @@ Asserts if IRect is empty or construction is empty, and if SK_DEBUG is defined. Return is undefined if IRect is empty or construction is empty. -#Param left x minimum of constructed IRect ## -#Param top y minimum of constructed IRect ## -#Param right x maximum of constructed IRect ## -#Param bottom y maximum of constructed IRect ## +#Param left x-axis minimum of constructed IRect ## +#Param top y-axis minimum of constructed IRect ## +#Param right x-axis maximum of constructed IRect ## +#Param bottom y-axis maximum of constructed IRect ## #Return true if all sides of IRect are outside construction ## @@ -1412,10 +1412,10 @@ Returns false if IRect does not intersect construction, and leaves IRect unchang Returns false if either construction or IRect is empty, leaving IRect unchanged. -#Param left x minimum of constructed IRect ## -#Param top y minimum of constructed IRect ## -#Param right x maximum of constructed IRect ## -#Param bottom y maximum of constructed IRect ## +#Param left x-axis minimum of constructed IRect ## +#Param top y-axis minimum of constructed IRect ## +#Param right x-axis maximum of constructed IRect ## +#Param bottom y-axis maximum of constructed IRect ## #Return true if construction and IRect have area in common ## @@ -1510,10 +1510,10 @@ Sets IRect to the union of itself and the construction. Has no effect if construction is empty. Otherwise, if IRect is empty, sets IRect to construction. -#Param left x minimum of constructed IRect ## -#Param top y minimum of constructed IRect ## -#Param right x maximum of constructed IRect ## -#Param bottom y maximum of constructed IRect ## +#Param left x-axis minimum of constructed IRect ## +#Param top y-axis minimum of constructed IRect ## +#Param right x-axis maximum of constructed IRect ## +#Param bottom y-axis maximum of constructed IRect ## #Example SkIRect rect = { 10, 20, 15, 25}; diff --git a/docs/SkImage_Reference.bmh b/docs/SkImage_Reference.bmh index c63be58f72..002e529819 100644 --- a/docs/SkImage_Reference.bmh +++ b/docs/SkImage_Reference.bmh @@ -1132,11 +1132,11 @@ Creates Shader from Image. Shader dimensions are taken from Image. Shader uses SkShader::TileMode rules to fill drawn area outside Image. localMatrix permits transforming Image before Canvas_Matrix is applied. -#Param tileMode1 tiling in x, one of: SkShader::kClamp_TileMode, SkShader::kRepeat_TileMode, - SkShader::kMirror_TileMode +#Param tileMode1 tiling on x-axis, one of: SkShader::kClamp_TileMode, + SkShader::kRepeat_TileMode, SkShader::kMirror_TileMode ## -#Param tileMode2 tiling in y, one of: SkShader::kClamp_TileMode, SkShader::kRepeat_TileMode, - SkShader::kMirror_TileMode +#Param tileMode2 tiling on y-axis, one of: SkShader::kClamp_TileMode, + SkShader::kRepeat_TileMode, SkShader::kMirror_TileMode ## #Param localMatrix Image transformation, or nullptr ## @@ -1779,17 +1779,17 @@ pixels in Image could not be read or copied. #In Constructor #Line # creates Image matching Color_Space if possible ## Returns Image backed by GPU_Texture associated with context. Returned Image is -compatible with Surface created with dstColorSpace. The returned Image will also -support the request GrMipMapped status. In other words if mipMapped is GrMipMapped::kYes, -then the backing texture will have Mip_Map levels allocated. Returns original Image if context -and dstColorSpace match and mipMapped is compatible with the backing GPU_Texture. +compatible with Surface created with dstColorSpace. The returned Image respects +mipMapped setting; if mipMapped equals GrMipMapped::kYes, the backing texture +allocates Mip_Map levels. Returns original Image if context +and dstColorSpace match and mipMapped is compatible with backing GPU_Texture. Returns nullptr if context is nullptr, or if Image was created with another GrContext. #Param context GPU_Context ## #Param dstColorSpace range of colors of matching Surface on GPU ## -#Param mipMapped whether the returned SkImage's texture must have allocated Mip_Map levels ## +#Param mipMapped whether created Image texture must allocate Mip_Map levels ## #Return created Image, or nullptr ## diff --git a/docs/SkMatrix_Reference.bmh b/docs/SkMatrix_Reference.bmh index 1211588195..52c301a18e 100644 --- a/docs/SkMatrix_Reference.bmh +++ b/docs/SkMatrix_Reference.bmh @@ -143,8 +143,8 @@ Sets Matrix to: #Param skewY vertical skew factor ## #Param scaleY vertical scale factor ## #Param transY vertical translation ## -#Param pers0 input x perspective factor ## -#Param pers1 input y perspective factor ## +#Param pers0 input x-axis perspective factor ## +#Param pers1 input y-axis perspective factor ## #Param pers2 perspective scale factor ## #Return Matrix constructed from parameters ## @@ -386,7 +386,7 @@ is translate: false #In Property #Line # returns if mapped Rect can be represented by another Rect ## Returns true Matrix maps Rect to another Rect. If true, Matrix is identity, -or scales, or rotates a multiple of 90 degrees, or mirrors in x or y. In all +or scales, or rotates a multiple of 90 degrees, or mirrors on axes. In all cases, Matrix may also have translation. Matrix form is either: #Code @@ -437,7 +437,7 @@ rectStaysRect: true #Line # returns if mapping restricts to 90 degree multiples and mirroring ## Returns true Matrix maps Rect to another Rect. If true, Matrix is identity, -or scales, or rotates a multiple of 90 degrees, or mirrors in x or y. In all +or scales, or rotates a multiple of 90 degrees, or mirrors on axes. In all cases, Matrix may also have translation. Matrix form is either: #Code @@ -806,7 +806,7 @@ matrix.get(SkMatrix::kMSkewY) == 24 #Method SkScalar getScaleX() const #In Property #Line # returns horizontal scale factor ## -Returns scale factor multiplied by x input, contributing to x output. +Returns scale factor multiplied by x-axis input, contributing to x-axis output. With mapPoints, scales Points along the x-axis. #Return horizontal scale factor ## @@ -829,7 +829,7 @@ matrix.getScaleX() == 42 #Method SkScalar getScaleY() const #In Property #Line # returns vertical scale factor ## -Returns scale factor multiplied by y input, contributing to y output. +Returns scale factor multiplied by y-axis input, contributing to y-axis output. With mapPoints, scales Points along the y-axis. #Return vertical scale factor ## @@ -852,9 +852,9 @@ matrix.getScaleY() == 24 #Method SkScalar getSkewY() const #In Property #Line # returns vertical skew factor ## -Returns scale factor multiplied by x input, contributing to y output. +Returns scale factor multiplied by x-axis input, contributing to y-axis output. With mapPoints, skews Points along the y-axis. -Skew x and y together can rotate Points. +Skewing both axes can rotate Points. #Return vertical skew factor ## @@ -876,9 +876,9 @@ matrix.getSkewY() == 24 #Method SkScalar getSkewX() const #In Property #Line # returns horizontal skew factor ## -Returns scale factor multiplied by y input, contributing to x output. +Returns scale factor multiplied by y-axis input, contributing to x-axis output. With mapPoints, skews Points along the x-axis. -Skew x and y together can rotate Points. +Skewing both axes can rotate Points. #Return horizontal scale factor ## @@ -900,7 +900,7 @@ matrix.getSkewX() == 42 #Method SkScalar getTranslateX() const #In Property #Line # returns horizontal translation ## -Returns translation contributing to x output. +Returns translation contributing to x-axis output. With mapPoints, moves Points along the x-axis. #Return horizontal translation factor ## @@ -923,7 +923,7 @@ matrix.getTranslateX() == 42 #Method SkScalar getTranslateY() const #In Property #Line # returns vertical translation ## -Returns translation contributing to y output. +Returns translation contributing to y-axis output. With mapPoints, moves Points along the y-axis. #Return vertical translation factor ## @@ -946,9 +946,9 @@ matrix.getTranslateY() == 24 #Method SkScalar getPerspX() const #In Property #Line # returns input x perspective factor ## -Returns factor scaling input x relative to input y. +Returns factor scaling input x-axis relative to input y-axis. -#Return input x perspective factor ## +#Return input x-axis perspective factor ## #Example SkMatrix m; @@ -978,9 +978,9 @@ Returns factor scaling input x relative to input y. #In Property #Line # returns input y perspective factor ## -Returns factor scaling input y relative to input x. +Returns factor scaling input y-axis relative to input x-axis. -#Return input y perspective factor ## +#Return input y-axis perspective factor ## #Example SkMatrix m; @@ -1241,8 +1241,8 @@ canvas->drawString("y translate", 8, 24, paint); #Method void setPerspX(SkScalar v) #In Set #Line # sets input x perspective factor ## -Sets input x perspective factor, which causes mapXY to vary input x inversely -proportional to input y. +Sets input x-axis perspective factor, which causes mapXY to vary input x-axis values +inversely proportional to input y-axis values. #Param v perspective factor ## @@ -1269,8 +1269,8 @@ for (SkScalar perspX : { -.003f, 0.f, .003f, .012f } ) { #Method void setPerspY(SkScalar v) #In Set #Line # sets input y perspective factor ## -Sets input y perspective factor, which causes mapXY to vary input y inversely -proportional to input x. +Sets input y-axis perspective factor, which causes mapXY to vary input y-axis values +inversely proportional to input x-axis values. #Param v perspective factor ## @@ -1315,8 +1315,8 @@ Sets all values from parameters. Sets matrix to: #Param skewY vertical skew factor to store ## #Param scaleY vertical scale factor to store ## #Param transY vertical translation to store ## -#Param persp0 input x perspective factor to store ## -#Param persp1 input y perspective factor to store ## +#Param persp0 input x-axis values perspective factor to store ## +#Param persp1 input y-axis values perspective factor to store ## #Param persp2 perspective scale factor to store ## #Example @@ -1659,10 +1659,10 @@ The pivot point is unchanged when mapped with Matrix. Vector (sinValue, cosValue) describes the angle of rotation relative to (0, 1). Vector length specifies scale. -#Param sinValue rotation vector x component ## -#Param cosValue rotation vector y component ## -#Param px pivot x ## -#Param py pivot y ## +#Param sinValue rotation vector x-axis component ## +#Param cosValue rotation vector y-axis component ## +#Param px pivot x-axis ## +#Param py pivot y-axis ## #Example #Height 128 @@ -1691,8 +1691,8 @@ Sets Matrix to rotate by sinValue and cosValue, about a pivot point at (0, 0). Vector (sinValue, cosValue) describes the angle of rotation relative to (0, 1). Vector length specifies scale. -#Param sinValue rotation vector x component ## -#Param cosValue rotation vector y component ## +#Param sinValue rotation vector x-axis component ## +#Param cosValue rotation vector y-axis component ## #Example #Description @@ -1893,8 +1893,8 @@ Matrix * T(dx, dy) = | D E F | | 0 1 dy | = | D E D*dx+E*dy+F | | G H I | | 0 0 1 | | G H G*dx+H*dy+I | ## -#Param dx x translation before applying Matrix ## -#Param dy y translation before applying Matrix ## +#Param dx x-axis translation before applying Matrix ## +#Param dy y-axis translation before applying Matrix ## #Example #Height 160 @@ -2313,8 +2313,8 @@ T(dx, dy) * Matrix = | 0 1 dy | | M N O | = | M+dy*P N+dy*Q O+dy*R | | 0 0 1 | | P Q R | | P Q R | ## -#Param dx x translation after applying Matrix ## -#Param dy y translation after applying Matrix ## +#Param dx x-axis translation after applying Matrix ## +#Param dy y-axis translation after applying Matrix ## #Example #Height 160 @@ -3355,8 +3355,8 @@ Matrix * pt = |D E F| |y| = |Ax+By+C Dx+Ey+F Gx+Hy+I| = ------- , ------- |G H I| |1| Gx+Hy+I Gx+Hy+I ## -#Param x x-coordinate of Point to map ## -#Param y y-coordinate of Point to map ## +#Param x x-axis value of Point to map ## +#Param y y-axis value of Point to map ## #Param result storage for mapped Point ## #Example @@ -3400,8 +3400,8 @@ Matrix * pt = |D E F| |y| = |Ax+By+C Dx+Ey+F Gx+Hy+I| = ------- , ------- |G H I| |1| Gx+Hy+I Gx+Hy+I ## -#Param x x-coordinate of Point to map ## -#Param y y-coordinate of Point to map ## +#Param x x-axis value of Point to map ## +#Param y y-axis value of Point to map ## #Return mapped Point ## @@ -3571,8 +3571,8 @@ Matrix * vec = |D E 0| |dy| = |A*dx+B*dy D*dx+E*dy G*dx+H*dy+I| = ----------- , |G H I| | 1| G*dx+H*dy+I G*dx+*dHy+I ## -#Param dx x-coordinate of Vector to map ## -#Param dy y-coordinate of Vector to map ## +#Param dx x-axis value of Vector to map ## +#Param dy y-axis value of Vector to map ## #Param result storage for mapped Vector ## #Example @@ -3620,8 +3620,8 @@ Matrix * vec = |D E 0| |dy| = |A*dx+B*dy D*dx+E*dy G*dx+H*dy+I| = ----------- , |G H I| | 1| G*dx+H*dy+I G*dx+*dHy+I ## -#Param dx x-coordinate of Vector to map ## -#Param dy y-coordinate of Vector to map ## +#Param dx x-axis value of Vector to map ## +#Param dy y-axis value of Vector to map ## #Return mapped Vector ## @@ -3882,9 +3882,9 @@ the area enclosed by the ellipse major and minor axes. #Method bool isFixedStepInX() const #In Property #Line # returns if transformation supports fixed step in x ## -Returns true if a unit step in x at some y mapped through Matrix can be -represented by a constant Vector. Returns true if getType returns kIdentity_Mask, -or combinations of: kTranslate_Mask, kScale_Mask, and kAffine_Mask. +Returns true if a unit step on x-axis at some y-axis value mapped through Matrix +can be represented by a constant Vector. Returns true if getType returns +kIdentity_Mask, or combinations of: kTranslate_Mask, kScale_Mask, and kAffine_Mask. May return true if getType returns kPerspective_Mask, but only when Matrix does not include rotation or skewing along the y-axis. @@ -3931,12 +3931,12 @@ isFixedStepInX: false #Method SkVector fixedStepInX(SkScalar y) const #In Property #Line # returns step in x for a position in y ## -Returns Vector representing a unit step in x at y mapped through Matrix. +Returns Vector representing a unit step on x-axis at y mapped through Matrix. If isFixedStepInX is false, returned value is undefined. #Param y position of line parallel to x-axis ## -#Return Vector advance of mapped unit step in x ## +#Return Vector advance of mapped unit step on x-axis ## #Example #Image 3 @@ -4199,8 +4199,8 @@ matrix.getMinMaxScales() false 2 2 Decomposes Matrix into scale components and whatever remains. Returns false if Matrix could not be decomposed. -Sets scale to portion of Matrix that scales in x and y. Sets remaining to Matrix -with x and y scaling factored out. remaining may be passed as nullptr +Sets scale to portion of Matrix that scale axes. Sets remaining to Matrix +with scaling factored out. remaining may be passed as nullptr to determine if Matrix can be decomposed without computing remainder. Returns true if scale components are found. scale and remaining are @@ -4213,7 +4213,7 @@ On success Matrix = scale * Remaining ## -#Param scale x and y scaling factors; may be nullptr ## +#Param scale axes scaling factors; may be nullptr ## #Param remaining Matrix without scaling; may be nullptr ## #Return true if scale can be computed ## diff --git a/docs/SkPaint_Reference.bmh b/docs/SkPaint_Reference.bmh index e7158535bd..001ea53244 100644 --- a/docs/SkPaint_Reference.bmh +++ b/docs/SkPaint_Reference.bmh @@ -3996,9 +3996,9 @@ void draw(SkCanvas* canvas) { computed by Font_Manager using Typeface. Values are set to zero if they are not available. - All vertical values relative to the baseline are given y-down. As such, zero is on the - baseline, negative values are above the baseline, and positive values are below the - baseline. + All vertical values are relative to the baseline, on a y-axis pointing down. + Zero is on the baseline, negative values are above the baseline, and positive + values are below the baseline. fUnderlineThickness and fUnderlinePosition have a bit set in fFlags if their values are valid, since their value may be zero. @@ -4083,13 +4083,13 @@ void draw(SkCanvas* canvas) { #Member SkScalar fXMin #Line # minimum x ## - Minimum bounding box x-value for all Glyphs. + Minimum bounding box x-axis value for all Glyphs. Typically less than zero. ## #Member SkScalar fXMax #Line # maximum x ## - Maximum bounding box x value for all Glyphs. + Maximum bounding box x-axis value for all Glyphs. Typically greater than zero. ## @@ -4672,8 +4672,8 @@ Uses x, y, and Text_Align to position path. #Param text character codes or glyph indices ## #Param length number of bytes of text ## - #Param x x-coordinate of the origin of the text ## - #Param y y-coordinate of the origin of the text ## + #Param x x-axis value of the origin of the text ## + #Param y y-axis value of the origin of the text ## #Param path geometry of the Glyphs ## #Example @@ -4761,8 +4761,8 @@ underline that skips Descenders. #Param text character codes or glyph indices ## #Param length number of bytes of text ## - #Param x x-coordinate of the origin of the text ## - #Param y y-coordinate of the origin of the text ## + #Param x x-axis value of the origin of the text ## + #Param y y-axis value of the origin of the text ## #Param bounds lower and upper line parallel to the advance ## #Param intervals returned intersections; may be nullptr ## diff --git a/docs/SkPath_Reference.bmh b/docs/SkPath_Reference.bmh index 1b8f991c6a..deb1a046f5 100644 --- a/docs/SkPath_Reference.bmh +++ b/docs/SkPath_Reference.bmh @@ -1892,7 +1892,7 @@ path2 bounds = 10, 20, 30, 40 #Method const SkRect& getBounds() const #In Property #Line # returns maximum and minimum of Point_Array ## -Returns minimum and maximum x and y values of Point_Array. +Returns minimum and maximum axes values of Point_Array. Returns (0, 0, 0, 0) if Path contains no points. Returned bounds width and height may be larger or smaller than area affected when Path is drawn. @@ -1980,7 +1980,7 @@ cached avg: 0.182784 ms #Method SkRect computeTightBounds() const #In Property #Line # returns extent of geometry ## -Returns minimum and maximum x and y values of the lines and curves in Path. +Returns minimum and maximum axes values of the lines and curves in Path. Returns (0, 0, 0, 0) if Path contains no points. Returned bounds width and height may be larger or smaller than area affected when Path is drawn. @@ -2118,8 +2118,8 @@ void draw(SkCanvas* canvas) { #Line # starts Contour ## Adds beginning of Contour at Point (x, y). -#Param x x-coordinate of Contour start ## -#Param y y-coordinate of Contour start ## +#Param x x-axis value of Contour start ## +#Param y y-axis value of Contour start ## #Example #Width 140 @@ -2178,8 +2178,8 @@ If Path is empty, starts Contour at (dx, dy). Otherwise, start Contour at Last_Point offset by (dx, dy). Function name stands for "relative move to". -#Param dx offset from Last_Point x to Contour start x ## -#Param dy offset from Last_Point y to Contour start y ## +#Param dx offset from Last_Point to Contour start on x-axis ## +#Param dy offset from Last_Point to Contour start on y-axis ## #Example #Height 100 @@ -2288,8 +2288,8 @@ then appends kLine_Verb to Verb_Array and Line end to Point_Array. Line end is Last_Point plus Vector (dx, dy). Function name stands for "relative line to". -#Param dx offset from Last_Point x to Line end x ## -#Param dy offset from Last_Point y to Line end y ## +#Param dx offset from Last_Point to Line end on x-axis ## +#Param dy offset from Last_Point to Line end on y-axis ## #Example #Height 128 @@ -2460,10 +2460,10 @@ void draw(SkCanvas* canvas) { Quad end is Last_Point plus Vector (dx2, dy2). Function name stands for "relative quad to". - #Param dx1 offset from Last_Point x to Quad control x ## - #Param dy1 offset from Last_Point x to Quad control y ## - #Param dx2 offset from Last_Point x to Quad end x ## - #Param dy2 offset from Last_Point x to Quad end y ## + #Param dx1 offset from Last_Point to Quad control on x-axis ## + #Param dy1 offset from Last_Point to Quad control on y-axis ## + #Param dx2 offset from Last_Point to Quad end on x-axis ## + #Param dy2 offset from Last_Point to Quad end on y-axis ## #Example void draw(SkCanvas* canvas) { @@ -2758,10 +2758,10 @@ void draw(SkCanvas* canvas) { Function name stands for "relative conic to". - #Param dx1 offset from Last_Point x to Conic control x ## - #Param dy1 offset from Last_Point x to Conic control y ## - #Param dx2 offset from Last_Point x to Conic end x ## - #Param dy2 offset from Last_Point x to Conic end y ## + #Param dx1 offset from Last_Point to Conic control on x-axis ## + #Param dy1 offset from Last_Point to Conic control on y-axis ## + #Param dx2 offset from Last_Point to Conic end on x-axis ## + #Param dy2 offset from Last_Point to Conic end on y-axis ## #Param w weight of added Conic ## #Example @@ -2922,12 +2922,12 @@ to Point_Array. Cubic end is Last_Point plus Vector (dx2, dy2). Function name stands for "relative cubic to". - #Param x1 offset from Last_Point x to first Cubic control x ## - #Param y1 offset from Last_Point x to first Cubic control y ## - #Param x2 offset from Last_Point x to second Cubic control x ## - #Param y2 offset from Last_Point x to second Cubic control y ## - #Param x3 offset from Last_Point x to Cubic end x ## - #Param y3 offset from Last_Point x to Cubic end y ## + #Param x1 offset from Last_Point to first Cubic control on x-axis ## + #Param y1 offset from Last_Point to first Cubic control on y-axis ## + #Param x2 offset from Last_Point to second Cubic control on x-axis ## + #Param y2 offset from Last_Point to second Cubic control on y-axis ## + #Param x3 offset from Last_Point to Cubic end on x-axis ## + #Param y3 offset from Last_Point to Cubic end on y-axis ## #Example void draw(SkCanvas* canvas) { @@ -3291,10 +3291,10 @@ tangents are nearly parallel, arcTo appends Line from last Path Point to (x1, y1 arcTo appends at most one Line and one Conic. arcTo implements the functionality of PostScript_Arct and HTML_Canvas_ArcTo. -#Param x1 x common to pair of tangents ## -#Param y1 y common to pair of tangents ## -#Param x2 x end of second tangent ## -#Param y2 y end of second tangent ## +#Param x1 x-axis value common to pair of tangents ## +#Param y1 y-axis value common to pair of tangents ## +#Param x2 x-axis value end of second tangent ## +#Param y2 y-axis value end of second tangent ## #Param radius distance from Arc to Circle center ## #Example @@ -3526,7 +3526,7 @@ arcTo implements the functionality of SVG_Arc, although SVG "sweep-flag" value i opposite the integer value of sweep; SVG "sweep-flag" uses 1 for clockwise, while kCW_Direction cast to int is zero. -#Param r radii in x and y before x-axis rotation ## +#Param r radii on axes before x-axis rotation ## #Param xAxisRotate x-axis rotation in degrees; positive values are clockwise ## #Param largeArc chooses smaller or larger Arc ## #Param sweep chooses clockwise or counterclockwise Arc ## @@ -3579,13 +3579,13 @@ arcTo implements the functionality of SVG_Arc, although SVG "sweep-flag" value i opposite the integer value of sweep; SVG "sweep-flag" uses 1 for clockwise, while kCW_Direction cast to int is zero. -#Param rx radius in x before x-axis rotation ## -#Param ry radius in y before x-axis rotation ## +#Param rx radius before x-axis rotation ## +#Param ry radius before x-axis rotation ## #Param xAxisRotate x-axis rotation in degrees; positive values are clockwise ## #Param largeArc chooses smaller or larger Arc ## #Param sweep chooses clockwise or counterclockwise Arc ## -#Param dx x offset end of Arc from last Path Point ## -#Param dy y offset end of Arc from last Path Point ## +#Param dx x-axis offset end of Arc from last Path Point ## +#Param dy y-axis offset end of Arc from last Path Point ## #Example #Height 108 @@ -4051,10 +4051,10 @@ starting with top-left corner of Rect; followed by top-right, bottom-right, and bottom-left if dir is kCW_Direction; or followed by bottom-left, bottom-right, and top-right if dir is kCCW_Direction. -#Param left smaller x of Rect ## -#Param top smaller y of Rect ## -#Param right larger x of Rect ## -#Param bottom larger y of Rect ## +#Param left smaller x-axis value of Rect ## +#Param top smaller y-axis value of Rect ## +#Param right larger x-axis value of Rect ## +#Param bottom larger y-axis value of Rect ## #Param dir Direction to wind added contour ## #Example @@ -4268,8 +4268,8 @@ Rect rect to Path. After appending, Path may be empty, or may contain: Rect, Oval, or RoundRect. #Param rect bounds of Round_Rect ## -#Param rx x-radius of rounded corners on the Round_Rect ## -#Param ry y-radius of rounded corners on the Round_Rect ## +#Param rx x-axis radius of rounded corners on the Round_Rect ## +#Param ry y-axis radius of rounded corners on the Round_Rect ## #Param dir Direction to wind Round_Rect ## #Example @@ -4314,14 +4314,14 @@ array. #Legend # radii index # location ## #Legend ## -# 0 # x-radius of top-left corner ## -# 1 # y-radius of top-left corner ## -# 2 # x-radius of top-right corner ## -# 3 # y-radius of top-right corner ## -# 4 # x-radius of bottom-right corner ## -# 5 # y-radius of bottom-right corner ## -# 6 # x-radius of bottom-left corner ## -# 7 # y-radius of bottom-left corner ## +# 0 # x-axis radius of top-left corner ## +# 1 # y-axis radius of top-left corner ## +# 2 # x-axis radius of top-right corner ## +# 3 # y-axis radius of top-right corner ## +# 4 # x-axis radius of bottom-right corner ## +# 5 # y-axis radius of bottom-right corner ## +# 6 # x-axis radius of bottom-left corner ## +# 7 # y-axis radius of bottom-left corner ## #Table ## If dir is kCW_Direction, Round_Rect starts at top-left of the lower-left corner @@ -4559,8 +4559,8 @@ added unaltered. If mode is kExtend_AddPathMode, add Line before appending Verbs, Points, and Conic_Weights. #Param src Path Verbs, Points, and Conic_Weights to add ## -#Param dx offset added to src Point_Array x coordinates ## -#Param dy offset added to src Point_Array y coordinates ## +#Param dx offset added to src Point_Array x-axis coordinates ## +#Param dy offset added to src Point_Array y-axis coordinates ## #Param mode kAppend_AddPathMode or kExtend_AddPathMode ## #Example @@ -4694,8 +4694,8 @@ Reversed src always appends a new Contour to Path. Offset Point_Array by (dx, dy). Offset Path replaces dst. If dst is nullptr, Path is replaced by offset data. -#Param dx offset added to Point_Array x coordinates ## -#Param dy offset added to Point_Array y coordinates ## +#Param dx offset added to Point_Array x-axis coordinates ## +#Param dy offset added to Point_Array y-axis coordinates ## #Param dst overwritten, translated copy of Path; may be nullptr ## #Example @@ -4727,8 +4727,8 @@ If dst is nullptr, Path is replaced by offset data. #In Transform Offset Point_Array by (dx, dy). Path is replaced by offset data. -#Param dx offset added to Point_Array x coordinates ## -#Param dy offset added to Point_Array y coordinates ## +#Param dx offset added to Point_Array x-axis coordinates ## +#Param dy offset added to Point_Array y-axis coordinates ## #Example #Height 60 @@ -4857,8 +4857,8 @@ Last_Point can be read and written directly with getLastPt and setLastPt. Set Last_Point to (x, y). If Point_Array is empty, append kMove_Verb to Verb_Array and append (x, y) to Point_Array. - #Param x set x-coordinate of Last_Point ## - #Param y set y-coordinate of Last_Point ## + #Param x set x-axis value of Last_Point ## + #Param y set y-axis value of Last_Point ## #Example #Height 128 @@ -5012,8 +5012,8 @@ account FillType. # kInverseEvenOdd_FillType # and even number of Contours. ## ## -#Param x x-coordinate of containment test ## -#Param y y-coordinate of containment test ## +#Param x x-axis value of containment test ## +#Param y y-axis value of containment test ## #Return true if Point is in Path ## diff --git a/docs/SkPoint_Reference.bmh b/docs/SkPoint_Reference.bmh index fe48cd185f..87f1b618e6 100644 --- a/docs/SkPoint_Reference.bmh +++ b/docs/SkPoint_Reference.bmh @@ -1269,7 +1269,7 @@ Returns the dot product of Vector and Vector vec. typedef SkPoint SkVector; ## SkVector provides an alternative name for SkPoint. SkVector and SkPoint can - be used interchangably for all purposes. + be used interchangeably for all purposes. #Typedef ## ## diff --git a/docs/SkRect_Reference.bmh b/docs/SkRect_Reference.bmh index 2d878ef36d..fd747b0137 100644 --- a/docs/SkRect_Reference.bmh +++ b/docs/SkRect_Reference.bmh @@ -1270,7 +1270,7 @@ If dy is positive, Rect returned is moved downward. #Param dx added to fLeft and fRight ## #Param dy added to fTop and fBottom ## -#Return Rect offset in x or y, with original width and height ## +#Return Rect offset on axes, with original width and height ## #Example SkRect rect = { 10, 50, 20, 60 }; @@ -1669,10 +1669,10 @@ Returns false if Rect does not intersect construction, and leaves Rect unchanged Returns false if either construction or Rect is empty, leaving Rect unchanged. -#Param left x minimum of constructed Rect ## -#Param top y minimum of constructed Rect ## -#Param right x maximum of constructed Rect ## -#Param bottom y maximum of constructed Rect ## +#Param left x-axis minimum of constructed Rect ## +#Param top y-axis minimum of constructed Rect ## +#Param right x-axis maximum of constructed Rect ## +#Param bottom y-axis maximum of constructed Rect ## #Return true if construction and Rect have area in common ## @@ -1736,10 +1736,10 @@ construction. Returns true if Rect intersects construction. Returns false if either construction or Rect is empty, or do not intersect. -#Param left x minimum of constructed Rect ## -#Param top y minimum of constructed Rect ## -#Param right x maximum of constructed Rect ## -#Param bottom y maximum of constructed Rect ## +#Param left x-axis minimum of constructed Rect ## +#Param top y-axis minimum of constructed Rect ## +#Param right x-axis maximum of constructed Rect ## +#Param bottom y-axis maximum of constructed Rect ## #Return true if construction and Rect have area in common ## @@ -1825,10 +1825,10 @@ Sets Rect to the union of itself and the construction. Has no effect if construction is empty. Otherwise, if Rect is empty, sets Rect to construction. -#Param left x minimum of constructed Rect ## -#Param top y minimum of constructed Rect ## -#Param right x maximum of constructed Rect ## -#Param bottom y maximum of constructed Rect ## +#Param left x-axis minimum of constructed Rect ## +#Param top y-axis minimum of constructed Rect ## +#Param right x-axis maximum of constructed Rect ## +#Param bottom y-axis maximum of constructed Rect ## #Example SkRect rect = { 10, 20, 15, 25}; diff --git a/docs/SkSurface_Reference.bmh b/docs/SkSurface_Reference.bmh index 97ac249be6..cf42ef7aa5 100644 --- a/docs/SkSurface_Reference.bmh +++ b/docs/SkSurface_Reference.bmh @@ -1252,8 +1252,8 @@ Does not copy, and returns false if: ## #Param dst storage for pixels copied from Surface ## -#Param srcX offset into readable pixels in x; may be negative ## -#Param srcY offset into readable pixels in y; may be negative ## +#Param srcX offset into readable pixels on x-axis; may be negative ## +#Param srcY offset into readable pixels on y-axis; may be negative ## #Return true if pixels were copied ## @@ -1313,8 +1313,8 @@ Does not copy, and returns false if: #Param dstInfo width, height, Color_Type, and Alpha_Type of dstPixels ## #Param dstPixels storage for pixels; dstInfo.height() times dstRowBytes, or larger ## #Param dstRowBytes size of one destination row; dstInfo.width() times pixel size, or larger ## -#Param srcX offset into readable pixels in x; may be negative ## -#Param srcY offset into readable pixels in y; may be negative ## +#Param srcX offset into readable pixels on x-axis; may be negative ## +#Param srcY offset into readable pixels on y-axis; may be negative ## #Return true if pixels were copied ## @@ -1377,8 +1377,8 @@ Does not copy, and returns false if: ## #Param dst storage for pixels copied from Surface ## -#Param srcX offset into readable pixels in x; may be negative ## -#Param srcY offset into readable pixels in y; may be negative ## +#Param srcX offset into readable pixels on x-axis; may be negative ## +#Param srcY offset into readable pixels on y-axis; may be negative ## #Return true if pixels were copied ## @@ -1421,8 +1421,8 @@ Copies each readable pixel intersecting both rectangles, without scaling, converting to Surface colorType() and Surface alphaType() if required. #Param src storage for pixels to copy to Surface ## -#Param dstX x position relative to Surface to begin copy; may be negative ## -#Param dstY x position relative to Surface to begin copy; may be negative ## +#Param dstX x-axis position relative to Surface to begin copy; may be negative ## +#Param dstY y-axis position relative to Surface to begin copy; may be negative ## #Example #Image 4 @@ -1461,8 +1461,8 @@ Copies each readable pixel intersecting both rectangles, without scaling, converting to Surface colorType() and Surface alphaType() if required. #Param src storage for pixels to copy to Surface ## -#Param dstX x position relative to Surface to begin copy; may be negative ## -#Param dstY x position relative to Surface to begin copy; may be negative ## +#Param dstX x-axis position relative to Surface to begin copy; may be negative ## +#Param dstY y-axis position relative to Surface to begin copy; may be negative ## #Example #Image 4 diff --git a/docs/undocumented.bmh b/docs/undocumented.bmh index 9b898327ff..032a92052b 100644 --- a/docs/undocumented.bmh +++ b/docs/undocumented.bmh @@ -3,20 +3,17 @@ DirectWrite TrueType Windows Linux Android iOS __ANDROID_API__ AHardwareBuffer FreeType FreeType-based Harfbuzz LCD RGB sRGB ARGB BGR YUV SDTV HDTV - YUV_Component_Y YUV_Component_U YUV_Component_V Unicode Unicode5 UTF-8 UTF-16 UTF-32 ASCII Unichar API BMP GIF HEIF ICO JPEG PNG WBMP WebP - CPU Little_Endian Big_Endian - GPU GPU-backed OpenGL Vulkan I/O MSAA UV_Mapping Multi_Sample_Anti_Aliasing GPU_Share_Group + CPU + GPU GPU-backed OpenGL Vulkan I/O MSAA PDF XPS RFC NaN NaNs - Bezier_Curve Coons_Patch Cartesian_Coordinate Euclidean_Distance Euclidean_Space Mip_Map + C C++ CSS HTML - HTML_Gray HTML_DarkGray HTML_LightGray HTML_Silver HTML_Lime HTML_Green HTML_Aqua HTML_Fuchsia - SVG_lightgray SVG_darkgray SkUserConfig # not external, but still thinking about how markup refers to this SkXXX.h # ditto SkXXX_Reference # ditto @@ -80,6 +77,101 @@ FT_Load_Glyph #Substitute unhinted ## +# this jargon requires a substitute to space the phrase. +#Topic Little_Endian +#Substitute little endian +## + +#Topic Big_Endian +#Substitute big endian +## + +#Topic YUV_Component_Y +#Substitute YUV component y +## + +#Topic YUV_Component_U +#Substitute YUV component u +## + +#Topic YUV_Component_V +#Substitute YUV component v +## + +#Topic UV_Mapping +#Substitute UV mapping +## + +#Topic Multi_Sample_Anti_Aliasing +#Substitute multi-sample anti-aliasing +## + +#Topic GPU_Share_Group +#Substitute GPU share group +## + +#Topic Bezier_Curve +#Substitute Bezier cruve +## + +#Topic Coons_Patch +#Substitute Coons patch +## + +#Topic Cartesian_Coordinate +#Substitute Cartesian coordinate +## + +#Topic Euclidean_Distance +#Substitute Euclidean distance +## + +#Topic Euclidean_Space +#Substitute Euclidean space +## + +#Topic HTML_Gray +#Substitute HTML gray +## + +#Topic HTML_DarkGray +#Substitute HTML dark gray +## + +#Topic HTML_LightGray +#Substitute HTML light gray +## + +#Topic HTML_Silver +#Substitute HTML silver +## + +#Topic HTML_Lime +#Substitute HTML lime +## + +#Topic HTML_Green +#Substitute HTML green +## + +#Topic HTML_Aqua +#Substitute HTML aqua +## + +#Topic HTML_Fuchsia +#Substitute HTML fuchsia +## + +#Topic SVG_lightgray +#Substitute SVG light gray +## + +#Topic SVG_darkgray +#Substitute SVG dark gray +## + +# start of topics to be documented in the future + #Topic Alias #Alias Aliased ## #Alias Aliasing ## @@ -388,6 +480,7 @@ FT_Load_Glyph ## #Topic Mip_Map +#Substitute mip map ## #Topic Nine_Patch @@ -689,6 +782,13 @@ FT_Load_Glyph #Typedef intptr_t GrBackendObject #Typedef ## + #EnumClass GrMipMapped + #Const kNo 0 + ## + #Const kYes 1 + ## + #EnumClass ## + #Enum GrSurfaceOrigin #Const kBottomLeft_GrSurfaceOrigin 0 ## diff --git a/site/user/api/SkBitmap_Reference.md b/site/user/api/SkBitmap_Reference.md index eafec8d384..c0dee66aa6 100644 --- a/site/user/api/SkBitmap_Reference.md +++ b/site/user/api/SkBitmap_Reference.md @@ -323,7 +323,7 @@ SkBitmap member functions read and modify the structure properties. hasHardwareMipMap - returns Mip_Map support present; Android only + returns Mip Map support present; Android only height @@ -403,7 +403,7 @@ SkBitmap member functions read and modify the structure properties. setHasHardwareMipMap - sets Mip_Map support present; Android only + sets Mip Map support present; Android only setImmutable @@ -907,7 +907,7 @@ two width:1 height:1 colorType:kRGBA_8888_SkColorType alphaType:kOpaque_SkAlphaT hasHardwareMipMap - returns Mip_Map support present; Android only + returns Mip Map support present; Android only height @@ -2994,7 +2994,7 @@ subset origin: 32, 64 setHasHardwareMipMap - sets Mip_Map support present; Android only + sets Mip Map support present; Android only setImmutable diff --git a/site/user/api/SkCanvas_Reference.md b/site/user/api/SkCanvas_Reference.md index eb82724346..b2b0f9362f 100644 --- a/site/user/api/SkCanvas_Reference.md +++ b/site/user/api/SkCanvas_Reference.md @@ -387,7 +387,7 @@ SkCanvas member functions read and modify the structure properties. drawPatch - draws Coons_Patch + draws Coons Patch drawPath @@ -1521,10 +1521,10 @@ Does not copy, and returns false if: size of one destination row; dstInfo.width() times pixel size, or larger srcX - offset into readable pixels in x; may be negative + offset into readable pixels on x-axis; may be negative srcY - offset into readable pixels in y; may be negative + offset into readable pixels on y-axis; may be negative @@ -1611,10 +1611,10 @@ Does not copy, and returns false if: storage for pixels copied from Canvas srcX - offset into readable pixels in x; may be negative + offset into readable pixels on x-axis; may be negative srcY - offset into readable pixels in y; may be negative + offset into readable pixels on y-axis; may be negative @@ -1691,10 +1691,10 @@ Does not copy, and returns false if: storage for pixels copied from Canvas srcX - offset into readable pixels in x; may be negative + offset into readable pixels on x-axis; may be negative srcY - offset into readable pixels in y; may be negative + offset into readable pixels on y-axis; may be negative @@ -1776,10 +1776,10 @@ Does not copy, and returns false if: size of one row of pixels; info.width() times pixel size, or larger x - offset into Canvas writable pixels in x; may be negative + offset into Canvas writable pixels on x-axis; may be negative y - offset into Canvas writable pixels in y; may be negative + offset into Canvas writable pixels on y-axis; may be negative @@ -2800,10 +2800,10 @@ transforming the result with Matrix. amount to rotate, in degrees px - x-coordinate of the point to rotate about + x-axis value of the point to rotate about py - y-coordinate of the point to rotate about + y-axis value of the point to rotate about @@ -2825,8 +2825,8 @@ void skew(SkScalar< Skew Matrix by sx on the x-axis and sy on the y-axis. A positive value of sx -skews the drawing right as y increases; a positive value of sy skews the drawing -down as x increases. +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 Matrix with a skew matrix Premultiplied with Matrix. @@ -2836,20 +2836,20 @@ the result with Matrix. ### Parameters - + - +
sxamount to skew in xamount to skew on x-axis
syamount to skew in yamount to skew on y-axis
### Example -
Black text mimics an oblique text style by using a negative skew in x that -shifts the geometry to the right as the y values decrease. -Red text uses a positive skew in y to shift the geometry down as the x values -increase. -Blue text combines x and y skew to rotate and scale. +
Black text mimics an oblique text style by using a negative skew on x-axis +that shifts the geometry to the right as the y-axis values decrease. +Red text uses a positive skew on y-axis to shift the geometry down +as the x-axis values increase. +Blue text combines sx and sy skew to rotate and scale.
### See Also @@ -3486,7 +3486,8 @@ bounds of Clip in local coordinates
Initial bounds is device bounds outset by 1 on all sides. Clipped bounds is clipPath bounds outset by 1 on all sides. -Scaling the canvas by two in x and y scales the local bounds by 1/2 in x and y. +Scaling the canvas by two on both axes scales the local bounds by 1/2 +on both axes.
#### Example Output @@ -3567,7 +3568,8 @@ bounds of Clip in Device c
Initial bounds is device bounds, not outset. Clipped bounds is clipPath bounds, not outset. -Scaling the canvas by 1/2 in x and y scales the device bounds by 1/2 in x and y. +Scaling the canvas by 1/2 on both axes scales the device bounds by 1/2 +on both axes.
#### Example Output @@ -3731,7 +3733,7 @@ device bounds empty = true drawPatch - draws Coons_Patch + draws Coons Patch @@ -4558,10 +4560,10 @@ If rx and Rect bounds of Round Rect to draw rx - axis length in x of oval describing rounded corners + axis length on x-axis of oval describing rounded corners ry - axis length in y of oval describing rounded corners + axis length on y-axis of oval describing rounded corners paint stroke, blend, color, and so on, used to draw @@ -5574,7 +5576,7 @@ draws one of fColors into lattice rectangle const int* fXDivs -Array of x-coordinates that divide the bitmap vertically. +Array of x-axis values that divide the bitmap vertically. Array entries must be unique, increasing, greater than or equal to fBounds left edge, and less than fBounds right edge. Set the first element to fBounds left to collapse the left column of @@ -5585,7 +5587,7 @@ fixed grid entries. const int* fYDivs -Array of y-coordinates that divide the bitmap horizontally. +Array of y-axis values that divide the bitmap horizontally. Array entries must be unique, increasing, greater than or equal to fBounds top edge, and less than fBounds bottom edge. Set the first element to fBounds top to collapse the top row of fixed @@ -5981,10 +5983,9 @@ void drawPosText(const void* text, size_t by described by byteLength of text. text meaning depends on Paint Text Encoding; by default, text is encoded as -UTF-8. pos elements meaning depends on Paint Vertical Text; -by default each glyph left side bearing is positioned at x and its -baseline is positioned at y. Text size is affected by Matrix and -Paint Text Size. +UTF-8. pos elements meaning depends on Paint Vertical Text; by default +glyph left side bearing and baseline are relative to Point in pos array. +Text size is affected by Matrix and Paint Text Size. All elements of paint: Path Effect, Mask Filter, Shader, Color Filter, Image Filter, and Draw Looper; apply to text. By default, draws @@ -6054,10 +6055,10 @@ baseline. byte length of text array xpos - array of x positions, used to position each glyph + array of x-axis positions, used to position each glyph constY - shared y coordinate for all of x positions + shared y-axis value for all of x-axis positions paint text size, blend, color, and so on, used to draw @@ -6092,8 +6093,8 @@ than the path length, the excess < text meaning depends on Paint Text Encoding; by default, text is encoded as UTF-8. Origin meaning depends on Paint Text Align and Paint Vertical Text; by -default text positions the first glyph left side bearing at origin x and its -baseline at origin y. Text size is affected by Matrix and Paint Text Size. +default text positions the first glyph left side bearing and baseline relative +to origin. Text size is affected by Matrix and Paint Text Size. All elements of paint: Path Effect, Mask Filter, Shader, Color Filter, Image Filter, and Draw Looper; apply to text. By default, draws @@ -6151,8 +6152,8 @@ If the text advance is larger than t text meaning depends on Paint Text Encoding; by default, text is encoded as UTF-8. Origin meaning depends on Paint Text Align and Paint Vertical Text; by -default text positions the first glyph left side bearing at origin x and its -baseline at origin y. Text size is affected by matrix parameter, Canvas Matrix, +default text positions the first glyph left side bearing and baseline relative +to origin. Text size is affected by matrix parameter, Canvas Matrix, and Paint Text Size. All elements of paint: Path Effect, Mask Filter, Shader, @@ -6538,12 +6539,12 @@ void drawPatch(const SkBlendMode mode, const SkPaint& paint) -Draws a Coons_Patch: the interpolation of four cubics with shared corners, -associating a color, and optionally a texture coordinate, with each corner. +Draws a Coons Patch: the interpolation of four cubics with shared corners, +associating a color, and optionally a texture Point, with each corner. -Coons_Patch uses Clip and Matrix, paint Shader, Color Filter, +Coons Patch uses Clip and Matrix, paint Shader, Color Filter, Color Alpha, Image Filter, and Blend Mode. If Shader is provided it is treated -as Coons_Patch texture; Blend Mode mode combines Color colors and Shader if +as Coons Patch texture; Blend Mode mode combines Color colors and Shader if both are provided. Point array cubics specifies four Cubics starting at the top-left corner, @@ -6593,12 +6594,12 @@ void drawPatch(const SkPaint& paint) -Draws Cubic Coons_Patch: the interpolation of four cubics with shared corners, -associating a color, and optionally a texture coordinate, with each corner. +Draws Cubic Coons Patch: the interpolation of four cubics with shared corners, +associating a color, and optionally a texture Point, with each corner. -Coons_Patch uses Clip and Matrix, paint Shader, Color Filter, +Coons Patch uses Clip and Matrix, paint Shader, Color Filter, Color Alpha, Image Filter, and Blend Mode. If Shader is provided it is treated -as Coons_Patch texture; Blend Mode mode combines Color colors and Shader if +as Coons Patch texture; Blend Mode mode combines Color colors and Shader if both are provided. Point array cubics specifies four Cubics starting at the top-left corner, @@ -6905,10 +6906,10 @@ immediate drawing, call SkDrawable::draw( custom struct encapsulating drawing commands x - offset into Canvas writable pixels in x + offset into Canvas writable pixels on x-axis y - offset into Canvas writable pixels in y + offset into Canvas writable pixels on y-axis diff --git a/site/user/api/SkColor_Reference.md b/site/user/api/SkColor_Reference.md index 33316148c9..3d686e27af 100644 --- a/site/user/api/SkColor_Reference.md +++ b/site/user/api/SkColor_Reference.md @@ -643,7 +643,7 @@ Represents fully opaque black. Represents fully opaque dark gray. -Note that SVG_darkgray is equivalent to 0xFFA9A9A9. +Note that SVG darkgray is equivalent to 0xFFA9A9A9. @@ -652,7 +652,7 @@ Note that SVG_darkgray is equivalent to 0xFFA9A9A9. Represents fully opaque gray. -Note that HTML_Gray is equivalent to 0xFF808080. +Note that HTML Gray is equivalent to 0xFF808080. @@ -660,8 +660,8 @@ Note that HTML_Gray is equivalent to 0xFF808080. 0xFFCCCCCC -Represents fully opaque light gray. HTML_Silver is equivalent to 0xFFC0C0C0. -Note that SVG_lightgray is equivalent to 0xFFD3D3D3. +Represents fully opaque light gray. HTML Silver is equivalent to 0xFFC0C0C0. +Note that SVG lightgray is equivalent to 0xFFD3D3D3. @@ -685,8 +685,8 @@ Represents fully opaque red. 0xFF00FF00 -Represents fully opaque green. HTML_Lime is equivalent. -Note that HTML_Green is equivalent to 0xFF008000. +Represents fully opaque green. HTML Lime is equivalent. +Note that HTML Green is equivalent to 0xFF008000. @@ -710,7 +710,7 @@ Represents fully opaque yellow. 0xFF00FFFF -Represents fully opaque cyan. HTML_Aqua is equivalent. +Represents fully opaque cyan. HTML Aqua is equivalent. @@ -718,7 +718,7 @@ Represents fully opaque cyan. HTML_Aqua is equivalent. 0xFFFF00FF -Represents fully opaque magenta. HTML_Fuchsia is equivalent. +Represents fully opaque magenta. HTML Fuchsia is equivalent. diff --git a/site/user/api/SkIRect_Reference.md b/site/user/api/SkIRect_Reference.md index 764b67aab3..8f8014767f 100644 --- a/site/user/api/SkIRect_Reference.md +++ b/site/user/api/SkIRect_Reference.md @@ -1461,7 +1461,7 @@ If dy is positive, IRectIRect offset in x or y, with original width and height +IRect offset by dx and dy, with original width and height ### Example @@ -1953,16 +1953,16 @@ Returns false if IRect is empty or construction is empty. ### Parameters - + - + - + - +
leftx minimum of constructed IRectx-axis minimum of constructed IRect
topy minimum of constructed IRecty-axis minimum of constructed IRect
rightx maximum of constructed IRectx-axis maximum of constructed IRect
bottomy maximum of constructed IRecty-axis maximum of constructed IRect
@@ -2092,16 +2092,16 @@ Return is undefined if IRect is empty or construction is em ### Parameters - + - + - + - +
leftx minimum of constructed IRectx-axis minimum of constructed IRect
topy minimum of constructed IRecty-axis minimum of constructed IRect
rightx maximum of constructed IRectx-axis maximum of constructed IRect
bottomy maximum of constructed IRecty-axis maximum of constructed IRect
@@ -2319,16 +2319,16 @@ Returns false if either construction or IRect is empty, lea ### Parameters - + - + - + - +
leftx minimum of constructed IRectx-axis minimum of constructed IRect
topy minimum of constructed IRecty-axis minimum of constructed IRect
rightx maximum of constructed IRectx-axis maximum of constructed IRect
bottomy maximum of constructed IRecty-axis maximum of constructed IRect
@@ -2480,16 +2480,16 @@ Has no effect if construction is empty. Otherwise, if IRect ### Parameters - + - + - + - +
leftx minimum of constructed IRectx-axis minimum of constructed IRect
topy minimum of constructed IRecty-axis minimum of constructed IRect
rightx maximum of constructed IRectx-axis maximum of constructed IRect
bottomy maximum of constructed IRecty-axis maximum of constructed IRect
diff --git a/site/user/api/SkImageInfo_Reference.md b/site/user/api/SkImageInfo_Reference.md index 4e0ac4bd69..5cab53fb28 100644 --- a/site/user/api/SkImageInfo_Reference.md +++ b/site/user/api/SkImageInfo_Reference.md @@ -348,9 +348,9 @@ true if at equals Grayscale, RGB, or ARGB. -kN32_SkColorType selects the native 32-bit ARGB format. On Little_Endian +kN32_SkColorType selects the native 32-bit ARGB format. On Little Endian processors, pixels containing 8-bit ARGB components pack into 32-bit -kBGRA_8888_SkColorType. On Big_Endian processors, pixels pack into 32-bit +kBGRA_8888_SkColorType. On Big Endian processors, pixels pack into 32-bit kRGBA_8888_SkColorType. ### Constants @@ -567,7 +567,7 @@ If paired with kOpaque_SkAlphaType: all alpha red, green, and blue components are fully opaque. If any alpha component is less than 255, the drawn result is undefined. -On Big_Endian platforms, kRGBA_8888_SkColorType is the native Color Type, and +On Big Endian platforms, kRGBA_8888_SkColorType is the native Color Type, and will have the best performance. Use kN32_SkColorType to choose the best Color Type for the platform at compile time. @@ -616,7 +616,7 @@ If paired with kOpaque_SkAlphaType: all alpha blue, green, and red components are fully opaque. If any alpha component is less than 255, the drawn result is undefined. -On Little_Endian platforms, kBGRA_8888_SkColorType is the native Color Type, +On Little Endian platforms, kBGRA_8888_SkColorType is the native Color Type, and will have the best performance. Use kN32_SkColorType to choose the best Color Type for the platform at compile time. @@ -1142,7 +1142,7 @@ SkImageInfo global, struct, and class related member f Color Type BGRA 8888 - encodes ARGB Little_Endian in 32 bits + encodes ARGB Little Endian in 32 bits Color Type Gray 8 @@ -1154,7 +1154,7 @@ SkImageInfo global, struct, and class related member f Color Type RGBA 8888 - encodes ARGB Big_Endian in 32 bits + encodes ARGB Big Endian in 32 bits Color Type RGBA F16 diff --git a/site/user/api/SkImage_Reference.md b/site/user/api/SkImage_Reference.md index 7f3f0054c3..5b45ed0c8f 100644 --- a/site/user/api/SkImage_Reference.md +++ b/site/user/api/SkImage_Reference.md @@ -899,7 +899,7 @@ static sk sp<SkImage& Creates Image from encoded data. Image is uploaded to GPU back-end using context. Created Image is available to other GPU contexts, and is available across thread -boundaries. All contexts must be in the same GPU_Share_Group, or otherwise +boundaries. All contexts must be in the same GPU Share Group, or otherwise share resources. When Image is no longer referenced, context releases texture memory @@ -923,7 +923,7 @@ moving resources between contexts. Image to decode buildMips - create Image as Mip_Map if true + create Image as Mip Map if true dstColorSpace range of colors of matching Surface on GPU @@ -959,7 +959,7 @@ static sk sp<SkImage& Creates Image from pixmap. Image is uploaded to GPU back-end using context. Created Image is available to other GPU contexts, and is available across thread -boundaries. All contexts must be in the same GPU_Share_Group, or otherwise +boundaries. All contexts must be in the same GPU Share Group, or otherwise share resources. When Image is no longer referenced, context releases texture memory @@ -983,7 +983,7 @@ Recognized GPU formats vary by platform and GPU back-end. Image Info, pixel address, and row bytes buildMips - create Image as Mip_Map if true + create Image as Mip Map if true dstColorSpace range of colors of matching Surface on GPU @@ -1119,9 +1119,9 @@ static sk sp<SkImage& Creates Image from copy of nv12Textures, an array of textures on GPU. -nv12Textures[0] contains pixels for YUV_Component_Y plane. -nv12Textures[1] contains pixels for YUV_Component_U plane, -followed by pixels for YUV_Component_V plane. +nv12Textures[0] contains pixels for YUV Component Y plane. +nv12Textures[1] contains pixels for YUV Component U plane, +followed by pixels for YUV Component V plane. Returned Image has the dimensions nv12Textures[2]. yuvColorSpace describes how YUV colors convert to RGB colors. @@ -1662,12 +1662,12 @@ transforming Image before tileMode1 - tiling in x, one of: SkShader::kClamp TileMode, SkShader::kRepeat TileMode, -SkShader::kMirror TileMode + tiling on x-axis, one of: SkShader::kClamp TileMode, +SkShader::kRepeat TileMode, SkShader::kMirror TileMode tileMode2 - tiling in y, one of: SkShader::kClamp TileMode, SkShader::kRepeat TileMode, -SkShader::kMirror TileMode + tiling on y-axis, one of: SkShader::kClamp TileMode, +SkShader::kRepeat TileMode, SkShader::kMirror TileMode localMatrix Image transformation, or nullptr @@ -2319,14 +2319,14 @@ partial or full Image, or nullptr 
 sk sp<SkImage> makeTextureImage(GrContext* context, SkColorSpace* dstColorSpace,
-                                 mipMapped = GrMipMapped::kNo) const
+                                GrMipMapped mipMapped = GrMipMapped::kNo) const
Returns Image backed by GPU Texture associated with context. Returned Image is -compatible with Surface created with dstColorSpace. The returned Image will also -support the request status. In other words if mipMapped is GrMipMapped::kYes, -then the backing texture will have Mip_Map levels allocated. Returns original Image if context -and dstColorSpace match and mipMapped is compatible with the backing GPU Texture. +compatible with Surface created with dstColorSpace. The returned Image respects +mipMapped setting; if mipMapped equals GrMipMapped::kYes, the backing texture +allocates Mip Map levels. Returns original Image if context +and dstColorSpace match and mipMapped is compatible with backing GPU Texture. Returns nullptr if context is nullptr, or if Image was created with another GrContext. @@ -2340,7 +2340,7 @@ Returns nullptr if context is nu range of colors of matching Surface on GPU mipMapped - whether the returned SkImage's texture must have allocated Mip_Map levels + whether created Image texture must allocate Mip Map levels diff --git a/site/user/api/SkMatrix_Reference.md b/site/user/api/SkMatrix_Reference.md index 33ad804cf5..d2ffdd14ad 100644 --- a/site/user/api/SkMatrix_Reference.md +++ b/site/user/api/SkMatrix_Reference.md @@ -818,10 +818,10 @@ Sets Matrix to: vertical translation pers0 - input x perspective factor + input x-axis perspective factor pers1 - input y perspective factor + input y-axis perspective factor pers2 perspective scale factor @@ -1191,7 +1191,7 @@ bool rectStaysRect() const Returns true Matrix maps Rect to another Rect. If true, Matrix is identity, -or scales, or rotates a multiple of 90 degrees, or mirrors in x or y. In all +or scales, or rotates a multiple of 90 degrees, or mirrors on axes. In all cases, Matrix may also have translation. Matrix form is either: 
@@ -1246,7 +1246,7 @@ bool preservesAxisAlignment() con
Returns true Matrix maps Rect to another Rect. If true, Matrix is identity, -or scales, or rotates a multiple of 90 degrees, or mirrors in x or y. In all +or scales, or rotates a multiple of 90 degrees, or mirrors on axes. In all cases, Matrix may also have translation. Matrix form is either: 
@@ -1339,7 +1339,7 @@ degenerate forms that collapse to a line or point.
 
 Describes that the Matrix makes rendering with and without the matrix are
 visually alike; a transformed circle remains a circle. Mathematically, this is
-referred to as similarity of a Euclidean_Space, or a similarity transformation.
+referred to as similarity of a Euclidean Space, or a similarity transformation.
 
 Preserves right angles, keeping the arms of the angle equal lengths.
 
@@ -1778,7 +1778,7 @@ matrix.get(SkMatrix::kMSkewY) == 24
 SkScalar getScaleX() const
-Returns scale factor multiplied by x input, contributing to x output. +Returns scale factor multiplied by x-axis input, contributing to x-axis output. With mapPoints, scales Points along the x-axis. ### Return Value @@ -1810,7 +1810,7 @@ matrix.getScaleX() == 42 SkScalar getScaleY() const -Returns scale factor multiplied by y input, contributing to y output. +Returns scale factor multiplied by y-axis input, contributing to y-axis output. With mapPoints, scales Points along the y-axis. ### Return Value @@ -1842,9 +1842,9 @@ matrix.getScaleY() == 24 SkScalar getSkewY() const -Returns scale factor multiplied by x input, contributing to y output. +Returns scale factor multiplied by x-axis input, contributing to y-axis output. With mapPoints, skews Points along the y-axis. -Skew x and y together can rotate Points. +Skewing both axes can rotate Points. ### Return Value @@ -1875,9 +1875,9 @@ matrix.getSkewY() == 24 SkScalar getSkewX() const -Returns scale factor multiplied by y input, contributing to x output. +Returns scale factor multiplied by y-axis input, contributing to x-axis output. With mapPoints, skews Points along the x-axis. -Skew x and y together can rotate Points. +Skewing both axes can rotate Points. ### Return Value @@ -1908,7 +1908,7 @@ matrix.getSkewX() == 42 SkScalar getTranslateX() const -Returns translation contributing to x output. +Returns translation contributing to x-axis output. With mapPoints, moves Points along the x-axis. ### Return Value @@ -1940,7 +1940,7 @@ matrix.getTranslateX() == 42 SkScalar getTranslateY() const -Returns translation contributing to y output. +Returns translation contributing to y-axis output. With mapPoints, moves Points along the y-axis. ### Return Value @@ -1972,11 +1972,11 @@ matrix.getTranslateY() == 24 SkScalar getPerspX() const -Returns factor scaling input x relative to input y. +Returns factor scaling input x-axis relative to input y-axis. ### Return Value -input x perspective factor +input x-axis perspective factor ### Example @@ -1995,11 +1995,11 @@ input x perspective factor SkScalar getPerspY() const -Returns factor scaling input y relative to input x. +Returns factor scaling input y-axis relative to input x-axis. ### Return Value -input y perspective factor +input y-axis perspective factor ### Example @@ -2414,8 +2414,8 @@ Sets vertical translation. void setPerspX(SkScalar v) -Sets input x perspective factor, which causes mapXY to vary input x inversely -proportional to input y. +Sets input x-axis perspective factor, which causes mapXY to vary input x-axis values +inversely proportional to input y-axis values. ### Parameters @@ -2441,8 +2441,8 @@ proportional to input y. void setPerspY(SkScalar v) -Sets input y perspective factor, which causes mapXY to vary input y inversely -proportional to input x. +Sets input y-axis perspective factor, which causes mapXY to vary input y-axis values +inversely proportional to input x-axis values. ### Parameters @@ -2498,10 +2498,10 @@ Sets all values from parameters. Sets matrix to: vertical translation to store persp0 - input x perspective factor to store + input x-axis values perspective factor to store persp1 - input y perspective factor to store + input y-axis values perspective factor to store persp2 perspective scale factor to store @@ -2863,16 +2863,16 @@ The pivot point is unchanged when mapped with Matrix. ### Parameters - + - + - + - +
sinValuerotation vector x componentrotation vector x-axis component
cosValuerotation vector y componentrotation vector y-axis component
pxpivot xpivot x-axis
pypivot ypivot y-axis
@@ -2900,10 +2900,10 @@ Sets Matrix to rotate by sinValue - rotation vector x component + rotation vector x-axis component cosValue - rotation vector y component + rotation vector y-axis component @@ -3093,10 +3093,10 @@ Matrix * T(dx, dy) = | D E F | | 0 1 dy | = | D E D*dx+E*dy+F | ### Parameters - + - +
dxx translation before applying Matrixx-axis translation before applying Matrix
dyy translation before applying Matrixy-axis translation before applying Matrix
@@ -3509,10 +3509,10 @@ T(dx, dy) * Matrix = | 0 1 dy | | M N O | = | M+dy*P N+dy*Q O+dy*R | ### Parameters - + - +
dxx translation after applying Matrixx-axis translation after applying Matrix
dyy translation after applying Matrixy-axis translation after applying Matrix
@@ -4627,10 +4627,10 @@ Matrix * pt = |D E F| |y| = |Ax+By+C Dx+Ey+F Gx+Hy+I| = ------- , ------- ### Parameters - + - + @@ -4672,10 +4672,10 @@ Matrix * pt = |D E F| |y| = |Ax+By+C Dx+Ey+F Gx+Hy+I| = ------- , ------- ### Parameters
xx-coordinate of Point to mapx-axis value of Point to map
yy-coordinate of Point to mapy-axis value of Point to map
result storage for mapped Point
- + - +
xx-coordinate of Point to mapx-axis value of Point to map
yy-coordinate of Point to mapy-axis value of Point to map
@@ -4831,10 +4831,10 @@ Matrix * vec = |D E 0| |dy| = |A*dx+B*dy D*dx+E*dy G*dx+H*dy+I| = ----------- , ### Parameters - + - + @@ -4877,10 +4877,10 @@ Matrix * vec = |D E 0| |dy| = |A*dx+B*dy D*dx+E*dy G*dx+H*dy+I| = ----------- , ### Parameters
dxx-coordinate of Vector to mapx-axis value of Vector to map
dyy-coordinate of Vector to mapy-axis value of Vector to map
result storage for mapped Vector
- + - +
dxx-coordinate of Vector to mapx-axis value of Vector to map
dyy-coordinate of Vector to mapy-axis value of Vector to map
@@ -5121,9 +5121,9 @@ the area enclosed by the ellipse major and minor axes. bool isFixedStepInX() const -Returns true if a unit step in x at some y mapped through Matrix can be -represented by a constant Vector. Returns true if getType returns kIdentity Mask, -or combinations of: kTranslate Mask, kScale Mask, and kAffine Mask. +Returns true if a unit step on x-axis at some y-axis value mapped through Matrix +can be represented by a constant Vector. Returns true if getType returns +kIdentity Mask, or combinations of: kTranslate Mask, kScale Mask, and kAffine Mask. May return true if getType returns kPerspective Mask, but only when Matrix does not include rotation or skewing along the y-axis. @@ -5172,7 +5172,7 @@ isFixedStepInX: false SkVector fixedStepInX(SkScalar y) const -Returns Vector representing a unit step in x at y mapped through Matrix. +Returns Vector representing a unit step on x-axis at y mapped through Matrix. If isFixedStepInX is false, returned value is undefined. ### Parameters @@ -5184,7 +5184,7 @@ If isFixedStepInX is false, returned valu ### Return Value -Vector advance of mapped unit step in x +Vector advance of mapped unit step on x-axis ### Example @@ -5490,8 +5490,8 @@ bool decomposeScale(Matrix into scale components and whatever remains. Returns false if Matrix could not be decomposed. -Sets scale to portion of Matrix that scales in x and y. Sets remaining to Matrix -with x and y scaling factored out. remaining may be passed as nullptr +Sets scale to portion of Matrix that scale axes. Sets remaining to Matrix +with scaling factored out. remaining may be passed as nullptr to determine if Matrix can be decomposed without computing remainder. Returns true if scale components are found. scale and remaining are @@ -5503,7 +5503,7 @@ On successMatrix = scale - x and y scaling factors; may be nullptr + axes scaling factors; may be nullptr remaining Matrix without scaling; may be nullptr diff --git a/site/user/api/SkPaint_Reference.md b/site/user/api/SkPaint_Reference.md index 8a07616f9a..7ef986d432 100644 --- a/site/user/api/SkPaint_Reference.md +++ b/site/user/api/SkPaint_Reference.md @@ -4940,9 +4940,9 @@ SkPaint members may be read and written directly without using a member function computed by Font Manager using Typeface. Values are set to zero if they are not available. -All vertical values relative to the baseline are given y-down. As such, zero is on the -baseline, negative values are above the baseline, and positive values are below the -baseline. +All vertical values are relative to the baseline, on a y-axis pointing down. +Zero is on the baseline, negative values are above the baseline, and positive +values are below the baseline. fUnderlineThickness and fUnderlinePosition have a bit set in fFlags if their values are valid, since their value may be zero. @@ -5067,7 +5067,7 @@ maximum character width SkScalar fXMin -Minimum bounding box x-value for all Glyphs. +Minimum bounding box x-axis value for all Glyphs. Typically less than zero. @@ -5075,7 +5075,7 @@ Typically less than zero. SkScalar fXMax -Maximum bounding box x value for all Glyphs. +Maximum bounding box x-axis value for all Glyphs. Typically greater than zero. @@ -5726,10 +5726,10 @@ Uses x, y< number of bytes of text x - x-coordinate of the origin of the text + x-axis value of the origin of the text y - y-coordinate of the origin of the text + y-axis value of the origin of the text path geometry of the Glyphs @@ -5816,10 +5816,10 @@ Pass nullptr for intervals to number of bytes of text x - x-coordinate of the origin of the text + x-axis value of the origin of the text y - y-coordinate of the origin of the text + y-axis value of the origin of the text bounds lower and upper line parallel to the advance diff --git a/site/user/api/SkPath_Reference.md b/site/user/api/SkPath_Reference.md index a00c7922e4..5d151be5de 100644 --- a/site/user/api/SkPath_Reference.md +++ b/site/user/api/SkPath_Reference.md @@ -78,7 +78,7 @@ makes them visible. # Class SkPath Paths contain geometry. Paths may be empty, or contain one or more Verbs that -outline a figure. Path always starts with a move verb to a Cartesian_Coordinate, +outline a figure. Path always starts with a move verb to a Cartesian Coordinate, and may be followed by additional verbs that add lines or curves. Adding a close verb makes the geometry into a continuous loop, a closed contour. Paths may contain any number of contours, each beginning with a move verb. @@ -805,7 +805,7 @@ parabolic (and identical to Quad); greater than one hyperbol 4 Adds Cubic from Last Point, using two control Points, and end Point. -Cubic is a third-order Bezier_Curve section within tangents from Last Point +Cubic is a third-order Bezier Curve section within tangents from Last Point to first control Point, and from second control Point to end Point. @@ -2485,7 +2485,7 @@ path2 bounds = 10, 20, 30, 40 const SkRect& getBounds() const -Returns minimum and maximum x and y values of Point Array. +Returns minimum and maximum axes values of Point Array. Returns (0, 0, 0, 0) if Path contains no points. Returned bounds width and height may be larger or smaller than area affected when Path is drawn. @@ -2625,7 +2625,7 @@ cached avg: 0.182784 ms SkRect computeTightBounds() const -Returns minimum and maximum x and y values of the lines and curves in Path. +Returns minimum and maximum axes values of the lines and curves in Path. Returns (0, 0, 0, 0) if Path contains no points. Returned bounds width and height may be larger or smaller than area affected when Path is drawn. @@ -2900,10 +2900,10 @@ Adds beginning of Contour at x - x-coordinate of Contour start + x-axis value of Contour start y - y-coordinate of Contour start + y-axis value of Contour start @@ -2957,10 +2957,10 @@ Function name stands for "relative move to". ### Parameters - + - +
dxoffset from Last Point x to Contour start xoffset from Last Point to Contour start on x-axis
dyoffset from Last Point y to Contour start yoffset from Last Point to Contour start on y-axis
@@ -3054,10 +3054,10 @@ Function name stands for "relative line to". ### Parameters - + - +
dxoffset from Last Point x to Line end xoffset from Last Point to Line end on x-axis
dyoffset from Last Point y to Line end yoffset from Last Point to Line end on y-axis
@@ -3187,16 +3187,16 @@ Function name stands for "relative quad to". ### Parameters - + - + - + - +
dx1offset from Last Point x to Quad control xoffset from Last Point to Quad control on x-axis
dy1offset from Last Point x to Quad control yoffset from Last Point to Quad control on y-axis
dx2offset from Last Point x to Quad end xoffset from Last Point to Quad end on x-axis
dy2offset from Last Point x to Quad end yoffset from Last Point to Quad end on y-axis
@@ -3410,16 +3410,16 @@ Function name stands for "relative conic to". ### Parameters - + - + - + - + @@ -3438,7 +3438,7 @@ Function name stands for "relative conic to". ## Cubic -Cubic describes a Bezier_Curve segment described by a third-order polynomial. +Cubic describes a Bezier Curve segment described by a third-order polynomial. Cubic begins at a start Point, curving towards the first control Point; and curves from the end Point towards the second control Point. @@ -3552,22 +3552,22 @@ Function name stands for "relative cubic to". ### Parameters
dx1offset from Last Point x to Conic control xoffset from Last Point to Conic control on x-axis
dy1offset from Last Point x to Conic control yoffset from Last Point to Conic control on y-axis
dx2offset from Last Point x to Conic end xoffset from Last Point to Conic end on x-axis
dy2offset from Last Point x to Conic end yoffset from Last Point to Conic end on y-axis
w weight of added Conic
- + - + - + - + - + - +
x1offset from Last Point x to first Cubic control xoffset from Last Point to first Cubic control on x-axis
y1offset from Last Point x to first Cubic control yoffset from Last Point to first Cubic control on y-axis
x2offset from Last Point x to second Cubic control xoffset from Last Point to second Cubic control on x-axis
y2offset from Last Point x to second Cubic control yoffset from Last Point to second Cubic control on y-axis
x3offset from Last Point x to Cubic end xoffset from Last Point to Cubic end on x-axis
y3offset from Last Point x to Cubic end yoffset from Last Point to Cubic end on y-axis
@@ -3716,16 +3716,16 @@ tangents are nearly parallel, arcTo appends x1 - x common to pair of tangents + x-axis value common to pair of tangents y1 - y common to pair of tangents + y-axis value common to pair of tangents x2 - x end of second tangent + x-axis value end of second tangent y2 - y end of second tangent + y-axis value end of second tangent radius distance from Arc to Circle center @@ -3930,7 +3930,7 @@ opposite the integer value of sweep; r - radii in x and y before x-axis rotation + radii on axes before x-axis rotation xAxisRotate x-axis rotation in degrees; positive values are clockwise @@ -3987,10 +3987,10 @@ opposite the integer value of sweep; rx - radius in x before x-axis rotation + radius before x-axis rotation ry - radius in y before x-axis rotation + radius before x-axis rotation xAxisRotate x-axis rotation in degrees; positive values are clockwise @@ -4002,10 +4002,10 @@ opposite the integer value of sweep; chooses clockwise or counterclockwise Arc dx - x offset end of Arc from last Path Point + x-axis offset end of Arc from last Path Point dy - y offset end of Arc from last Path Point + y-axis offset end of Arc from last Path Point @@ -4403,16 +4403,16 @@ and bottom-left - smaller x of Rect + smaller x-axis value of Rect top - smaller y of Rect + smaller y-axis value of Rect right - larger x of Rect + larger x-axis value of Rect bottom - larger y of Rect + larger y-axis value of Rect dir Direction to wind added contour @@ -4613,10 +4613,10 @@ After appending, Path may be empty, or may contain: bounds of Round Rect rx - x-radius of rounded corners on the Round Rect + x-axis radius of rounded corners on the Round Rect ry - y-radius of rounded corners on the Round Rect + y-axis radius of rounded corners on the Round Rect dir Direction to wind Round Rect @@ -4650,14 +4650,14 @@ array. | radii index | location | | --- | --- | -| 0 | x-radius of top-left corner | -| 1 | y-radius of top-left corner | -| 2 | x-radius of top-right corner | -| 3 | y-radius of top-right corner | -| 4 | x-radius of bottom-right corner | -| 5 | y-radius of bottom-right corner | -| 6 | x-radius of bottom-left corner | -| 7 | y-radius of bottom-left corner | +| 0 | x-axis radius of top-left corner | +| 1 | y-axis radius of top-left corner | +| 2 | x-axis radius of top-right corner | +| 3 | y-axis radius of top-right corner | +| 4 | x-axis radius of bottom-right corner | +| 5 | y-axis radius of bottom-right corner | +| 6 | x-axis radius of bottom-left corner | +| 7 | y-axis radius of bottom-left corner | If dir is kCW Direction, Round Rect starts at top-left of the lower-left corner and winds clockwise. If dir is kCCW Direction, Round Rect starts at the @@ -4878,10 +4878,10 @@ added unaltered. If mode is Path Verbs, Points, and Conic Weights to add dx - offset added to src Point Array x coordinates + offset added to src Point Array x-axis coordinates dy - offset added to src Point Array y coordinates + offset added to src Point Array y-axis coordinates mode kAppend AddPathMode or kExtend AddPathMode @@ -5006,10 +5006,10 @@ If dst is nullptr, Path is ### Parameters - + - + @@ -5070,10 +5070,10 @@ Offset Point Array by ( ### Parameters
dxoffset added to Point Array x coordinatesoffset added to Point Array x-axis coordinates
dyoffset added to Point Array y coordinatesoffset added to Point Array y-axis coordinates
dst overwritten, translated copy of Path; may be nullptr
- + - +
dxoffset added to Point Array x coordinatesoffset added to Point Array x-axis coordinates
dyoffset added to Point Array y coordinatesoffset added to Point Array y-axis coordinates
@@ -5204,10 +5204,10 @@ Set Last Point to (x ### Parameters - + - +
xset x-coordinate of Last Pointset x-axis value of Last Point
yset y-coordinate of Last Pointset y-axis value of Last Point
@@ -5370,10 +5370,10 @@ account FillType. ### Parameters - + - +
xx-coordinate of containment testx-axis value of containment test
yy-coordinate of containment testy-axis value of containment test
diff --git a/site/user/api/SkPoint_Reference.md b/site/user/api/SkPoint_Reference.md index a8145ed038..9e701b8a5f 100644 --- a/site/user/api/SkPoint_Reference.md +++ b/site/user/api/SkPoint_Reference.md @@ -768,7 +768,7 @@ Adds offset (dx, d SkScalar length() const -Returns the Euclidean_Distance from origin, computed as: +Returns the Euclidean Distance from origin, computed as: 
 sqrt(fX * fX + fY * fY)
@@ -797,7 +797,7 @@ straight-line distance to origin
 SkScalar distanceToOrigin() const
-Returns the Euclidean_Distance from origin, computed as: +Returns the Euclidean Distance from origin, computed as: 
 sqrt(fX * fX + fY * fY)
@@ -1501,7 +1501,7 @@ Can also be used to add Vector to Vector
 static SkScalar Length(SkScalar x, SkScalar y)
-Returns the Euclidean_Distance from origin, computed as: +Returns the Euclidean Distance from origin, computed as: 
 sqrt(x * x + y * y)
@@ -1576,7 +1576,7 @@ original vec length
 static SkScalar Distance(const SkPoint& a, const SkPoint& b)
-Returns the Euclidean_Distance between a and b. +Returns the Euclidean Distance between a and b. ### Parameters @@ -1745,4 +1745,4 @@ product of input magnitudes and cosine of the angle between them SkVector provides an alternative name for SkPoint. SkVector and SkPoint can -be used interchangably for all purposes. \ No newline at end of file +be used interchangeably for all purposes. \ No newline at end of file diff --git a/site/user/api/SkRect_Reference.md b/site/user/api/SkRect_Reference.md index 68f6aff8da..042e33a46d 100644 --- a/site/user/api/SkRect_Reference.md +++ b/site/user/api/SkRect_Reference.md @@ -2138,7 +2138,7 @@ If dy is positive, Rect ### Return Value -Rect offset in x or y, with original width and height +Rect offset on axes, with original width and height ### Example @@ -2693,16 +2693,16 @@ Returns false if either construction or Rect is empty, leavi ### Parameters - + - + - + - +
leftx minimum of constructed Rectx-axis minimum of constructed Rect
topy minimum of constructed Recty-axis minimum of constructed Rect
rightx maximum of constructed Rectx-axis maximum of constructed Rect
bottomy maximum of constructed Recty-axis maximum of constructed Rect
@@ -2790,16 +2790,16 @@ Returns false if either construction or Rect is empty, or do ### Parameters - + - + - + - +
leftx minimum of constructed Rectx-axis minimum of constructed Rect
topy minimum of constructed Recty-axis minimum of constructed Rect
rightx maximum of constructed Rectx-axis maximum of constructed Rect
bottomy maximum of constructed Recty-axis maximum of constructed Rect
@@ -2948,16 +2948,16 @@ Has no effect if construction is empty. Otherwise, if Rect i ### Parameters - + - + - + - +
leftx minimum of constructed Rectx-axis minimum of constructed Rect
topy minimum of constructed Recty-axis minimum of constructed Rect
rightx maximum of constructed Rectx-axis maximum of constructed Rect
bottomy maximum of constructed Recty-axis maximum of constructed Rect
diff --git a/site/user/api/SkSurface_Reference.md b/site/user/api/SkSurface_Reference.md index 7ae4bdfa70..76f2de6716 100644 --- a/site/user/api/SkSurface_Reference.md +++ b/site/user/api/SkSurface_Reference.md @@ -804,13 +804,13 @@ describes the pixel format in Color T Alpha Type, and color matching in Color Space. sampleCount requests the number of samples per pixel. -Pass zero to disable Multi_Sample_Anti_Aliasing. The request is rounded +Pass zero to disable Multi Sample Anti Aliasing. The request is rounded up to the next supported count, or rounded down if it is larger than the maximum supported count. surfaceOrigin pins either the top-left or the bottom-left corner to the origin. -shouldCreateWithMips hints that Image returned by makeImageSnapshot is Mip_Map. +shouldCreateWithMips hints that Image returned by makeImageSnapshot is Mip Map. If SK_SUPPORT_GPU is defined as zero, has no effect and returns nullptr. @@ -837,7 +837,7 @@ width, or height, or both, may be zero fonts; may be nullptr shouldCreateWithMips - hint that Surface will host Mip_Map images + hint that Surface will host Mip Map images @@ -870,7 +870,7 @@ describes the pixel format in Color T Alpha Type, and color matching in Color Space. sampleCount requests the number of samples per pixel. -Pass zero to disable Multi_Sample_Anti_Aliasing. The request is rounded +Pass zero to disable Multi Sample Anti Aliasing. The request is rounded up to the next supported count, or rounded down if it is larger than the maximum supported count. @@ -889,7 +889,7 @@ maximum supported count. of Raster Surface; width, or height, or both, may be zero sampleCount - samples per pixel, or 0 to disable Multi_Sample_Anti_Aliasing + samples per pixel, or 0 to disable Multi Sample Anti Aliasing props LCD striping orientation and setting for device independent @@ -1642,10 +1642,10 @@ Does not copy, and returns false if: storage for pixels copied from Surface srcX - offset into readable pixels in x; may be negative + offset into readable pixels on x-axis; may be negative srcY - offset into readable pixels in y; may be negative + offset into readable pixels on y-axis; may be negative @@ -1709,10 +1709,10 @@ Does not copy, and returns false if: size of one destination row; dstInfo.width times pixel size, or larger srcX - offset into readable pixels in x; may be negative + offset into readable pixels on x-axis; may be negative srcY - offset into readable pixels in y; may be negative + offset into readable pixels on y-axis; may be negative @@ -1775,10 +1775,10 @@ Does not copy, and returns false if: storage for pixels copied from Surface srcX - offset into readable pixels in x; may be negative + offset into readable pixels on x-axis; may be negative srcY - offset into readable pixels in y; may be negative + offset into readable pixels on y-axis; may be negative @@ -1818,10 +1818,10 @@ converting to Surface colorType() and storage for pixels to copy to Surface dstX - x position relative to Surface to begin copy; may be negative + x-axis position relative to Surface to begin copy; may be negative dstY - x position relative to Surface to begin copy; may be negative + y-axis position relative to Surface to begin copy; may be negative @@ -1856,10 +1856,10 @@ converting to Surface colorType() and storage for pixels to copy to Surface dstX - x position relative to Surface to begin copy; may be negative + x-axis position relative to Surface to begin copy; may be negative dstY - x position relative to Surface to begin copy; may be negative + y-axis position relative to Surface to begin copy; may be negative diff --git a/site/user/api/undocumented.md b/site/user/api/undocumented.md index 4a98ee8d7e..bb8977a294 100644 --- a/site/user/api/undocumented.md +++ b/site/user/api/undocumented.md @@ -13,6 +13,10 @@ undocumented # Class GrBackendSemaphore +# Bezier Curve + +# Big Endian + # Blend Mode ## Enum SkBlendMode @@ -43,6 +47,8 @@ undocumented +# Cartesian Coordinate + # Circle # Clip Op @@ -126,6 +132,8 @@ static bool Equals(const Coons Patch + # Core Graphics # Core Text @@ -217,6 +225,10 @@ void draw(S --- +# Euclidean Distance + +# Euclidean Space + # Filter Quality ## Enum SkFilterQuality @@ -282,6 +294,8 @@ void flush() --- +# GPU Share Group + # GPU Surface # GPU Texture @@ -290,10 +304,26 @@ void flush() # Grayscale +# HTML Aqua + # HTML Canvas ## ArcTo +# HTML DarkGray + +# HTML Fuchsia + +# HTML Gray + +# HTML Green + +# HTML LightGray + +# HTML Lime + +# HTML Silver + # ISize # Struct SkISize @@ -310,6 +340,8 @@ void flush() # Line +# Little Endian + # Mask Alpha # Mask Filter @@ -322,6 +354,8 @@ void flush() # Mip Map +# Multi Sample Anti Aliasing + # Nine Patch # OS X @@ -549,6 +583,10 @@ void dumpHex() const ## Arc +# SVG darkgray + +# SVG lightgray + # Scalar ## Typedef SkScalar @@ -667,6 +705,8 @@ bool isValid() const # Class SkTypeface +# UV Mapping + # Unhinted # Unpremultiply @@ -679,3 +719,8 @@ bool isValid() const ## Texs +# YUV Component U + +# YUV Component V + +# YUV Component Y diff --git a/tools/bookmaker/includeWriter.cpp b/tools/bookmaker/includeWriter.cpp index 38cd2232ef..c029421a8c 100644 --- a/tools/bookmaker/includeWriter.cpp +++ b/tools/bookmaker/includeWriter.cpp @@ -1170,7 +1170,6 @@ bool IncludeWriter::defineOut(const Definition& def) { } const Definition& bmhDef = defIter->second; this->constOut(&def, &bmhDef); - SkDebugf(""); return true; } @@ -1346,9 +1345,6 @@ bool IncludeWriter::populate(Definition* def, ParentPair* prevPair, RootDefiniti const Definition* requireDense = nullptr; const Definition* startDef = nullptr; for (auto& child : def->fTokens) { - if (39 == child.fLineCount) { - SkDebugf(""); - } if (KeyWord::kInline == child.fKeyWord) { continue; } diff --git a/tools/bookmaker/mdOut.cpp b/tools/bookmaker/mdOut.cpp index 0d28f9db01..76df5daca0 100644 --- a/tools/bookmaker/mdOut.cpp +++ b/tools/bookmaker/mdOut.cpp @@ -420,8 +420,8 @@ string MdOut::addReferences(const char* refStart, const char* refEnd, // see if this should have been a findable reference // look for Sk / sk / SK .. - if (!ref.compare(0, 2, "Sk") && ref != "Skew" && ref != "Skews" && - ref != "Skip" && ref != "Skips") { + if (!ref.compare(0, 2, "Sk") && ref != "Skew" && ref != "Skews" && ref != "Skewing" + && ref != "Skip" && ref != "Skips") { if (BmhParser::Resolvable::kOut != resolvable && BmhParser::Resolvable::kFormula != resolvable) { t.reportError("missed Sk prefixed"); diff --git a/tools/bookmaker/spellCheck.cpp b/tools/bookmaker/spellCheck.cpp index acf9e242a3..cd02178b56 100644 --- a/tools/bookmaker/spellCheck.cpp +++ b/tools/bookmaker/spellCheck.cpp @@ -25,6 +25,7 @@ struct CheckEntry { string fFile; int fLine; int fCount; + bool fOverride; }; class SpellCheck : public ParserCommon { @@ -63,6 +64,7 @@ private: fInFormula = false; fInDescription = false; fInStdOut = false; + fOverride = false; } void wordCheck(string str); @@ -84,6 +86,7 @@ private: bool fInDescription; bool fInFormula; bool fInStdOut; + bool fOverride; typedef ParserCommon INHERITED; }; @@ -121,7 +124,10 @@ bool SpellCheck::check(const char* match) { if (string::npos == fRoot->fFileName.rfind(match)) { continue; } - this->check(topicDef); + fOverride = string::npos != fRoot->fFileName.rfind("undocumented.bmh") + || string::npos != fRoot->fFileName.rfind("markup.bmh") + || string::npos != fRoot->fFileName.rfind("usingBookmaker.bmh"); + this->check(topicDef); } return true; } @@ -493,13 +499,7 @@ void SpellCheck::report(SkCommandLineFlags::StringArray report) { std::sort(elems.begin(), elems.end(), stringCompare); if (report.contains("once")) { for (auto iter : elems) { - if (string::npos != iter.second.fFile.find("undocumented.bmh")) { - continue; - } - if (string::npos != iter.second.fFile.find("markup.bmh")) { - continue; - } - if (string::npos != iter.second.fFile.find("usingBookmaker.bmh")) { + if (iter.second.fOverride) { continue; } if (iter.second.fCount == 1) { @@ -516,13 +516,7 @@ void SpellCheck::report(SkCommandLineFlags::StringArray report) { char lastInitial = 'a'; int count = 0; for (auto iter : elems) { - if (string::npos != iter.second.fFile.find("undocumented.bmh")) { - continue; - } - if (string::npos != iter.second.fFile.find("markup.bmh")) { - continue; - } - if (string::npos != iter.second.fFile.find("usingBookmaker.bmh")) { + if (iter.second.fOverride) { continue; } string check = iter.first.c_str(); @@ -554,13 +548,7 @@ void SpellCheck::report(SkCommandLineFlags::StringArray report) { int index = 0; const char* mispelled = report[0]; for (auto iter : elems) { - if (string::npos != iter.second.fFile.find("undocumented.bmh")) { - continue; - } - if (string::npos != iter.second.fFile.find("markup.bmh")) { - continue; - } - if (string::npos != iter.second.fFile.find("usingBookmaker.bmh")) { + if (iter.second.fOverride) { continue; } string check = iter.first.c_str(); @@ -662,12 +650,18 @@ void SpellCheck::wordCheck(string str) { sawDigit ? fDigits : fWords; auto iter = mappy.find(str); if (mappy.end() != iter) { + if (iter->second.fOverride && !fOverride) { + iter->second.fFile = fFileName; + iter->second.fLine = fLineCount + fLocalLine; + iter->second.fOverride = false; + } iter->second.fCount += 1; } else { CheckEntry* entry = &mappy[str]; entry->fFile = fFileName; entry->fLine = fLineCount + fLocalLine; entry->fCount = 1; + entry->fOverride = fOverride; } } -- cgit v1.2.3