AuroraMiddleware/skia2
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

refresh generated includes

Browse Source 
Found some bookmaker bugs that were suppressing
spelling errors and syntax errors.

TBR=reed@google.com

Bug: skia:6898
Change-Id: Ie7331dd03723d987cb2df46018a984f42d0ee518
Reviewed-on: https://skia-review.googlesource.com/134942
Reviewed-by: Cary Clark <caryclark@skia.org>
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
This commit is contained in:
Cary Clark 2018-06-14 13:21:08 -04:00 committed by Skia Commit-Bot
parent cf274da6fa
commit ca6a2454b8
10 changed files with 227 additions and 229 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
include/core/SkCanvas.h
View File

@ -6,7 +6,7 @@
*/
/* Generated by tools/bookmaker from include/core/SkCanvas.h and docs/SkCanvas_Reference.bmh
on 2018-06-08 11:48:28. Additional documentation and examples can be found at:
on 2018-06-14 13:13:33. Additional documentation and examples can be found at:
https://skia.org/user/api/SkCanvas_Reference
You may edit either file directly. Structural changes to public interfaces require
@ -343,8 +343,8 @@ public:
@param dstInfo width, height, SkColorType, and SkAlphaType 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
*/
bool readPixels(const SkImageInfo& dstInfo, void* dstPixels, size_t dstRowBytes,
@ -379,8 +379,8 @@ public:
- pixmap.rowBytes() is too small to contain one row of pixels.
@param pixmap storage for pixels copied from SkCanvas
@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
*/
bool readPixels(const SkPixmap& pixmap, int srcX, int srcY);
@ -414,8 +414,8 @@ public:
- bitmap.rowBytes() is too small to contain one row of pixels.
@param bitmap storage for pixels copied from SkCanvas
@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
*/
bool readPixels(const SkBitmap& bitmap, int srcX, int srcY);
@ -450,8 +450,8 @@ public:
@param info width, height, SkColorType, and SkAlphaType 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 SkCanvas writable pixels in x; may be negative
@param y offset into SkCanvas writable pixels in y; may be negative
@param x offset into SkCanvas writable pixels on x-axis; may be negative
@param y offset into SkCanvas writable pixels on y-axis; may be negative
@return true if pixels were written to SkCanvas
*/
bool writePixels(const SkImageInfo& info, const void* pixels, size_t rowBytes, int x, int y);
@ -809,22 +809,22 @@ public:
transforming the result with SkMatrix.
@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
*/
void rotate(SkScalar degrees, SkScalar px, SkScalar py);
/** Skew SkMatrix by sx on the x-axis and sy on the y-axis. A positive value of sx
skews 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 SkMatrix with a skew matrix premultiplied with SkMatrix.
This has the effect of skewing the drawing by (sx, sy) before transforming
the result with SkMatrix.
@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
*/
void skew(SkScalar sx, SkScalar sy);
@ -1317,8 +1317,8 @@ public:
SkPaint::Join.
@param rect SkRect bounds of SkRRect 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
*/
void drawRoundRect(const SkRect& rect, SkScalar rx, SkScalar ry, const SkPaint& paint);
@ -1761,8 +1761,8 @@ public:
kFixedColor, //!< draws one of fColors into lattice rectangle
};
const int* fXDivs; //!< x-coordinates dividing bitmap
const int* fYDivs; //!< y-coordinates dividing bitmap
const int* fXDivs; //!< x-axis values dividing bitmap
const int* fYDivs; //!< y-axis values dividing bitmap
const RectType* fRectTypes; //!< array of fill types
int fXCount; //!< number of x-coordinates
int fYCount; //!< number of y-coordinates
@ -1910,10 +1910,9 @@ public:
described by byteLength of text.
text meaning depends on SkPaint::TextEncoding; by default, text is encoded as
UTF-8. pos elements meaning depends on SkPaint 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 SkMatrix and
SkPaint text size.
UTF-8. pos elements meaning depends on SkPaint vertical text; by default
glyph left side bearing and baseline are relative to SkPoint in pos array.
Text size is affected by SkMatrix and SkPaint text size.
All elements of paint: SkPathEffect, SkMaskFilter, SkShader,
SkColorFilter, SkImageFilter, and SkDrawLooper; apply to text. By default, draws
@ -1950,8 +1949,8 @@ public:
@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
*/
void drawPosTextH(const void* text, size_t byteLength, const SkScalar xpos[], SkScalar constY,
@ -1967,8 +1966,8 @@ public:
text meaning depends on SkPaint::TextEncoding; by default, text is encoded as
UTF-8. Origin meaning depends on SkPaint::Align and SkPaint 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 SkMatrix and SkPaint text size.
default text positions the first glyph left side bearing and baseline relative
to origin. Text size is affected by SkMatrix and SkPaint text size.
All elements of paint: SkPathEffect, SkMaskFilter, SkShader,
SkColorFilter, SkImageFilter, and SkDrawLooper; apply to text. By default, draws
@ -1996,8 +1995,8 @@ public:
text meaning depends on SkPaint::TextEncoding; by default, text is encoded as
UTF-8. Origin meaning depends on SkPaint::Align and SkPaint 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, SkCanvas SkMatrix,
default text positions the first glyph left side bearing and baseline relative
to origin. Text size is affected by matrix parameter, SkCanvas SkMatrix,
and SkPaint text size.
All elements of paint: SkPathEffect, SkMaskFilter, SkShader,
@ -2150,12 +2149,12 @@ public:
*/
void drawVertices(const sk_sp<SkVertices>& vertices, 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 SkPoint, with each corner.
Coons_Patch uses clip and SkMatrix, paint SkShader, SkColorFilter,
Coons patch uses clip and SkMatrix, paint SkShader, SkColorFilter,
alpha, SkImageFilter, and SkBlendMode. If SkShader is provided it is treated
as Coons_Patch texture; SkBlendMode mode combines color colors and SkShader if
as Coons patch texture; SkBlendMode mode combines color colors and SkShader if
both are provided.
SkPoint array cubics specifies four SkPath cubic starting at the top-left corner,
@ -2178,12 +2177,12 @@ public:
void drawPatch(const SkPoint cubics[12], const SkColor colors[4],
const SkPoint texCoords[4], SkBlendMode mode, const SkPaint& paint);
/** Draws SkPath cubic Coons_Patch: the interpolation of four cubics with shared corners,
associating a color, and optionally a texture coordinate, with each corner.
/** Draws SkPath cubic Coons patch: the interpolation of four cubics with shared corners,
associating a color, and optionally a texture SkPoint, with each corner.
Coons_Patch uses clip and SkMatrix, paint SkShader, SkColorFilter,
Coons patch uses clip and SkMatrix, paint SkShader, SkColorFilter,
alpha, SkImageFilter, and SkBlendMode. If SkShader is provided it is treated
as Coons_Patch texture; SkBlendMode mode combines color colors and SkShader if
as Coons patch texture; SkBlendMode mode combines color colors and SkShader if
both are provided.
SkPoint array cubics specifies four SkPath cubic starting at the top-left corner,
@ -2319,8 +2318,8 @@ public:
immediate drawing, call SkDrawable::draw() instead.
@param drawable custom struct encapsulating drawing commands
@param x offset into SkCanvas writable pixels in x
@param y offset into SkCanvas writable pixels in y
@param x offset into SkCanvas writable pixels on x-axis
@param y offset into SkCanvas writable pixels on y-axis
*/
void drawDrawable(SkDrawable* drawable, SkScalar x, SkScalar y);

18
include/core/SkColor.h
View File

@ -6,7 +6,7 @@
*/
/* Generated by tools/bookmaker from include/core/SkColor.h and docs/SkColor_Reference.bmh
on 2018-06-08 11:48:28. Additional documentation and examples can be found at:
on 2018-06-14 13:13:34. Additional documentation and examples can be found at:
https://skia.org/user/api/SkColor_Reference
You may edit either file directly. Structural changes to public interfaces require
@ -108,17 +108,17 @@ constexpr SkColor SK_ColorTRANSPARENT = SkColorSetARGB(0x00, 0x00, 0x00, 0x00);
constexpr SkColor SK_ColorBLACK = SkColorSetARGB(0xFF, 0x00, 0x00, 0x00);
/** Represents fully opaque dark gray.
Note that SVG_darkgray is equivalent to 0xFFA9A9A9.
Note that SVG dark gray is equivalent to 0xFFA9A9A9.
*/
constexpr SkColor SK_ColorDKGRAY = SkColorSetARGB(0xFF, 0x44, 0x44, 0x44);
/** Represents fully opaque gray.
Note that HTML_Gray is equivalent to 0xFF808080.
Note that HTML gray is equivalent to 0xFF808080.
*/
constexpr SkColor SK_ColorGRAY = SkColorSetARGB(0xFF, 0x88, 0x88, 0x88);
/** 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 light gray is equivalent to 0xFFD3D3D3.
*/
constexpr SkColor SK_ColorLTGRAY = SkColorSetARGB(0xFF, 0xCC, 0xCC, 0xCC);
@ -130,8 +130,8 @@ constexpr SkColor SK_ColorWHITE = SkColorSetARGB(0xFF, 0xFF, 0xFF, 0xFF);
*/
constexpr SkColor SK_ColorRED = SkColorSetARGB(0xFF, 0xFF, 0x00, 0x00);
/** 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.
*/
constexpr SkColor SK_ColorGREEN = SkColorSetARGB(0xFF, 0x00, 0xFF, 0x00);
@ -143,11 +143,11 @@ constexpr SkColor SK_ColorBLUE = SkColorSetARGB(0xFF, 0x00, 0x00, 0xFF);
*/
constexpr SkColor SK_ColorYELLOW = SkColorSetARGB(0xFF, 0xFF, 0xFF, 0x00);
/** Represents fully opaque cyan. HTML_Aqua is equivalent.
/** Represents fully opaque cyan. HTML aqua is equivalent.
*/
constexpr SkColor SK_ColorCYAN = SkColorSetARGB(0xFF, 0x00, 0xFF, 0xFF);
/** Represents fully opaque magenta. HTML_Fuchsia is equivalent.
/** Represents fully opaque magenta. HTML fuchsia is equivalent.
*/
constexpr SkColor SK_ColorMAGENTA = SkColorSetARGB(0xFF, 0xFF, 0x00, 0xFF);

35
include/core/SkImage.h
View File

@ -6,7 +6,7 @@
*/
/* Generated by tools/bookmaker from include/core/SkImage.h and docs/SkImage_Reference.bmh
on 2018-06-08 11:48:28. Additional documentation and examples can be found at:
on 2018-06-14 13:13:34. Additional documentation and examples can be found at:
https://skia.org/user/api/SkImage_Reference
You may edit either file directly. Structural changes to public interfaces require
@ -243,7 +243,7 @@ public:
/** Creates SkImage from encoded data. SkImage is uploaded to GPU back-end using context.
Created SkImage 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 SkImage is no longer referenced, context releases texture memory
@ -260,7 +260,7 @@ public:
@param context GPU context
@param data SkImage to decode
@param buildMips create SkImage as Mip_Map if true
@param buildMips create SkImage as mip map if true
@param dstColorSpace range of colors of matching SkSurface on GPU
@param limitToMaxTextureSize downscale image to GPU maximum texture size, if necessary
@return created SkImage, or nullptr
@ -272,7 +272,7 @@ public:
/** Creates SkImage from pixmap. SkImage is uploaded to GPU back-end using context.
Created SkImage 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 SkImage is no longer referenced, context releases texture memory
@ -289,7 +289,7 @@ public:
@param context GPU context
@param pixmap SkImageInfo, pixel address, and row bytes
@param buildMips create SkImage as Mip_Map if true
@param buildMips create SkImage as mip map if true
@param dstColorSpace range of colors of matching SkSurface on GPU
@param limitToMaxTextureSize downscale image to GPU maximum texture size, if necessary
@return created SkImage, or nullptr
@ -343,9 +343,9 @@ public:
sk_sp<SkColorSpace> colorSpace = nullptr);
/** Creates SkImage 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 SkImage has the dimensions nv12Textures[2].
yuvColorSpace describes how YUV colors convert to RGB colors.
@ -498,10 +498,10 @@ public:
SkShader::TileMode rules to fill drawn area outside SkImage. localMatrix permits
transforming SkImage before SkCanvas matrix is applied.
@param tileMode1 tiling in x, 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 tileMode1 tiling on x-axis, 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 SkImage transformation, or nullptr
@return SkShader containing SkImage
*/
@ -740,18 +740,17 @@ public:
sk_sp<SkImage> makeSubset(const SkIRect& subset) const;
/** Returns SkImage backed by GPU texture associated with context. Returned SkImage is
compatible with SkSurface created with dstColorSpace. The returned SkImage will also
support the request GrMipMapped status. In other words if mipMapped is GrMipMapped::kYes,
then the backing texture will have mip map levles allocated. Returns original SkImage if
context and dstColorSpace match and mipMapped is compatible with the backing GPU_Texture.
compatible with SkSurface created with dstColorSpace. The returned SkImage respects
mipMapped setting; if mipMapped equals GrMipMapped::kYes, the backing texture
allocates mip map levels. Returns original SkImage if context
and dstColorSpace match and mipMapped is compatible with backing GPU texture.
Returns nullptr if context is nullptr, or if SkImage was created with another
GrContext.
@param context GPU context
@param dstColorSpace range of colors of matching SkSurface on GPU
@param mipMapped whether the returned SkImage's texture must have allocated Mip_Map
levels.
@param mipMapped whether created SkImage texture must allocate mip map levels
@return created SkImage, or nullptr
*/
sk_sp<SkImage> makeTextureImage(GrContext* context, SkColorSpace* dstColorSpace,

6
include/core/SkImageInfo.h
View File

@ -6,7 +6,7 @@
*/
/* Generated by tools/bookmaker from include/core/SkImageInfo.h and docs/SkImageInfo_Reference.bmh
on 2018-06-08 11:48:28. Additional documentation and examples can be found at:
on 2018-06-14 13:13:34. Additional documentation and examples can be found at:
https://skia.org/user/api/SkImageInfo_Reference
You may edit either file directly. Structural changes to public interfaces require
@ -76,9 +76,9 @@ static inline bool SkAlphaTypeIsOpaque(SkAlphaType at) {
Describes how pixel bits encode color. A pixel may be an alpha mask, a
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.
*/
enum SkColorType {

100
include/core/SkMatrix.h
View File

@ -6,7 +6,7 @@
*/
/* Generated by tools/bookmaker from include/core/SkMatrix.h and docs/SkMatrix_Reference.bmh
on 2018-06-08 11:48:28. Additional documentation and examples can be found at:
on 2018-06-14 13:13:34. Additional documentation and examples can be found at:
https://skia.org/user/api/SkMatrix_Reference
You may edit either file directly. Structural changes to public interfaces require
@ -102,8 +102,8 @@ public:
@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 SkMatrix constructed from parameters
*/
@ -179,7 +179,7 @@ public:
bool isTranslate() const { return !(this->getType() & ~(kTranslate_Mask)); }
/** Returns true SkMatrix maps SkRect to another SkRect. If true, SkMatrix 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, SkMatrix may also have translation. SkMatrix form is either:
| scale-x 0 translate-x |
@ -207,7 +207,7 @@ public:
}
/** Returns true SkMatrix maps SkRect to another SkRect. If true, SkMatrix 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, SkMatrix may also have translation. SkMatrix form is either:
| scale-x 0 translate-x |
@ -252,7 +252,7 @@ public:
Describes that the SkMatrix 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.
@ -321,59 +321,59 @@ public:
return fMat[index];
}
/** 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 SkPoint along the x-axis.
@return horizontal scale factor
*/
SkScalar getScaleX() const { return fMat[kMScaleX]; }
/** 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 SkPoint along the y-axis.
@return vertical scale factor
*/
SkScalar getScaleY() const { return fMat[kMScaleY]; }
/** 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 SkPoint along the y-axis.
Skew x and y together can rotate SkPoint.
Skewing both axes can rotate SkPoint.
@return vertical skew factor
*/
SkScalar getSkewY() const { return fMat[kMSkewY]; }
/** 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 SkPoint along the x-axis.
Skew x and y together can rotate SkPoint.
Skewing both axes can rotate SkPoint.
@return horizontal scale factor
*/
SkScalar getSkewX() const { return fMat[kMSkewX]; }
/** Returns translation contributing to x output.
/** Returns translation contributing to x-axis output.
With mapPoints(), moves SkPoint along the x-axis.
@return horizontal translation factor
*/
SkScalar getTranslateX() const { return fMat[kMTransX]; }
/** Returns translation contributing to y output.
/** Returns translation contributing to y-axis output.
With mapPoints(), moves SkPoint along the y-axis.
@return vertical translation factor
*/
SkScalar getTranslateY() const { return fMat[kMTransY]; }
/** 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
*/
SkScalar getPerspX() const { return fMat[kMPersp0]; }
/** 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
*/
SkScalar getPerspY() const { return fMat[kMPersp1]; }
@ -442,15 +442,15 @@ public:
*/
void setTranslateY(SkScalar v) { this->set(kMTransY, 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.
@param v perspective factor
*/
void setPerspX(SkScalar v) { this->set(kMPersp0, 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.
@param v perspective factor
*/
@ -468,8 +468,8 @@ public:
@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
*/
void setAll(SkScalar scaleX, SkScalar skewX, SkScalar transX,
@ -591,10 +591,10 @@ public:
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
*/
void setSinCos(SkScalar sinValue, SkScalar cosValue,
SkScalar px, SkScalar py);
@ -604,8 +604,8 @@ public:
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
*/
void setSinCos(SkScalar sinValue, SkScalar cosValue);
@ -671,8 +671,8 @@ public:
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 SkMatrix
@param dy y translation before applying SkMatrix
@param dx x-axis translation before applying SkMatrix
@param dy y-axis translation before applying SkMatrix
*/
void preTranslate(SkScalar dx, SkScalar dy);
@ -866,8 +866,8 @@ public:
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 SkMatrix
@param dy y translation after applying SkMatrix
@param dx x-axis translation after applying SkMatrix
@param dy y-axis translation after applying SkMatrix
*/
void postTranslate(SkScalar dx, SkScalar dy);
@ -1289,8 +1289,8 @@ public:
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 SkPoint to map
@param y y-coordinate of SkPoint to map
@param x x-axis value of SkPoint to map
@param y y-axis value of SkPoint to map
@param result storage for mapped SkPoint
*/
void mapXY(SkScalar x, SkScalar y, SkPoint* result) const {
@ -1310,8 +1310,8 @@ public:
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 SkPoint to map
@param y y-coordinate of SkPoint to map
@param x x-axis value of SkPoint to map
@param y y-axis value of SkPoint to map
@return mapped SkPoint
*/
SkPoint mapXY(SkScalar x, SkScalar y) const {
@ -1389,8 +1389,8 @@ public:
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
*/
void mapVector(SkScalar dx, SkScalar dy, SkVector* result) const {
@ -1411,8 +1411,8 @@ public:
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
*/
SkVector mapVector(SkScalar dx, SkScalar dy) const {
@ -1505,9 +1505,9 @@ public:
*/
SkScalar mapRadius(SkScalar radius) const;
/** Returns true if a unit step in x at some y mapped through SkMatrix 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 SkMatrix
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 SkMatrix
does not include rotation or skewing along the y-axis.
@ -1516,11 +1516,11 @@ public:
*/
bool isFixedStepInX() const;
/** Returns vector representing a unit step in x at y mapped through SkMatrix.
/** Returns vector representing a unit step on x-axis at y mapped through SkMatrix.
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
*/
SkVector fixedStepInX(SkScalar y) const;
@ -1600,8 +1600,8 @@ public:
/** Decomposes SkMatrix into scale components and whatever remains. Returns false if
SkMatrix could not be decomposed.
Sets scale to portion of SkMatrix that scales in x and y. Sets remaining to SkMatrix
with x and y scaling factored out. remaining may be passed as nullptr
Sets scale to portion of SkMatrix that scale axes. Sets remaining to SkMatrix
with scaling factored out. remaining may be passed as nullptr
to determine if SkMatrix can be decomposed without computing remainder.
Returns true if scale components are found. scale and remaining are
@ -1611,7 +1611,7 @@ public:
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 SkMatrix without scaling; may be nullptr
@return true if scale can be computed
*/

16
include/core/SkPaint.h
View File

@ -6,7 +6,7 @@
*/
/* Generated by tools/bookmaker from include/core/SkPaint.h and docs/SkPaint_Reference.bmh
on 2018-06-08 11:48:28. Additional documentation and examples can be found at:
on 2018-06-14 13:13:33. Additional documentation and examples can be found at:
https://skia.org/user/api/SkPaint_Reference
You may edit either file directly. Structural changes to public interfaces require
@ -974,9 +974,9 @@ public:
computed by font manager using SkTypeface. 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.
@ -1243,8 +1243,8 @@ public:
@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
*/
void getTextPath(const void* text, size_t length, SkScalar x, SkScalar y,
@ -1279,8 +1279,8 @@ public:
@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
@return number of intersections; may be zero

98
include/core/SkPath.h
View File

@ -6,7 +6,7 @@
*/
/* Generated by tools/bookmaker from include/core/SkPath.h and docs/SkPath_Reference.bmh
on 2018-06-08 11:48:28. Additional documentation and examples can be found at:
on 2018-06-14 13:13:34. Additional documentation and examples can be found at:
https://skia.org/user/api/SkPath_Reference
You may edit either file directly. Structural changes to public interfaces require
@ -29,7 +29,7 @@ class SkWStream;
/** \class SkPath
SkPath contain geometry. SkPath may be empty, or contain one or more verbs that
outline a figure. SkPath always starts with a move verb to a Cartesian_Coordinate,
outline a figure. SkPath 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.
SkPath may contain any number of contours, each beginning with a move verb.
@ -476,7 +476,7 @@ public:
*/
void swap(SkPath& other);
/** Returns minimum and maximum x and y values of SkPoint array.
/** Returns minimum and maximum axes values of SkPoint array.
Returns (0, 0, 0, 0) if SkPath contains no points. Returned bounds width and height may
be larger or smaller than area affected when SkPath is drawn.
@ -502,7 +502,7 @@ public:
this->getBounds();
}
/** Returns minimum and maximum x and y values of the lines and curves in SkPath.
/** Returns minimum and maximum axes values of the lines and curves in SkPath.
Returns (0, 0, 0, 0) if SkPath contains no points.
Returned bounds width and height may be larger or smaller than area affected
when SkPath is drawn.
@ -542,8 +542,8 @@ public:
/** Adds beginning of contour at SkPoint (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
*/
void moveTo(SkScalar x, SkScalar y);
@ -560,8 +560,8 @@ public:
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
*/
void rMoveTo(SkScalar dx, SkScalar dy);
@ -596,8 +596,8 @@ public:
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
*/
void rLineTo(SkScalar dx, SkScalar dy);
@ -642,10 +642,10 @@ public:
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
*/
void rQuadTo(SkScalar dx1, SkScalar dy1, SkScalar dx2, SkScalar dy2);
@ -714,10 +714,10 @@ public:
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
*/
void rConicTo(SkScalar dx1, SkScalar dy1, SkScalar dx2, SkScalar dy2,
@ -769,12 +769,12 @@ public:
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
*/
void rCubicTo(SkScalar x1, SkScalar y1, SkScalar x2, SkScalar y2,
SkScalar x3, SkScalar y3);
@ -800,10 +800,10 @@ public:
last SkPath point (x0, y0) to (x1, y1), and tangent from (x1, y1) to (x2, y2). Arc
is part of circle sized to radius, positioned so it touches both tangent lines.
@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
*/
void arcTo(SkScalar x1, SkScalar y1, SkScalar x2, SkScalar y2, SkScalar radius);
@ -879,7 +879,7 @@ public:
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
@ -907,13 +907,13 @@ public:
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 SkPath SkPoint
@param dy y offset end of arc from last SkPath SkPoint
@param dx x-axis offset end of arc from last SkPath SkPoint
@param dy y-axis offset end of arc from last SkPath SkPoint
*/
void rArcTo(SkScalar rx, SkScalar ry, SkScalar xAxisRotate, ArcSize largeArc,
Direction sweep, SkScalar dx, SkScalar dy);
@ -1040,10 +1040,10 @@ public:
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 SkRect
@param top smaller y of SkRect
@param right larger x of SkRect
@param bottom larger y of SkRect
@param left smaller x-axis value of SkRect
@param top smaller y-axis value of SkRect
@param right larger x-axis value of SkRect
@param bottom larger y-axis value of SkRect
@param dir SkPath::Direction to wind added contour
*/
void addRect(SkScalar left, SkScalar top, SkScalar right, SkScalar bottom,
@ -1112,8 +1112,8 @@ public:
After appending, SkPath may be empty, or may contain: SkRect, oval, or RoundRect.
@param rect bounds of SkRRect
@param rx x-radius of rounded corners on the SkRRect
@param ry y-radius of rounded corners on the SkRRect
@param rx x-axis radius of rounded corners on the SkRRect
@param ry y-axis radius of rounded corners on the SkRRect
@param dir SkPath::Direction to wind SkRRect
*/
void addRoundRect(const SkRect& rect, SkScalar rx, SkScalar ry,
@ -1182,8 +1182,8 @@ public:
verbs, SkPoint, and conic weights.
@param src SkPath verbs, SkPoint, and conic weights to add
@param dx offset added to src SkPoint array x coordinates
@param dy offset added to src SkPoint array y coordinates
@param dx offset added to src SkPoint array x-axis coordinates
@param dy offset added to src SkPoint array y-axis coordinates
@param mode kAppend_AddPathMode or kExtend_AddPathMode
*/
void addPath(const SkPath& src, SkScalar dx, SkScalar dy,
@ -1227,16 +1227,16 @@ public:
/** Offset SkPoint array by (dx, dy). Offset SkPath replaces dst.
If dst is nullptr, SkPath is replaced by offset data.
@param dx offset added to SkPoint array x coordinates
@param dy offset added to SkPoint array y coordinates
@param dx offset added to SkPoint array x-axis coordinates
@param dy offset added to SkPoint array y-axis coordinates
@param dst overwritten, translated copy of SkPath; may be nullptr
*/
void offset(SkScalar dx, SkScalar dy, SkPath* dst) const;
/** Offset SkPoint array by (dx, dy). SkPath is replaced by offset data.
@param dx offset added to SkPoint array x coordinates
@param dy offset added to SkPoint array y coordinates
@param dx offset added to SkPoint array x-axis coordinates
@param dy offset added to SkPoint array y-axis coordinates
*/
void offset(SkScalar dx, SkScalar dy) {
this->offset(dx, dy, this);
@ -1273,8 +1273,8 @@ public:
/** Set last point to (x, y). If SkPoint array is empty, append kMove_Verb to
verb array and append (x, y) to SkPoint 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
*/
void setLastPt(SkScalar x, SkScalar y);
@ -1504,8 +1504,8 @@ public:
/** Returns true if the point (x, y) is contained by SkPath, taking into
account FillType.
@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 SkPoint is in SkPath
*/
bool contains(SkScalar x, SkScalar y) const;

12
include/core/SkPoint.h
View File

@ -6,7 +6,7 @@
*/
/* Generated by tools/bookmaker from include/core/SkPoint.h and docs/SkPoint_Reference.bmh
on 2018-06-08 11:48:28. Additional documentation and examples can be found at:
on 2018-06-14 13:13:34. Additional documentation and examples can be found at:
https://skia.org/user/api/SkPoint_Reference
You may edit either file directly. Structural changes to public interfaces require
@ -159,7 +159,7 @@ struct SkIPoint {
struct SkPoint;
/** SkVector provides an alternative name for SkPoint. SkVector and SkPoint can
be used interchangably for all purposes.
be used interchangeably for all purposes.
*/
typedef SkPoint SkVector;
@ -277,7 +277,7 @@ struct SK_API SkPoint {
fY += dy;
}
/** Returns the Euclidean_Distance from origin, computed as:
/** Returns the Euclidean distance from origin, computed as:
sqrt(fX * fX + fY * fY)
@ -287,7 +287,7 @@ struct SK_API SkPoint {
*/
SkScalar length() const { return SkPoint::Length(fX, fY); }
/** Returns the Euclidean_Distance from origin, computed as:
/** Returns the Euclidean distance from origin, computed as:
sqrt(fX * fX + fY * fY)
@ -474,7 +474,7 @@ struct SK_API SkPoint {
return {a.fX + b.fX, a.fY + b.fY};
}
/** Returns the Euclidean_Distance from origin, computed as:
/** Returns the Euclidean distance from origin, computed as:
sqrt(x * x + y * y)
@ -499,7 +499,7 @@ struct SK_API SkPoint {
*/
static SkScalar Normalize(SkVector* vec);
/** Returns the Euclidean_Distance between a and b.
/** Returns the Euclidean distance between a and b.
@param a line end point
@param b line end point

62
include/core/SkRect.h
View File

@ -6,7 +6,7 @@
*/
/* Generated by tools/bookmaker from include/core/SkRect.h and docs/SkRect_Reference.bmh
on 2018-06-08 11:48:28. Additional documentation and examples can be found at:
on 2018-06-14 13:13:34. Additional documentation and examples can be found at:
https://skia.org/user/api/SkRect_Reference
You may edit either file directly. Structural changes to public interfaces require
@ -290,7 +290,7 @@ struct SK_API SkIRect {
@param dx offset added to fLeft and fRight
@param dy offset added to fTop and fBottom
@return SkIRect offset in x or y, with original width and height
@return SkIRect offset by dx and dy, with original width and height
*/
SkIRect makeOffset(int32_t dx, int32_t dy) const {
return {
@ -451,10 +451,10 @@ struct SK_API SkIRect {
Returns true if SkIRect contains construction.
Returns false if SkIRect is empty or construction is empty.
@param left x minimum of constructed SkIRect
@param top y minimum of constructed SkIRect
@param right x maximum of constructed SkIRect
@param bottom y maximum of constructed SkIRect
@param left x-axis minimum of constructed SkIRect
@param top y-axis minimum of constructed SkIRect
@param right x-axis maximum of constructed SkIRect
@param bottom y-axis maximum of constructed SkIRect
@return true if all sides of SkIRect are outside construction
*/
bool contains(int32_t left, int32_t top, int32_t right, int32_t bottom) const {
@ -495,10 +495,10 @@ struct SK_API SkIRect {
Return is undefined if SkIRect is empty or construction is empty.
@param left x minimum of constructed SkIRect
@param top y minimum of constructed SkIRect
@param right x maximum of constructed SkIRect
@param bottom y maximum of constructed SkIRect
@param left x-axis minimum of constructed SkIRect
@param top y-axis minimum of constructed SkIRect
@param right x-axis maximum of constructed SkIRect
@param bottom y-axis maximum of constructed SkIRect
@return true if all sides of SkIRect are outside construction
*/
bool containsNoEmptyCheck(int32_t left, int32_t top,
@ -582,10 +582,10 @@ struct SK_API SkIRect {
Returns false if either construction or SkIRect is empty, leaving SkIRect unchanged.
@param left x minimum of constructed SkIRect
@param top y minimum of constructed SkIRect
@param right x maximum of constructed SkIRect
@param bottom y maximum of constructed SkIRect
@param left x-axis minimum of constructed SkIRect
@param top y-axis minimum of constructed SkIRect
@param right x-axis maximum of constructed SkIRect
@param bottom y-axis maximum of constructed SkIRect
@return true if construction and SkIRect have area in common
*/
bool intersect(int32_t left, int32_t top, int32_t right, int32_t bottom) {
@ -624,10 +624,10 @@ struct SK_API SkIRect {
Has no effect if construction is empty. Otherwise, if SkIRect is empty, sets
SkIRect to construction.
@param left x minimum of constructed SkIRect
@param top y minimum of constructed SkIRect
@param right x maximum of constructed SkIRect
@param bottom y maximum of constructed SkIRect
@param left x-axis minimum of constructed SkIRect
@param top y-axis minimum of constructed SkIRect
@param right x-axis maximum of constructed SkIRect
@param bottom y-axis maximum of constructed SkIRect
*/
void join(int32_t left, int32_t top, int32_t right, int32_t bottom);
@ -1143,7 +1143,7 @@ struct SK_API SkRect {
@param dx added to fLeft and fRight
@param dy added to fTop and fBottom
@return SkRect offset in x or y, with original width and height
@return SkRect offset on axes, with original width and height
*/
SkRect makeOffset(SkScalar dx, SkScalar dy) const {
return MakeLTRB(fLeft + dx, fTop + dy, fRight + dx, fBottom + dy);
@ -1270,10 +1270,10 @@ struct SK_API SkRect {
Returns false if either construction or SkRect is empty, leaving SkRect unchanged.
@param left x minimum of constructed SkRect
@param top y minimum of constructed SkRect
@param right x maximum of constructed SkRect
@param bottom y maximum of constructed SkRect
@param left x-axis minimum of constructed SkRect
@param top y-axis minimum of constructed SkRect
@param right x-axis maximum of constructed SkRect
@param bottom y-axis maximum of constructed SkRect
@return true if construction and SkRect have area in common
*/
bool intersect(SkScalar left, SkScalar top, SkScalar right, SkScalar bottom);
@ -1308,10 +1308,10 @@ public:
Returns true if SkRect intersects construction.
Returns false if either construction or SkRect is empty, or do not intersect.
@param left x minimum of constructed SkRect
@param top y minimum of constructed SkRect
@param right x maximum of constructed SkRect
@param bottom y maximum of constructed SkRect
@param left x-axis minimum of constructed SkRect
@param top y-axis minimum of constructed SkRect
@param right x-axis maximum of constructed SkRect
@param bottom y-axis maximum of constructed SkRect
@return true if construction and SkRect have area in common
*/
bool intersects(SkScalar left, SkScalar top, SkScalar right, SkScalar bottom) const {
@ -1349,10 +1349,10 @@ public:
Has no effect if construction is empty. Otherwise, if SkRect is empty, sets
SkRect to construction.
@param left x minimum of constructed SkRect
@param top y minimum of constructed SkRect
@param right x maximum of constructed SkRect
@param bottom y maximum of constructed SkRect
@param left x-axis minimum of constructed SkRect
@param top y-axis minimum of constructed SkRect
@param right x-axis maximum of constructed SkRect
@param bottom y-axis maximum of constructed SkRect
*/
void join(SkScalar left, SkScalar top, SkScalar right, SkScalar bottom);

32
include/core/SkSurface.h
View File

@ -6,7 +6,7 @@
*/
/* Generated by tools/bookmaker from include/core/SkSurface.h and docs/SkSurface_Reference.bmh
on 2018-06-08 11:48:28. Additional documentation and examples can be found at:
on 2018-06-14 13:13:34. Additional documentation and examples can be found at:
https://skia.org/user/api/SkSurface_Reference
You may edit either file directly. Structural changes to public interfaces require
@ -277,13 +277,13 @@ public:
SkAlphaType, and color matching in SkColorSpace.
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 SkImage returned by makeImageSnapshot() is Mip_Map.
shouldCreateWithMips hints that SkImage returned by makeImageSnapshot() is mip map.
If SK_SUPPORT_GPU is defined as zero, has no effect and returns nullptr.
@ -295,7 +295,7 @@ public:
@param surfaceOrigin one of: kBottomLeft_GrSurfaceOrigin, kTopLeft_GrSurfaceOrigin
@param surfaceProps LCD striping orientation and setting for device independent
fonts; may be nullptr
@param shouldCreateWithMips hint that SkSurface will host Mip_Map images
@param shouldCreateWithMips hint that SkSurface will host mip map images
@return SkSurface if all parameters are valid; otherwise, nullptr
*/
static sk_sp<SkSurface> MakeRenderTarget(GrContext* context, SkBudgeted budgeted,
@ -311,7 +311,7 @@ public:
SkAlphaType, and color matching in SkColorSpace.
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.
@ -321,7 +321,7 @@ public:
@param budgeted one of: SkBudgeted::kNo, SkBudgeted::kYes
@param imageInfo width, height, SkColorType, SkAlphaType, SkColorSpace,
of raster surface; width, or height, or both, may be zero
@param sampleCount samples per pixel, or 0 to disable Multi_Sample_Anti_Aliasing
@param sampleCount samples per pixel, or 0 to disable multi-sample anti-aliasing
@param props LCD striping orientation and setting for device independent
fonts; may be nullptr
@return SkSurface if all parameters are valid; otherwise, nullptr
@ -537,8 +537,8 @@ public:
- dst.rowBytes() is too small to contain one row of pixels.
@param dst storage for pixels copied from SkSurface
@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
*/
bool readPixels(const SkPixmap& dst, int srcX, int srcY);
@ -568,8 +568,8 @@ public:
@param dstInfo width, height, SkColorType, and SkAlphaType 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
*/
bool readPixels(const SkImageInfo& dstInfo, void* dstPixels, size_t dstRowBytes,
@ -599,8 +599,8 @@ public:
- dst.rowBytes() is too small to contain one row of pixels.
@param dst storage for pixels copied from SkSurface
@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
*/
bool readPixels(const SkBitmap& dst, int srcX, int srcY);
@ -613,8 +613,8 @@ public:
converting to SkSurface colorType() and SkSurface alphaType() if required.
@param src storage for pixels to copy to SkSurface
@param dstX x position relative to SkSurface to begin copy; may be negative
@param dstY x position relative to SkSurface to begin copy; may be negative
@param dstX x-axis position relative to SkSurface to begin copy; may be negative
@param dstY y-axis position relative to SkSurface to begin copy; may be negative
*/
void writePixels(const SkPixmap& src, int dstX, int dstY);
@ -626,8 +626,8 @@ public:
converting to SkSurface colorType() and SkSurface alphaType() if required.
@param src storage for pixels to copy to SkSurface
@param dstX x position relative to SkSurface to begin copy; may be negative
@param dstY x position relative to SkSurface to begin copy; may be negative
@param dstX x-axis position relative to SkSurface to begin copy; may be negative
@param dstY y-axis position relative to SkSurface to begin copy; may be negative
*/
void writePixels(const SkBitmap& src, int dstX, int dstY);