diff options
author | Cary Clark <caryclark@skia.org> | 2018-02-01 09:37:32 -0500 |
---|---|---|
committer | Skia Commit-Bot <skia-commit-bot@chromium.org> | 2018-02-01 15:09:17 +0000 |
commit | 08895c48144cedaf81006803afe4a5a2becfdb92 (patch) | |
tree | 395b9eece35410bc75115e16a2c6b86e6bf35de8 /site | |
parent | 4dab72f60664b50f66cdd1b26a59bfa873e899f7 (diff) |
auto table generation
Replace manually entered summary tables with ones that are populated
and sorted by bookmaker. This introduces a slight regression for
anonymous enums but fixes a lot of bugs and omissions.
The format is
#Topic somethingTopical
#Populate
##
where somethingTopical is one of Subtopics, Constructors, Constants,
Classes_and_Structs, Members, Member_Functions, and Related_Functions.
Fix the bad formatting in SkCanvas reference. The #Error tag was
was corrupting the markdown table. Remove the tag and replace it
with #NoExample.
Next up: revise self-check to know about populated topics.
TBR=caryclark@google.com
Docs-Preview: https://skia.org/?cl=102080
Bug: skia:6898
Change-Id: Idef5d1c14c740c18a81d6a5106182788dd2a09e1
Reviewed-on: https://skia-review.googlesource.com/102080
Commit-Queue: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
Diffstat (limited to 'site')
-rw-r--r-- | site/user/api/SkAutoCanvasRestore_Reference.md | 21 | ||||
-rw-r--r-- | site/user/api/SkBitmap_Reference.md | 45 | ||||
-rw-r--r-- | site/user/api/SkCanvas_Reference.md | 72 | ||||
-rw-r--r-- | site/user/api/SkIPoint16_Reference.md | 26 | ||||
-rw-r--r-- | site/user/api/SkIPoint_Reference.md | 36 | ||||
-rw-r--r-- | site/user/api/SkIRect_Reference.md | 17 | ||||
-rw-r--r-- | site/user/api/SkImageInfo_Reference.md | 89 | ||||
-rw-r--r-- | site/user/api/SkImage_Reference.md | 44 | ||||
-rw-r--r-- | site/user/api/SkMatrix_Reference.md | 212 | ||||
-rw-r--r-- | site/user/api/SkPaint_Reference.md | 165 | ||||
-rw-r--r-- | site/user/api/SkPath_Reference.md | 59 | ||||
-rw-r--r-- | site/user/api/SkPixmap_Reference.md | 28 | ||||
-rw-r--r-- | site/user/api/SkPoint_Reference.md | 97 | ||||
-rw-r--r-- | site/user/api/SkRect_Reference.md | 17 | ||||
-rw-r--r-- | site/user/api/SkSurface_Reference.md | 29 |
15 files changed, 537 insertions, 420 deletions
diff --git a/site/user/api/SkAutoCanvasRestore_Reference.md b/site/user/api/SkAutoCanvasRestore_Reference.md index 2f1b2361ee..901e763ed4 100644 --- a/site/user/api/SkAutoCanvasRestore_Reference.md +++ b/site/user/api/SkAutoCanvasRestore_Reference.md @@ -3,29 +3,29 @@ SkAutoCanvasRestore Reference # <a name="Automatic_Canvas_Restore"></a> Automatic Canvas Restore -# <a name="SkAutoCanvasRestore"></a> Class SkAutoCanvasRestore -Stack helper class calls - -# <a name="Overview"></a> Overview +## <a name="Overview"></a> Overview ## <a name="Subtopics"></a> Subtopics | name | description | -| --- | --- | -| <a href="SkAutoCanvasRestore_Reference#Automatic_Canvas_Restore_Overview_Constructors">Constructors</a> | functions that construct <a href="#SkAutoCanvasRestore">SkAutoCanvasRestore</a> | -| <a href="SkAutoCanvasRestore_Reference#Automatic_Canvas_Restore_Overview_Member_Functions">Member Functions</a> | static functions and member methods | +| --- | --- | +| <a href="SkAutoCanvasRestore_Reference#Automatic_Canvas_Restore_Constructors">Constructors</a> | functions that construct <a href="SkAutoCanvasRestore_Reference#SkAutoCanvasRestore">SkAutoCanvasRestore</a> | +| <a href="SkAutoCanvasRestore_Reference#Automatic_Canvas_Restore_Member_Functions">Member Functions</a> | static functions and member methods | + +# <a name="SkAutoCanvasRestore"></a> Class SkAutoCanvasRestore +Stack helper class calls ## <a name="Constructors"></a> Constructors | name | description | -| --- | --- | +| --- | --- | | <a href="#SkAutoCanvasRestore_SkCanvas_star">SkAutoCanvasRestore(SkCanvas* canvas, bool doSave)</a> | preserves <a href="SkCanvas_Reference#Canvas">Canvas</a> save count | -| | restores <a href="SkCanvas_Reference#Canvas">Canvas</a> to saved state | +| <a href="#SkAutoCanvasRestore_destructor">~SkAutoCanvasRestore()</a> | restores <a href="SkCanvas_Reference#Canvas">Canvas</a> to saved state | ## <a name="Member_Functions"></a> Member Functions | name | description | -| --- | --- | +| --- | --- | | <a href="#SkAutoCanvasRestore_restore">restore</a> | restores <a href="SkCanvas_Reference#Canvas">Canvas</a> to saved state | <a name="SkAutoCanvasRestore_SkCanvas_star"></a> @@ -84,6 +84,7 @@ void restore() </pre> Restores <a href="SkCanvas_Reference#Canvas">Canvas</a> to saved state immediately. Subsequent calls and +<a href="#SkAutoCanvasRestore_destructor">~SkAutoCanvasRestore</a> have no effect. ### Example diff --git a/site/user/api/SkBitmap_Reference.md b/site/user/api/SkBitmap_Reference.md index 0986412e05..41d6378396 100644 --- a/site/user/api/SkBitmap_Reference.md +++ b/site/user/api/SkBitmap_Reference.md @@ -3,6 +3,19 @@ SkBitmap Reference # <a name="Bitmap"></a> Bitmap +## <a name="Overview"></a> Overview + +## <a name="Subtopics"></a> Subtopics + +| name | description | +| --- | --- | +| <a href="#Classes_and_Structs">Classes and Structs</a> | embedded struct and class members | +| Constants | enum and enum class, const values | +| <a href="#Constructors">Constructors</a> | functions that construct <a href="SkBitmap_Reference#SkBitmap">SkBitmap</a> | +| <a href="#Member_Functions">Member Functions</a> | static functions and member methods | +| <a href="#Operators">Operators</a> | operator overloading methods | +| <a href="#Related_Functions">Related Functions</a> | similar methods grouped together | + # <a name="SkBitmap"></a> Class SkBitmap <a href="#Bitmap">Bitmap</a> describes a two-dimensional raster pixel array. <a href="#Bitmap">Bitmap</a> is built on <a href="SkImageInfo_Reference#Image_Info">Image Info</a>, containing integer width and height, <a href="SkImageInfo_Reference#Color_Type">Color Type</a> and <a href="SkImageInfo_Reference#Alpha_Type">Alpha Type</a> @@ -24,51 +37,47 @@ pixels. Declaring <a href="#SkBitmap">SkBitmap</a> const affects <a href="#Bitma <a href="#Bitmap">Bitmap</a> is not thread safe. Each thread must have its own copy of <a href="#Bitmap">Bitmap</a> fields, although threads may share the underlying pixel array. -# <a name="Row_Bytes"></a> Row Bytes +## <a name="Row_Bytes"></a> Row Bytes + <a href="#Bitmap">Bitmap</a> pixels may be contiguous, or may have a gap at the end of each row. <a href="#Row_Bytes">Row Bytes</a> is the interval from one row to the next. <a href="#Row_Bytes">Row Bytes</a> may be specified; sometimes passing zero will compute the <a href="#Row_Bytes">Row Bytes</a> from the row width and the number of bytes in a pixel. <a href="#Row_Bytes">Row Bytes</a> may be larger than the row requires. This is useful to position one or more <a href="#Bitmap">Bitmaps</a> within a shared pixel array. -# <a name="Overview"></a> Overview - -## <a name="Subtopics"></a> Subtopics +## <a name="Related_Functions"></a> Related Functions | name | description | -| --- | --- | -| <a href="#Overview_Classes_and_Structs">Classes and Structs</a> | embedded struct and class members | -| <a href="#Overview_Constructors">Constructors</a> | functions that construct <a href="SkPath_Reference#SkPath">SkPath</a> | -| <a href="#Overview_Member_Functions">Member Functions</a> | static functions and member methods | -| <a href="#Overview_Operators">Operators</a> | operator overloading methods | +| --- | --- | +| <a href="#Row_Bytes">Row Bytes</a> | interval from one row to the next | ## <a name="Classes_and_Structs"></a> Classes and Structs | name | description | -| --- | --- | -| <a href="#SkBitmap_Allocator">Allocator</a> | | -| <a href="#SkBitmap_HeapAllocator">HeapAllocator</a> | | +| --- | --- | +| <a href="#SkBitmap_Allocator">Allocator</a> | abstract subclass of <a href="#SkBitmap_HeapAllocator">HeapAllocator</a> | +| <a href="#SkBitmap_HeapAllocator">HeapAllocator</a> | allocates pixel memory from heap | ## <a name="Constructors"></a> Constructors | name | description | -| --- | --- | +| --- | --- | | <a href="#SkBitmap_empty_constructor">SkBitmap()</a> | constructs with default values | | <a href="#SkBitmap_move_SkBitmap">SkBitmap(SkBitmap&& src)</a> | takes ownership of pixels | | <a href="#SkBitmap_copy_const_SkBitmap">SkBitmap(const SkBitmap& src)</a> | shares ownership of pixels | -| | releases ownership of pixels | +| <a href="#SkBitmap_destructor">~SkBitmap()</a> | releases ownership of pixels | ## <a name="Operators"></a> Operators | name | description | -| --- | --- | +| --- | --- | | <a href="#SkBitmap_move_operator">operator=(SkBitmap&& src)</a> | takes ownership of pixels | | <a href="#SkBitmap_copy_operator">operator=(const SkBitmap& src)</a> | shares ownership of pixels | ## <a name="Member_Functions"></a> Member Functions | name | description | -| --- | --- | +| --- | --- | | <a href="#SkBitmap_ComputeIsOpaque">ComputeIsOpaque</a> | returns true if all pixels are opaque | | <a href="#SkBitmap_allocN32Pixels">allocN32Pixels</a> | allocates compatible <a href="#ARGB">Color ARGB</a> pixels, or aborts | | <a href="#SkBitmap_allocPixels">allocPixels</a> | allocates pixels from <a href="SkImageInfo_Reference#Image_Info">Image Info</a>, or aborts | @@ -1854,7 +1863,7 @@ contains width, height, <a href="SkImageInfo_Reference#Alpha_Type">Alpha Type</a bool SK_WARN_UNUSED_RESULT tryAllocN32Pixels(int width, int height, bool isOpaque = false) </pre> -Sets <a href="SkImageInfo_Reference#Image_Info">Image Info</a> to width, height, and <a href="SkImageInfo_Reference#Native_Color_Type">Native Color Type</a>; and allocates +Sets <a href="SkImageInfo_Reference#Image_Info">Image Info</a> to width, height, and <a href="SkImageInfo_Reference#Color_Type">Native Color Type</a>; and allocates pixel memory. If <a href="#SkBitmap_isOpaque">isOpaque</a> is true, sets <a href="SkImageInfo_Reference#Image_Info">Image Info</a> to <a href="SkImageInfo_Reference#SkAlphaType">kOpaque SkAlphaType</a>; otherwise, sets to <a href="SkImageInfo_Reference#SkAlphaType">kPremul SkAlphaType</a>. @@ -1898,7 +1907,7 @@ true if pixel storage is allocated void allocN32Pixels(int width, int height, bool isOpaque = false) </pre> -Sets <a href="SkImageInfo_Reference#Image_Info">Image Info</a> to width, height, and the <a href="SkImageInfo_Reference#Native_Color_Type">Native Color Type</a>; and allocates +Sets <a href="SkImageInfo_Reference#Image_Info">Image Info</a> to width, height, and the <a href="SkImageInfo_Reference#Color_Type">Native Color Type</a>; and allocates pixel memory. If <a href="#SkBitmap_isOpaque">isOpaque</a> is true, sets <a href="SkImageInfo_Reference#Image_Info">Image Info</a> to <a href="SkImageInfo_Reference#SkAlphaType">kPremul SkAlphaType</a>; otherwise, sets to <a href="SkImageInfo_Reference#SkAlphaType">kOpaque SkAlphaType</a>. diff --git a/site/user/api/SkCanvas_Reference.md b/site/user/api/SkCanvas_Reference.md index f10a963071..2dd0073d2b 100644 --- a/site/user/api/SkCanvas_Reference.md +++ b/site/user/api/SkCanvas_Reference.md @@ -3,6 +3,18 @@ SkCanvas Reference # <a name="Canvas"></a> Canvas +## <a name="Overview"></a> Overview + +## <a name="Subtopics"></a> Subtopics + +| name | description | +| --- | --- | +| <a href="#Classes_and_Structs">Classes and Structs</a> | embedded struct and class members | +| <a href="#Constants">Constants</a> | enum and enum class, const values | +| <a href="#Constructors">Constructors</a> | functions that construct <a href="SkCanvas_Reference#SkCanvas">SkCanvas</a> | +| <a href="#Member_Functions">Member Functions</a> | static functions and member methods | +| <a href="#Related_Functions">Related Functions</a> | similar methods grouped together | + # <a name="SkCanvas"></a> Class SkCanvas <a href="#Canvas">Canvas</a> provides an interface for drawing, and how the drawing is clipped and transformed. <a href="#Canvas">Canvas</a> contains a stack of <a href="#Matrix">Matrix</a> and <a href="#Clip">Clip</a> values. @@ -25,40 +37,39 @@ destination. <a href="#Canvas">Canvas</a> can be constructed to draw to <a href="SkBitmap_Reference#Bitmap">Bitmap</a> without first creating <a href="undocumented#Raster_Surface">Raster Surface</a>. This approach may be deprecated in the future. -# <a name="Overview"></a> Overview - -## <a name="Subtopics"></a> Subtopics +## <a name="Related_Functions"></a> Related Functions | name | description | -| --- | --- | -| <a href="#Overview_Classes_and_Structs">Classes and Structs</a> | embedded struct and class members | -| <a href="#Overview_Constants">Constants</a> | enum and enum class, const values | -| <a href="#Overview_Constructors">Constructors</a> | functions that construct <a href="SkPath_Reference#SkPath">SkPath</a> | -| <a href="#Overview_Member_Functions">Member Functions</a> | static functions and member methods | +| --- | --- | +| <a href="#Clip">Clip</a> | stack of clipping <a href="#Path">Paths</a> | +| <a href="#Draw_Image">Draw Image</a> | draws <a href="SkImage_Reference#Image">Image</a> to <a href="#Canvas">Canvas</a> | +| <a href="#Layer">Layer</a> | temporary <a href="SkBitmap_Reference#Bitmap">Bitmap</a> to draw into | +| <a href="#Matrix">Matrix</a> | coordinate transformation | +| <a href="#State_Stack">State Stack</a> | stack of state for hierarchical drawing | ## <a name="Constants"></a> Constants | name | description | -| --- | --- | -| Lattice::Flags | controls <a href="#SkCanvas_Lattice">Lattice</a> transparency | +| --- | --- | +| <a href="#SkCanvas_ColorBehavior">ColorBehavior</a> | Android framework only | | <a href="#SkCanvas_PointMode">PointMode</a> | sets <a href="#SkCanvas_drawPoints">drawPoints</a> options | -| <a href="#SkCanvas_SaveLayerFlags">SaveLayerFlags</a> | sets <a href="#SkCanvas_SaveLayerRec">SaveLayerRec</a> options | | <a href="#SkCanvas_SrcRectConstraint">SrcRectConstraint</a> | sets <a href="#SkCanvas_drawImageRect">drawImageRect</a> options | +| _anonymous | sets <a href="#SkCanvas_SaveLayerRec">SaveLayerRec</a> options | ## <a name="Classes_and_Structs"></a> Classes and Structs | name | description | -| --- | --- | -| <a href="#SkCanvas_Lattice">Lattice</a> | divides <a href="SkBitmap_Reference#Bitmap">Bitmap</a>, <a href="SkImage_Reference#Image">Image</a> into a rectangular grid | -| <a href="#SkCanvas_SaveLayerRec">SaveLayerRec</a> | contains state to create <a href="#Layer">Layer</a> | +| --- | --- | +| <a href="#SkCanvas_Lattice">Lattice</a> | divides <a href="SkBitmap_Reference#Bitmap">Bitmap</a> or <a href="SkImage_Reference#Image">Image</a> into a rectangular grid | +| <a href="#SkCanvas_SaveLayerRec">SaveLayerRec</a> | contains the state used to create the <a href="#Layer">Layer</a> | ## <a name="Constructors"></a> Constructors -Create the desired type of <a href="SkSurface_Reference#Surface">Surface</a> to obtain its <a href="#Canvas">Canvas</a> when possible. <a href="#Overview_Constructors">Constructors</a> are useful +Create the desired type of <a href="SkSurface_Reference#Surface">Surface</a> to obtain its <a href="#Canvas">Canvas</a> when possible. <a href="#Constructors">Constructors</a> are useful when no <a href="SkSurface_Reference#Surface">Surface</a> is required, and some helpers implicitly create <a href="undocumented#Raster_Surface">Raster Surface</a>. | name | description | -| --- | --- | +| --- | --- | | <a href="#SkCanvas_MakeRasterDirect">MakeRasterDirect</a> | creates from <a href="SkImageInfo_Reference#SkImageInfo">SkImageInfo</a> and <a href="#Storage">Pixel Storage</a> | | <a href="#SkCanvas_MakeRasterDirectN32">MakeRasterDirectN32</a> | creates from image data and <a href="#Storage">Pixel Storage</a> | | <a href="#SkCanvas_empty_constructor">SkCanvas()</a> | creates with no <a href="SkSurface_Reference#Surface">Surface</a>, no dimensions | @@ -67,12 +78,13 @@ when no <a href="SkSurface_Reference#Surface">Surface</a> is required, and some | <a href="#SkCanvas_const_SkBitmap">SkCanvas(const SkBitmap& bitmap, ColorBehavior behavior)</a> | Android framework only | | <a href="#SkCanvas_const_SkBitmap_const_SkSurfaceProps">SkCanvas(const SkBitmap& bitmap, const SkSurfaceProps& props)</a> | uses existing <a href="SkBitmap_Reference#Bitmap">Bitmap</a> and <a href="undocumented#Surface_Properties">Surface Properties</a> | | <a href="#SkCanvas_int_int_const_SkSurfaceProps_star">SkCanvas(int width, int height, const SkSurfaceProps* props = nullptr)</a> | no <a href="SkSurface_Reference#Surface">Surface</a>, set dimensions, <a href="undocumented#Surface_Properties">Surface Properties</a> | -| | draws saved <a href="#Layer">Layers</a>, frees resources | +| <a href="#SkCanvas_makeSurface">makeSurface</a> | creates <a href="SkSurface_Reference#Surface">Surface</a> matching <a href="SkImageInfo_Reference#SkImageInfo">SkImageInfo</a> and <a href="undocumented#SkSurfaceProps">SkSurfaceProps</a> | +| <a href="#SkCanvas_destructor">~SkCanvas()</a> | draws saved <a href="#Layer">Layers</a>, frees resources | ## <a name="Member_Functions"></a> Member Functions | name | description | -| --- | --- | +| --- | --- | | <a href="#SkCanvas_MakeRasterDirect">MakeRasterDirect</a> | creates from <a href="SkImageInfo_Reference#SkImageInfo">SkImageInfo</a> and <a href="#Storage">Pixel Storage</a> | | <a href="#SkCanvas_MakeRasterDirectN32">MakeRasterDirectN32</a> | creates from image data and <a href="#Storage">Pixel Storage</a> | | <a href="#SkCanvas_accessTopLayerPixels">accessTopLayerPixels</a> | returns writable pixel access if available | @@ -391,11 +403,6 @@ specifies a <a href="#SkCanvas_copy_SkBaseDevice_star_device">device</a> for the <a href="#Canvas">Canvas</a> that can be used to draw into <a href="#SkCanvas_copy_SkBaseDevice_star_device">device</a> -### Example - -<pre style="padding: 1em 1em 1em 1em; font-size: 13px width: 62.5em; background-color: #f0f0f0"> -void draw(SkCanvas* canvas) {</fiddle-embed></div> - ### See Also <a href="#SkCanvas_MakeRasterDirect">MakeRasterDirect</a> <a href="#SkRasterHandleAllocator_MakeCanvas">SkRasterHandleAllocator::MakeCanvas</a> <a href="#SkSurface_getCanvas">SkSurface::getCanvas</a> <a href="undocumented#SkCreateColorSpaceXformCanvas">SkCreateColorSpaceXformCanvas</a> @@ -693,11 +700,6 @@ If <a href="#Canvas">Canvas</a> is associated with <a href="undocumented#GPU_Sur If <a href="#Canvas">Canvas</a> is associated with <a href="undocumented#Raster_Surface">Raster Surface</a>, has no effect; raster draw operations are never deferred. -### Example - -<pre style="padding: 1em 1em 1em 1em; font-size: 13px width: 62.5em; background-color: #f0f0f0"> -void draw(SkCanvas* canvas) {</fiddle-embed></div> - ### See Also <a href="#SkCanvas_peekPixels">peekPixels</a> <a href="#SkSurface_flush">SkSurface::flush()</a> <a href="#flush">GrContext::flush()</a> <a href="#SkSurface_prepareForExternalIO">SkSurface::prepareForExternalIO</a> GrContext::abandonContext() @@ -1295,7 +1297,8 @@ true if pixels were written to <a href="#Canvas">Canvas</a> --- -# <a name="State_Stack"></a> State Stack +## <a name="State_Stack"></a> State Stack + <a href="#Canvas">Canvas</a> maintains a stack of state that allows hierarchical drawing, commonly used to implement windows and views. The initial state has an identity matrix and and an infinite clip. Even with a wide-open clip, drawing is constrained by the @@ -1459,7 +1462,8 @@ depth = 1 --- -# <a name="Layer"></a> Layer +## <a name="Layer"></a> Layer + <a href="#Layer">Layer</a> allocates a temporary <a href="SkBitmap_Reference#Bitmap">Bitmap</a> to draw into. When the drawing is complete, the <a href="SkBitmap_Reference#Bitmap">Bitmap</a> is drawn into the <a href="#Canvas">Canvas</a>. @@ -1968,7 +1972,7 @@ Outside of the circle the mandrill is brightened.</div></fiddle-embed></div> --- -# <a name="Matrix"></a> Matrix +## <a name="Matrix"></a> Matrix <a name="SkCanvas_translate"></a> ## translate @@ -2261,7 +2265,8 @@ isIdentity true --- -# <a name="Clip"></a> Clip +## <a name="Clip"></a> Clip + <a href="#Clip">Clip</a> is built from a stack of clipping paths. Each <a href="SkPath_Reference#Path">Path</a> in the stack can be constructed from one or more <a href="#Contour">Path Contour</a> elements. The <a href="#Contour">Path Contour</a> may be composed of any number of <a href="#Verb">Path Verb</a> segments. Each @@ -3654,7 +3659,8 @@ Third bottom column shows inverse winding fills area outside both contours.</div --- -# <a name="Draw_Image"></a> Draw Image +## <a name="Draw_Image"></a> Draw Image + <a href="#SkCanvas_drawImage">drawImage</a>, <a href="#SkCanvas_drawImageRect">drawImageRect</a>, and <a href="#SkCanvas_drawImageNine">drawImageNine</a> can be called with a bare pointer or a smart pointer as a convenience. The pairs of calls are otherwise identical. diff --git a/site/user/api/SkIPoint16_Reference.md b/site/user/api/SkIPoint16_Reference.md index ddc94cf6da..8d6e962beb 100644 --- a/site/user/api/SkIPoint16_Reference.md +++ b/site/user/api/SkIPoint16_Reference.md @@ -3,33 +3,41 @@ SkIPoint16 Reference # <a name="IPoint16"></a> IPoint16 -# <a name="SkIPoint16"></a> Struct SkIPoint16 -<a href="#SkIPoint16">SkIPoint16</a> holds two 16 bit integer coordinates. - -# <a name="Overview"></a> Overview +## <a name="Overview"></a> Overview ## <a name="Subtopics"></a> Subtopics | name | description | -| --- | --- | -| <a href="#Overview_Constructors">Constructors</a> | functions that construct <a href="#SkIPoint16">SkIPoint16</a> | -| <a href="#Overview_Member_Functions">Member Functions</a> | static functions and member methods | +| --- | --- | +| <a href="#Constructors">Constructors</a> | functions that construct <a href="SkIPoint16_Reference#SkIPoint16">SkIPoint16</a> | +| <a href="#Member_Functions">Member Functions</a> | static functions and member methods | +| <a href="#Members">Members</a> | member values | + +# <a name="SkIPoint16"></a> Struct SkIPoint16 +<a href="#SkIPoint16">SkIPoint16</a> holds two 16 bit integer coordinates. ## <a name="Constructors"></a> Constructors | name | description | -| --- | --- | +| --- | --- | | <a href="#SkIPoint16_Make">Make</a> | constructs from integer inputs | ## <a name="Member_Functions"></a> Member Functions | name | description | -| --- | --- | +| --- | --- | | <a href="#SkIPoint16_Make">Make</a> | constructs from integer inputs | | <a href="#SkIPoint16_set">set</a> | sets to integer input | | <a href="#SkIPoint16_x">x</a> | returns <a href="#SkIPoint16_fX">fX</a> | | <a href="#SkIPoint16_y">y</a> | returns <a href="#SkIPoint16_fY">fY</a> | +## <a name="Members"></a> Members + +| name | description | +| --- | --- | +| <a href="#SkIPoint16_fX">fX</a> | x-axis value | +| <a href="#SkIPoint16_fY">fY</a> | y-axis value | + <a name="SkIPoint16_fX"> <code><strong>int16_t fX</strong></code> </a> x-axis value used by <a href="#IPoint16">IPoint16</a> diff --git a/site/user/api/SkIPoint_Reference.md b/site/user/api/SkIPoint_Reference.md index d8640a8701..d43a9b8bc9 100644 --- a/site/user/api/SkIPoint_Reference.md +++ b/site/user/api/SkIPoint_Reference.md @@ -3,41 +3,42 @@ SkIPoint Reference # <a name="IPoint"></a> IPoint -# <a name="SkIPoint"></a> Struct SkIPoint -<a href="#SkIPoint">SkIPoint</a> holds two 32 bit integer coordinates. - -# <a name="Overview"></a> Overview +## <a name="Overview"></a> Overview ## <a name="Subtopics"></a> Subtopics | name | description | -| --- | --- | -| <a href="#Overview_Constructors">Constructors</a> | functions that construct <a href="SkIPoint16_Reference#SkIPoint16">SkIPoint16</a> | -| <a href="#Overview_Member_Functions">Member Functions</a> | static functions and member methods | -| <a href="#Overview_Operators">Operators</a> | operator overloading methods | +| --- | --- | +| <a href="#Constructors">Constructors</a> | functions that construct <a href="SkIPoint_Reference#SkIPoint">SkIPoint</a> | +| <a href="#Member_Functions">Member Functions</a> | static functions and member methods | +| <a href="#Members">Members</a> | member values | +| <a href="#Operators">Operators</a> | operator overloading methods | + +# <a name="SkIPoint"></a> Struct SkIPoint +<a href="#SkIPoint">SkIPoint</a> holds two 32 bit integer coordinates. ## <a name="Constructors"></a> Constructors | name | description | -| --- | --- | +| --- | --- | | <a href="#SkIPoint_Make">Make</a> | constructs from integer inputs | ## <a name="Operators"></a> Operators | name | description | -| --- | --- | +| --- | --- | +| <a href="#SkIPoint_notequal_operator">operator!=(const SkIPoint& a, const SkIPoint& b)</a> | returns true if <a href="#IPoint">IPoints</a> are unequal | | <a href="#SkIPoint_add_operator">operator+(const SkIPoint& a, const SkIVector& b)</a> | returns <a href="#IPoint">IPoint</a> offset by <a href="SkIPoint_Reference#IVector">IVector</a> | +| <a href="#SkIPoint_addto_operator">operator+=(const SkIVector& v)</a> | adds <a href="SkIPoint_Reference#IVector">IVector</a> to <a href="#IPoint">IPoint</a> | | <a href="#SkIPoint_minus_operator">operator-() const</a> | reverses sign of <a href="#IPoint">IPoint</a> | | <a href="#SkIPoint_subtract_operator">operator-(const SkIPoint& a, const SkIPoint& b)</a> | returns <a href="SkIPoint_Reference#IVector">IVector</a> between <a href="#IPoint">IPoints</a> | -| <a href="#SkIPoint_notequal_operator">operator!=(const SkIPoint& a, const SkIPoint& b)</a> | returns true if <a href="#IPoint">IPoints</a> are unequal | -| <a href="#SkIPoint_equal_operator">operator==(const SkIPoint& a, const SkIPoint& b)</a> | returns true if <a href="#IPoint">IPoints</a> are equal | -| <a href="#SkIPoint_addto_operator">operator+=(const SkIVector& v)</a> | adds <a href="SkIPoint_Reference#IVector">IVector</a> to <a href="#IPoint">IPoint</a> | | <a href="#SkIPoint_subtractfrom_operator">operator-=(const SkIVector& v)</a> | subtracts <a href="SkIPoint_Reference#IVector">IVector</a> from <a href="#IPoint">IPoint</a> | +| <a href="#SkIPoint_equal_operator">operator==(const SkIPoint& a, const SkIPoint& b)</a> | returns true if <a href="#IPoint">IPoints</a> are equal | ## <a name="Member_Functions"></a> Member Functions | name | description | -| --- | --- | +| --- | --- | | <a href="#SkIPoint_Make">Make</a> | constructs from integer inputs | | <a href="#SkIPoint_equals">equals</a> | returns true if members are equal | | <a href="#SkIPoint_isZero">isZero</a> | returns true if both members equal zero | @@ -45,6 +46,13 @@ SkIPoint Reference | <a href="#SkIPoint_x">x</a> | returns <a href="#SkIPoint_fX">fX</a> | | <a href="#SkIPoint_y">y</a> | returns <a href="#SkIPoint_fY">fY</a> | +## <a name="Members"></a> Members + +| name | description | +| --- | --- | +| <a href="#SkIPoint_fX">fX</a> | x-axis value | +| <a href="#SkIPoint_fY">fY</a> | y-axis value | + <a name="SkIPoint_fX"> <code><strong>int32_t fX</strong></code> </a> x-axis value used by <a href="#IPoint">IPoint</a>. diff --git a/site/user/api/SkIRect_Reference.md b/site/user/api/SkIRect_Reference.md index c2d9660dee..78129ec813 100644 --- a/site/user/api/SkIRect_Reference.md +++ b/site/user/api/SkIRect_Reference.md @@ -3,12 +3,12 @@ SkIRect Reference # <a name="IRect"></a> IRect -# <a name="Overview"></a> Overview +## <a name="Overview"></a> Overview ## <a name="Subtopics"></a> Subtopics | name | description | -| --- | --- | +| --- | --- | | <a href="#Constructors">Constructors</a> | functions that construct <a href="SkIRect_Reference#SkIRect">SkIRect</a> | | <a href="#Member_Functions">Member Functions</a> | static functions and member methods | | <a href="#Members">Members</a> | member values | @@ -37,7 +37,7 @@ its top, it is considered empty. ## <a name="Member_Functions"></a> Member Functions | name | description | -| --- | --- | +| --- | --- | | <a href="#SkIRect_EmptyIRect">EmptyIRect</a> | returns immutable bounds of (0, 0, 0, 0) | | <a href="#SkIRect_Intersects">Intersects</a> | returns true if areas overlap | | <a href="#SkIRect_IntersectsNoEmptyCheck">IntersectsNoEmptyCheck</a> | returns true if areas overlap skips empty check | @@ -85,6 +85,13 @@ its top, it is considered empty. ## <a name="Members"></a> Members +| name | description | +| --- | --- | +| <a href="#SkIRect_fBottom">fBottom</a> | larger y-axis bounds | +| <a href="#SkIRect_fLeft">fLeft</a> | smaller x-axis bounds | +| <a href="#SkIRect_fRight">fRight</a> | larger x-axis bounds | +| <a href="#SkIRect_fTop">fTop</a> | smaller y-axis bounds | + <a name="SkIRect_fLeft"> <code><strong>int32_t fLeft</strong></code> </a> May contain any value. The smaller of the horizontal values when sorted. @@ -108,7 +115,7 @@ When equal to or less than <a href="#SkIRect_fTop">fTop</a>, <a href="#IRect">IR ## <a name="Constructors"></a> Constructors | name | description | -| --- | --- | +| --- | --- | | <a href="#SkIRect_MakeEmpty">MakeEmpty</a> | returns bounds of (0, 0, 0, 0) | | <a href="#SkIRect_MakeLTRB">MakeLTRB</a> | constructs from int left, top, right, bottom | | <a href="#SkIRect_MakeLargest">MakeLargest</a> | deprecated | @@ -828,7 +835,7 @@ sorted: {20, 40, 20, 50} is empty ## <a name="Operators"></a> Operators | name | description | -| --- | --- | +| --- | --- | | <a href="#SkIRect_notequal_operator">operator!=(const SkIRect& a, const SkIRect& b)</a> | returns true if members are unequal | | <a href="#SkIRect_equal_operator">operator==(const SkIRect& a, const SkIRect& b)</a> | returns true if members are equal | diff --git a/site/user/api/SkImageInfo_Reference.md b/site/user/api/SkImageInfo_Reference.md index 902c443dd8..c947cb4223 100644 --- a/site/user/api/SkImageInfo_Reference.md +++ b/site/user/api/SkImageInfo_Reference.md @@ -3,27 +3,22 @@ SkImageInfo Reference # <a name="Image_Info"></a> Image Info -# <a name="Overview"></a> Overview +## <a name="Overview"></a> Overview ## <a name="Subtopics"></a> Subtopics | name | description | -| --- | --- | -| <a href="SkImageInfo_Reference#Image_Info_Overview_Constants">Constants</a> | enum and enum class, const values | -| <a href="SkImageInfo_Reference#Image_Info_Constructors">Constructors</a> | functions that construct ImageInfo | +| --- | --- | +| <a href="SkImageInfo_Reference#Image_Info_Constructors">Constructors</a> | functions that construct <a href="SkImageInfo_Reference#SkImageInfo">SkImageInfo</a> | | <a href="SkImageInfo_Reference#Image_Info_Member_Functions">Member Functions</a> | static functions and member methods | | <a href="SkImageInfo_Reference#Image_Info_Operators">Operators</a> | operator overloading methods | ## <a name="Constants"></a> Constants | name | description | -| --- | --- | -| <a href="SkImageInfo_Reference#Alpha_Type">Alpha Type</a> | encoding for pixel transparency | -| <a href="SkImageInfo_Reference#Color_Type">Color Type</a> | encoding for pixel color components | -| <a href="SkImageInfo_Reference#SkDestinationSurfaceColorMode">SkDestinationSurfaceColorMode</a> | | -| <a href="SkImageInfo_Reference#SkYUVColorSpace">SkYUVColorSpace</a> | | +| --- | --- | -# <a name="Alpha_Type"></a> Alpha Type +## <a name="Alpha_Type"></a> Alpha Type ## <a name="SkAlphaType"></a> Enum SkAlphaType @@ -69,9 +64,7 @@ incomplete -# <a name="Color_Type"></a> Color Type - -## <a name="Native_Color_Type"></a> Native Color Type +## <a name="Color_Type"></a> Color Type ## <a name="SkColorType"></a> Enum SkColorType @@ -225,58 +218,58 @@ Used for both src images and render-targets (surfaces). ## <a name="Operators"></a> Operators | name | description | -| --- | --- | -| <a href="#SkImageInfo_notequal1_operator">operator!=(const SkImageInfo& other) const</a> | | -| <a href="#SkImageInfo_equal1_operator">operator==(const SkImageInfo& other) const</a> | | +| --- | --- | +| <a href="#SkImageInfo_notequal1_operator">operator!=(const SkImageInfo& other) const</a> | incomplete | +| <a href="#SkImageInfo_equal1_operator">operator==(const SkImageInfo& other) const</a> | incomplete | ## <a name="Member_Functions"></a> Member Functions | name | description | -| --- | --- | -| <a href="#SkImageInfo_ByteSizeOverflowed">ByteSizeOverflowed</a> | | +| --- | --- | +| <a href="#SkImageInfo_ByteSizeOverflowed">ByteSizeOverflowed</a> | incomplete | | <a href="#SkImageInfo_Make">Make</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> from dimensions, <a href="SkImageInfo_Reference#Color_Type">Color Type</a>, <a href="SkImageInfo_Reference#Alpha_Type">Alpha Type</a>, <a href="undocumented#Color_Space">Color Space</a> | | <a href="#SkImageInfo_MakeA8">MakeA8</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with <a href="SkImageInfo_Reference#SkColorType">kAlpha 8 SkColorType</a>, <a href="SkImageInfo_Reference#SkAlphaType">kPremul SkAlphaType</a> | -| <a href="#SkImageInfo_MakeN32">MakeN32</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with <a href="SkImageInfo_Reference#Native_Color_Type">Native Color Type</a> | -| <a href="#SkImageInfo_MakeN32Premul">MakeN32Premul</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with <a href="SkImageInfo_Reference#Native_Color_Type">Native Color Type</a>, <a href="SkImageInfo_Reference#SkAlphaType">kPremul SkAlphaType</a> | -| <a href="#SkImageInfo_MakeS32">MakeS32</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with <a href="SkImageInfo_Reference#Native_Color_Type">Native Color Type</a>, sRGB <a href="undocumented#Color_Space">Color Space</a> | +| <a href="#SkImageInfo_MakeN32">MakeN32</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with <a href="SkImageInfo_Reference#Color_Type">Native Color Type</a> | +| <a href="#SkImageInfo_MakeN32Premul">MakeN32Premul</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with <a href="SkImageInfo_Reference#Color_Type">Native Color Type</a>, <a href="SkImageInfo_Reference#SkAlphaType">kPremul SkAlphaType</a> | +| <a href="#SkImageInfo_MakeS32">MakeS32</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with <a href="SkImageInfo_Reference#Color_Type">Native Color Type</a>, sRGB <a href="undocumented#Color_Space">Color Space</a> | | <a href="#SkImageInfo_MakeUnknown">MakeUnknown</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with <a href="SkImageInfo_Reference#SkColorType">kUnknown SkColorType</a>, <a href="SkImageInfo_Reference#SkAlphaType">kUnknown SkAlphaType</a> | -| <a href="#SkImageInfo_alphaType">alphaType</a> | | -| <a href="#SkImageInfo_bounds">bounds</a> | | -| <a href="#SkImageInfo_bytesPerPixel">bytesPerPixel</a> | | -| <a href="#SkImageInfo_colorSpace">colorSpace</a> | | -| <a href="#SkImageInfo_colorType">colorType</a> | | -| <a href="#SkImageInfo_computeByteSize">computeByteSize</a> | | -| <a href="#SkImageInfo_computeMinByteSize">computeMinByteSize</a> | | -| <a href="#SkImageInfo_computeOffset">computeOffset</a> | | -| <a href="#SkImageInfo_dimensions">dimensions</a> | | -| <a href="#SkImageInfo_flatten">flatten</a> | | -| <a href="#SkImageInfo_gammaCloseToSRGB">gammaCloseToSRGB</a> | | -| <a href="#SkImageInfo_height">height</a> | | -| <a href="#SkImageInfo_isEmpty">isEmpty</a> | | -| <a href="#SkImageInfo_isOpaque">isOpaque</a> | | +| <a href="#SkImageInfo_alphaType">alphaType</a> | incomplete | +| <a href="#SkImageInfo_bounds">bounds</a> | incomplete | +| <a href="#SkImageInfo_bytesPerPixel">bytesPerPixel</a> | incomplete | +| <a href="#SkImageInfo_colorSpace">colorSpace</a> | incomplete | +| <a href="#SkImageInfo_colorType">colorType</a> | incomplete | +| <a href="#SkImageInfo_computeByteSize">computeByteSize</a> | incomplete | +| <a href="#SkImageInfo_computeMinByteSize">computeMinByteSize</a> | incomplete | +| <a href="#SkImageInfo_computeOffset">computeOffset</a> | incomplete | +| <a href="#SkImageInfo_dimensions">dimensions</a> | incomplete | +| <a href="#SkImageInfo_flatten">flatten</a> | incomplete | +| <a href="#SkImageInfo_gammaCloseToSRGB">gammaCloseToSRGB</a> | incomplete | +| <a href="#SkImageInfo_height">height</a> | incomplete | +| <a href="#SkImageInfo_isEmpty">isEmpty</a> | incomplete | +| <a href="#SkImageInfo_isOpaque">isOpaque</a> | incomplete | | <a href="#SkImageInfo_makeAlphaType">makeAlphaType</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with changed <a href="SkImageInfo_Reference#Alpha_Type">Alpha Type</a> | | <a href="#SkImageInfo_makeColorSpace">makeColorSpace</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with changed <a href="undocumented#Color_Space">Color Space</a> | | <a href="#SkImageInfo_makeColorType">makeColorType</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with changed <a href="SkImageInfo_Reference#Color_Type">Color Type</a> | | <a href="#SkImageInfo_makeWH">makeWH</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with changed dimensions | -| <a href="#SkImageInfo_minRowBytes">minRowBytes</a> | | -| <a href="#SkImageInfo_minRowBytes64">minRowBytes64</a> | | -| <a href="#SkImageInfo_refColorSpace">refColorSpace</a> | | -| <a href="#SkImageInfo_reset">reset</a> | | -| <a href="#SkImageInfo_shiftPerPixel">shiftPerPixel</a> | | -| <a href="#SkImageInfo_unflatten">unflatten</a> | | -| <a href="#SkImageInfo_validRowBytes">validRowBytes</a> | | -| <a href="#SkImageInfo_validate">validate</a> | | -| <a href="#SkImageInfo_width">width</a> | | +| <a href="#SkImageInfo_minRowBytes">minRowBytes</a> | incomplete | +| <a href="#SkImageInfo_minRowBytes64">minRowBytes64</a> | incomplete | +| <a href="#SkImageInfo_refColorSpace">refColorSpace</a> | incomplete | +| <a href="#SkImageInfo_reset">reset</a> | incomplete | +| <a href="#SkImageInfo_shiftPerPixel">shiftPerPixel</a> | incomplete | +| <a href="#SkImageInfo_unflatten">unflatten</a> | incomplete | +| <a href="#SkImageInfo_validRowBytes">validRowBytes</a> | incomplete | +| <a href="#SkImageInfo_validate">validate</a> | incomplete | +| <a href="#SkImageInfo_width">width</a> | incomplete | ## <a name="Constructors"></a> Constructors | name | description | -| --- | --- | +| --- | --- | | <a href="#SkImageInfo_Make">Make</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> from dimensions, <a href="SkImageInfo_Reference#Color_Type">Color Type</a>, <a href="SkImageInfo_Reference#Alpha_Type">Alpha Type</a>, <a href="undocumented#Color_Space">Color Space</a> | | <a href="#SkImageInfo_MakeA8">MakeA8</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with <a href="SkImageInfo_Reference#SkColorType">kAlpha 8 SkColorType</a>, <a href="SkImageInfo_Reference#SkAlphaType">kPremul SkAlphaType</a> | -| <a href="#SkImageInfo_MakeN32">MakeN32</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with <a href="SkImageInfo_Reference#Native_Color_Type">Native Color Type</a> | -| <a href="#SkImageInfo_MakeN32Premul">MakeN32Premul</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with <a href="SkImageInfo_Reference#Native_Color_Type">Native Color Type</a>, <a href="SkImageInfo_Reference#SkAlphaType">kPremul SkAlphaType</a> | -| <a href="#SkImageInfo_MakeS32">MakeS32</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with <a href="SkImageInfo_Reference#Native_Color_Type">Native Color Type</a>, sRGB <a href="undocumented#Color_Space">Color Space</a> | +| <a href="#SkImageInfo_MakeN32">MakeN32</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with <a href="SkImageInfo_Reference#Color_Type">Native Color Type</a> | +| <a href="#SkImageInfo_MakeN32Premul">MakeN32Premul</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with <a href="SkImageInfo_Reference#Color_Type">Native Color Type</a>, <a href="SkImageInfo_Reference#SkAlphaType">kPremul SkAlphaType</a> | +| <a href="#SkImageInfo_MakeS32">MakeS32</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with <a href="SkImageInfo_Reference#Color_Type">Native Color Type</a>, sRGB <a href="undocumented#Color_Space">Color Space</a> | | <a href="#SkImageInfo_MakeUnknown">MakeUnknown</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with <a href="SkImageInfo_Reference#SkColorType">kUnknown SkColorType</a>, <a href="SkImageInfo_Reference#SkAlphaType">kUnknown SkAlphaType</a> | | <a href="#SkImageInfo_empty_constructor">SkImageInfo()</a> | creates with zero dimensions, <a href="SkImageInfo_Reference#SkColorType">kUnknown SkColorType</a>, <a href="SkImageInfo_Reference#SkAlphaType">kUnknown SkAlphaType</a> | | <a href="#SkImageInfo_makeAlphaType">makeAlphaType</a> | creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with changed <a href="SkImageInfo_Reference#Alpha_Type">Alpha Type</a> | diff --git a/site/user/api/SkImage_Reference.md b/site/user/api/SkImage_Reference.md index 7a4018986c..28e9803807 100644 --- a/site/user/api/SkImage_Reference.md +++ b/site/user/api/SkImage_Reference.md @@ -3,6 +3,18 @@ SkImage Reference # <a name="Image"></a> Image +## <a name="Overview"></a> Overview + +## <a name="Subtopics"></a> Subtopics + +| name | description | +| --- | --- | +| <a href="#Classes_and_Structs">Classes and Structs</a> | embedded struct and class members | +| Constants | enum and enum class, const values | +| <a href="#Constructors">Constructors</a> | functions that construct <a href="SkImage_Reference#SkImage">SkImage</a> | +| <a href="#Member_Functions">Member Functions</a> | static functions and member methods | +| <a href="#Related_Functions">Related Functions</a> | similar methods grouped together | + # <a name="SkImage"></a> Class SkImage <a href="#Image">Image</a> describes a two dimensional array of pixels to draw. The pixels may be unencoded in a <a href="undocumented#Raster_Bitmap">Raster Bitmap</a>, encoded in a <a href="undocumented#Picture">Picture</a> or compressed data stream, @@ -19,33 +31,43 @@ or height returns <a href="#Image">Image</a> equal to nullptr. include BMP, GIF, HEIF, ICO, JPEG, PNG, WBMP, WebP. Supported encodings details vary with platform. -# <a name="Raster_Image"></a> Raster Image +## <a name="Raster_Image"></a> Raster Image + <a href="SkImage_Reference#Raster_Image">Raster Image</a> pixels are unencoded in a <a href="undocumented#Raster_Bitmap">Raster Bitmap</a>. These pixels may be read directly and in most cases written to, although edited pixels may not be drawn if <a href="#Image">Image</a> has been copied internally. -# <a name="Texture_Image"></a> Texture Image +## <a name="Texture_Image"></a> Texture Image + <a href="#Texture_Image">Texture Image</a> are located on GPU and pixels are not accessible. <a href="#Texture_Image">Texture Image</a> are allocated optimally for best performance. <a href="SkImage_Reference#Raster_Image">Raster Image</a> may be drawn to <a href="undocumented#GPU_Surface">GPU Surface</a>, but pixels are uploaded from CPU to GPU downgrading performance. -# <a name="Lazy_Image"></a> Lazy Image +## <a name="Lazy_Image"></a> Lazy Image + <a href="#Lazy_Image">Lazy Image</a> defer allocating buffer for <a href="#Image">Image</a> pixels and decoding stream until <a href="#Image">Image</a> is drawn. <a href="#Lazy_Image">Lazy Image</a> caches result if possible to speed up repeated drawing. -# <a name="Overview"></a> Overview +## <a name="Related_Functions"></a> Related Functions -## <a name="Subtopics"></a> Subtopics +| name | description | +| --- | --- | +| <a href="#Lazy_Image">Lazy Image</a> | deferred pixel buffer | +| <a href="SkImage_Reference#Raster_Image">Raster Image</a> | pixels unencoded in <a href="undocumented#Raster_Bitmap">Raster Bitmap</a> | +| <a href="#Texture_Image">Texture Image</a> | pixels located on GPU | -| topics | description | -| --- | --- | +## <a name="Classes_and_Structs"></a> Classes and Structs + +| name | description | +| --- | --- | +| <a href="#SkImage_DeferredTextureImageUsageParams">DeferredTextureImageUsageParams</a> | to be deprecated | ## <a name="Constructors"></a> Constructors | name | description | -| --- | --- | +| --- | --- | | <a href="#SkImage_MakeBackendTextureFromSkImage">MakeBackendTextureFromSkImage</a> | Creates <a href="undocumented#GPU_Texture">GPU Texture</a> from <a href="#Image">Image</a>. | | <a href="#SkImage_MakeCrossContextFromEncoded">MakeCrossContextFromEncoded</a> | Creates <a href="#Image">Image</a> from encoded data, and uploads to GPU. | | <a href="#SkImage_MakeCrossContextFromPixmap">MakeCrossContextFromPixmap</a> | Creates <a href="#Image">Image</a> from <a href="SkPixmap_Reference#Pixmap">Pixmap</a>, and uploads to GPU. | @@ -62,18 +84,18 @@ drawing. | <a href="#SkImage_MakeFromYUVTexturesCopy">MakeFromYUVTexturesCopy</a> | Creates <a href="#Image">Image</a> from <a href="undocumented#YUV_ColorSpace">YUV ColorSpace</a> data in three planes. | | <a href="#SkImage_MakeRasterCopy">MakeRasterCopy</a> | Creates <a href="#Image">Image</a> from <a href="SkPixmap_Reference#Pixmap">Pixmap</a> and copied pixels. | | <a href="#SkImage_MakeRasterData">MakeRasterData</a> | Creates <a href="#Image">Image</a> from <a href="#Info">Image Info</a> and shared pixels. | -| <a href="#SkSurface_makeImageSnapshot">SkSurface::makeImageSnapshot</a> | Creates <a href="#Image">Image</a> capturing <a href="SkSurface_Reference#Surface">Surface</a> contents. | | <a href="#SkImage_makeColorSpace">makeColorSpace</a> | Creates <a href="#Image">Image</a> matching <a href="undocumented#Color_Space">Color Space</a> if possible. | | <a href="#SkImage_makeNonTextureImage">makeNonTextureImage</a> | Creates <a href="#Image">Image</a> without dependency on <a href="undocumented#GPU_Texture">GPU Texture</a>. | | <a href="#SkImage_makeRasterImage">makeRasterImage</a> | Creates <a href="#Image">Image</a> compatible with <a href="undocumented#Raster_Surface">Raster Surface</a> if possible. | +| <a href="#SkImage_makeShader">makeShader</a> | Creates <a href="undocumented#Shader">Shader</a>, <a href="SkPaint_Reference#Paint">Paint</a> element that can tile <a href="#Image">Image</a>. | | <a href="#SkImage_makeSubset">makeSubset</a> | Creates <a href="#Image">Image</a> containing part of original. | | <a href="#SkImage_makeTextureImage">makeTextureImage</a> | Creates <a href="#Image">Image</a> matching <a href="undocumented#Color_Space">Color Space</a> if possible. | | <a href="#SkImage_makeWithFilter">makeWithFilter</a> | Creates filtered, clipped <a href="#Image">Image</a>. | ## <a name="Member_Functions"></a> Member Functions -| description | function | -| --- | --- | +| name | description | +| --- | --- | | <a href="#SkImage_MakeBackendTextureFromSkImage">MakeBackendTextureFromSkImage</a> | Creates <a href="undocumented#GPU_Texture">GPU Texture</a> from <a href="#Image">Image</a>. | | <a href="#SkImage_MakeCrossContextFromEncoded">MakeCrossContextFromEncoded</a> | Creates <a href="#Image">Image</a> from encoded data, and uploads to GPU. | | <a href="#SkImage_MakeCrossContextFromPixmap">MakeCrossContextFromPixmap</a> | Creates <a href="#Image">Image</a> from <a href="SkPixmap_Reference#Pixmap">Pixmap</a>, and uploads to GPU. | diff --git a/site/user/api/SkMatrix_Reference.md b/site/user/api/SkMatrix_Reference.md index c612524a90..bcfa5412c0 100644 --- a/site/user/api/SkMatrix_Reference.md +++ b/site/user/api/SkMatrix_Reference.md @@ -3,6 +3,17 @@ SkMatrix Reference # <a name="Matrix"></a> Matrix +## <a name="Overview"></a> Overview + +## <a name="Subtopics"></a> Subtopics + +| name | description | +| --- | --- | +| Constants | enum and enum class, const values | +| <a href="#Constructors">Constructors</a> | functions that construct <a href="SkMatrix_Reference#SkMatrix">SkMatrix</a> | +| <a href="#Member_Functions">Member Functions</a> | static functions and member methods | +| <a href="#Operators">Operators</a> | operator overloading methods | + # <a name="SkMatrix"></a> Class SkMatrix <a href="#Matrix">Matrix</a> holds a 3x3 matrix for transforming coordinates. This allows mapping <a href="#Point">Points</a> and <a href="#Vector">Vectors</a> with translation, scaling, skewing, rotation, and @@ -16,119 +27,112 @@ initializes all <a href="#Matrix">Matrix</a> elements with the corresponding map <a href="#Matrix">Matrix</a> includes a hidden variable that classifies the type of matrix to improve performance. <a href="#Matrix">Matrix</a> is not thread safe unless <a href="#SkMatrix_getType">getType</a> is called first. -# <a name="Overview"></a> Overview - -## <a name="Subtopics"></a> Subtopics - -| topics | description | -| --- | --- | - ## <a name="Constructors"></a> Constructors | name | description | -| --- | --- | -| <a href="#SkMatrix_MakeAll">MakeAll</a> | Constructs all nine values. | -| <a href="#SkMatrix_MakeRectToRect">MakeRectToRect</a> | Constructs from source <a href="SkRect_Reference#Rect">Rect</a> to destination <a href="SkRect_Reference#Rect">Rect</a>. | -| <a href="#SkMatrix_MakeScale">MakeScale</a> | Constructs from scale in x and y. | -| <a href="#SkMatrix_MakeTrans">MakeTrans</a> | Constructs from translate in x and y. | +| --- | --- | +| <a href="#SkMatrix_MakeAll">MakeAll</a> | constructs all nine values | +| <a href="#SkMatrix_MakeRectToRect">MakeRectToRect</a> | constructs from source <a href="SkRect_Reference#Rect">Rect</a> to destination <a href="SkRect_Reference#Rect">Rect</a> | +| <a href="#SkMatrix_MakeScale">MakeScale</a> | constructs from scale in x and y | +| <a href="#SkMatrix_MakeTrans">MakeTrans</a> | constructs from translate in x and y | ## <a name="Operators"></a> Operators -| function | description | -| --- | --- | -| <a href="#SkMatrix_notequal_operator">operator!=(const SkMatrix& a, const SkMatrix& b)</a> | Returns true if members are unequal. | -| <a href="#SkMatrix_equal_operator">operator==(const SkMatrix& a, const SkMatrix& b)</a> | Returns true if members are equal. | -| <a href="#SkMatrix_array1_operator">operator[](int index)</a> | Returns writable reference to <a href="#Matrix">Matrix</a> value. | -| <a href="#SkMatrix_array_operator">operator[](int index) const</a> | Returns <a href="#Matrix">Matrix</a> value. | +| name | description | +| --- | --- | +| <a href="#SkMatrix_notequal_operator">operator!=(const SkMatrix& a, const SkMatrix& b)</a> | returns true if members are unequal | +| <a href="#SkMatrix_equal_operator">operator==(const SkMatrix& a, const SkMatrix& b)</a> | returns true if members are equal | +| <a href="#SkMatrix_array1_operator">operator[](int index)</a> | returns writable reference to <a href="#Matrix">Matrix</a> value | +| <a href="#SkMatrix_array_operator">operator[](int index) const</a> | returns <a href="#Matrix">Matrix</a> value | ## <a name="Member_Functions"></a> Member Functions -| function | description | -| --- | --- | -| <a href="#SkMatrix_Concat">Concat</a> | Returns the concatenation of <a href="#Matrix">Matrix</a> pair. | -| I | Returns a reference to a const identity <a href="#Matrix">Matrix</a>. | -| <a href="#SkMatrix_InvalidMatrix">InvalidMatrix</a> | Returns a reference to a const invalid <a href="#Matrix">Matrix</a>. | -| <a href="#SkMatrix_MakeAll">MakeAll</a> | Constructs all nine values. | -| <a href="#SkMatrix_MakeRectToRect">MakeRectToRect</a> | Constructs from source <a href="SkRect_Reference#Rect">Rect</a> to destination <a href="SkRect_Reference#Rect">Rect</a>. | -| <a href="#SkMatrix_MakeScale">MakeScale</a> | Constructs from scale in x and y. | -| <a href="#SkMatrix_MakeTrans">MakeTrans</a> | Constructs from translate in x and y. | -| <a href="#SkMatrix_SetAffineIdentity">SetAffineIdentity</a> | Sets 3x2 array to identity. | -| <a href="#SkMatrix_asAffine">asAffine</a> | Copies to 3x2 array. | -| <a href="#SkMatrix_cheapEqualTo">cheapEqualTo</a> | Compares <a href="#Matrix">Matrix</a> pair using memcmp(). | -| <a href="#SkMatrix_decomposeScale">decomposeScale</a> | Separates scale if possible. | -| <a href="#SkMatrix_dirtyMatrixTypeCache">dirtyMatrixTypeCache</a> | Sets internal cache to unknown state. | -| <a href="#SkMatrix_dump">dump</a> | Sends text representation using floats to standard output. | -| <a href="#SkMatrix_fixedStepInX">fixedStepInX</a> | Returns step in x for a position in y. | -| <a href="#SkMatrix_get">get</a> | Returns one of nine <a href="#Matrix">Matrix</a> values. | -| <a href="#SkMatrix_get9">get9</a> | Returns all nine <a href="#Matrix">Matrix</a> values. | -| <a href="#SkMatrix_getMaxScale">getMaxScale</a> | Returns maximum scaling, if possible. | -| <a href="#SkMatrix_getMinMaxScales">getMinMaxScales</a> | Returns minimum and maximum scaling, if possible. | -| <a href="#SkMatrix_getMinScale">getMinScale</a> | Returns minimum scaling, if possible. | -| <a href="#SkMatrix_getPerspX">getPerspX</a> | Returns input x perspective factor. | -| <a href="#SkMatrix_getPerspY">getPerspY</a> | Returns input y perspective factor. | -| <a href="#SkMatrix_getScaleX">getScaleX</a> | Returns horizontal scale factor. | -| <a href="#SkMatrix_getScaleY">getScaleY</a> | Returns vertical scale factor. | -| <a href="#SkMatrix_getSkewX">getSkewX</a> | Returns horizontal skew factor. | -| <a href="#SkMatrix_getSkewY">getSkewY</a> | Returns vertical skew factor. | -| <a href="#SkMatrix_getTranslateX">getTranslateX</a> | Returns horizontal translation. | -| <a href="#SkMatrix_getTranslateY">getTranslateY</a> | Returns vertical translation. | -| <a href="#SkMatrix_getType">getType</a> | Returns transform complexity. | -| <a href="#SkMatrix_hasPerspective">hasPerspective</a> | Returns if transform includes perspective. | -| <a href="#SkMatrix_invert">invert</a> | Returns inverse, if possible. | -| <a href="#SkMatrix_isFinite">isFinite</a> | Returns if all <a href="#Matrix">Matrix</a> values are not infinity, NaN. | -| <a href="#SkMatrix_isFixedStepInX">isFixedStepInX</a> | Returns if transformation supports fixed step in x. | -| <a href="#SkMatrix_isIdentity">isIdentity</a> | Returns if matrix equals the identity <a href="#Matrix">Matrix</a> . | -| <a href="#SkMatrix_isScaleTranslate">isScaleTranslate</a> | Returns if transform is limited to scale and translate. | -| <a href="#SkMatrix_isSimilarity">isSimilarity</a> | Returns if transform is limited to square scale and rotation. | -| <a href="#SkMatrix_isTranslate">isTranslate</a> | Returns if transform is limited to translate. | -| <a href="#SkMatrix_mapHomogeneousPoints">mapHomogeneousPoints</a> | Maps <a href="undocumented#Point3">Point3</a> array. | -| <a href="#SkMatrix_mapPoints">mapPoints</a> | Maps <a href="SkPoint_Reference#Point">Point</a> array. | -| <a href="#SkMatrix_mapRadius">mapRadius</a> | Returns mean radius of mapped <a href="undocumented#Circle">Circle</a>. | -| <a href="#SkMatrix_mapRect">mapRect</a> | Returns bounds of mapped <a href="SkRect_Reference#Rect">Rect</a>. | -| <a href="#SkMatrix_mapRectScaleTranslate">mapRectScaleTranslate</a> | Returns bounds of mapped <a href="SkRect_Reference#Rect">Rect</a>. | -| <a href="#SkMatrix_mapRectToQuad">mapRectToQuad</a> | Maps <a href="SkRect_Reference#Rect">Rect</a> to <a href="SkPoint_Reference#Point">Point</a> array. | -| <a href="#SkMatrix_mapVector">mapVector</a> | Maps <a href="SkPoint_Reference#Vector">Vector</a>. | -| <a href="#SkMatrix_mapVectors">mapVectors</a> | Maps <a href="SkPoint_Reference#Vector">Vector</a> array. | -| <a href="#SkMatrix_mapXY">mapXY</a> | Maps <a href="SkPoint_Reference#Point">Point</a>. | -| <a href="#SkMatrix_postConcat">postConcat</a> | Post-multiplies <a href="#Matrix">Matrix</a> by <a href="#Matrix">Matrix</a> parameter. | -| <a href="#SkMatrix_postIDiv">postIDiv</a> | Post-multiplies <a href="#Matrix">Matrix</a> by inverse scale. | -| <a href="#SkMatrix_postRotate">postRotate</a> | Post-multiplies <a href="#Matrix">Matrix</a> by rotation. | -| <a href="#SkMatrix_postScale">postScale</a> | Post-multiplies <a href="#Matrix">Matrix</a> by scale. | -| <a href="#SkMatrix_postSkew">postSkew</a> | Post-multiplies <a href="#Matrix">Matrix</a> by skew. | -| <a href="#SkMatrix_postTranslate">postTranslate</a> | Post-multiplies <a href="#Matrix">Matrix</a> by translation. | -| <a href="#SkMatrix_preConcat">preConcat</a> | Pre-multiplies <a href="#Matrix">Matrix</a> by <a href="#Matrix">Matrix</a> parameter. | -| <a href="#SkMatrix_preRotate">preRotate</a> | Pre-multiplies <a href="#Matrix">Matrix</a> by rotation. | -| <a href="#SkMatrix_preScale">preScale</a> | Pre-multiplies <a href="#Matrix">Matrix</a> by scale. | -| <a href="#SkMatrix_preSkew">preSkew</a> | Pre-multiplies <a href="#Matrix">Matrix</a> by skew. | -| <a href="#SkMatrix_preTranslate">preTranslate</a> | Pre-multiplies <a href="#Matrix">Matrix</a> by translation. | -| <a href="#SkMatrix_preservesAxisAlignment">preservesAxisAlignment</a> | Returns if mapping restricts to 90 degree multiples and mirroring. | -| <a href="#SkMatrix_preservesRightAngles">preservesRightAngles</a> | Returns if mapped 90 angle remains 90 degrees. | -| <a href="#SkMatrix_rectStaysRect">rectStaysRect</a> | Returns if mapped <a href="SkRect_Reference#Rect">Rect</a> can be represented by another <a href="SkRect_Reference#Rect">Rect</a>. | -| <a href="#SkMatrix_reset">reset</a> | Sets <a href="#Matrix">Matrix</a> to identity. | -| <a href="#SkMatrix_set">set</a> | Sets one value. | -| <a href="#SkMatrix_set9">set9</a> | Sets all values from <a href="#Scalar">Scalar</a> array. | -| <a href="#SkMatrix_setAffine">setAffine</a> | Sets left two columns. | -| <a href="#SkMatrix_setAll">setAll</a> | Sets all values from parameters. | -| <a href="#SkMatrix_setConcat">setConcat</a> | Sets to <a href="#Matrix">Matrix</a> parameter multiplied by <a href="#Matrix">Matrix</a> parameter. | -| <a href="#SkMatrix_setIdentity">setIdentity</a> | Sets <a href="#Matrix">Matrix</a> to identity. | -| <a href="#SkMatrix_setPerspX">setPerspX</a> | Sets input x perspective factor. | -| <a href="#SkMatrix_setPerspY">setPerspY</a> | Sets input y perspective factor. | -| <a href="#SkMatrix_setPolyToPoly">setPolyToPoly</a> | Sets to map one to four points to an equal array of points. | -| <a href="#SkMatrix_setRSXform">setRSXform</a> | Sets to rotate, scale, and translate. | -| <a href="#SkMatrix_setRectToRect">setRectToRect</a> | Sets to map one <a href="SkRect_Reference#Rect">Rect</a> to another. | -| <a href="#SkMatrix_setRotate">setRotate</a> | Sets to rotate about a point. | -| <a href="#SkMatrix_setScale">setScale</a> | Sets to scale about a point. | -| <a href="#SkMatrix_setScaleTranslate">setScaleTranslate</a> | Sets to scale and translate. | -| <a href="#SkMatrix_setScaleX">setScaleX</a> | Sets horizontal scale factor. | -| <a href="#SkMatrix_setScaleY">setScaleY</a> | Sets vertical scale factor | -| <a href="#SkMatrix_setSinCos">setSinCos</a> | Sets to rotate and scale about a point. | -| <a href="#SkMatrix_setSkew">setSkew</a> | Sets to skew about a point. | -| <a href="#SkMatrix_setSkewX">setSkewX</a> | Sets horizontal skew factor. | -| <a href="#SkMatrix_setSkewY">setSkewY</a> | Sets vertical skew factor. | -| <a href="#SkMatrix_setTranslate">setTranslate</a> | Sets to translate in x and y. | -| <a href="#SkMatrix_setTranslateX">setTranslateX</a> | Sets horizontal translation. | -| <a href="#SkMatrix_setTranslateY">setTranslateY</a> | Sets vertical translation. | -| <a href="#SkMatrix_toString">toString</a> | Converts <a href="#Matrix">Matrix</a> to machine readable form. | +| name | description | +| --- | --- | +| <a href="#SkMatrix_Concat">Concat</a> | returns the concatenation of <a href="#Matrix">Matrix</a> pair | +| I | returns a reference to a const identity <a href="#Matrix">Matrix</a> | +| <a href="#SkMatrix_InvalidMatrix">InvalidMatrix</a> | returns a reference to a const invalid <a href="#Matrix">Matrix</a> | +| <a href="#SkMatrix_MakeAll">MakeAll</a> | constructs all nine values | +| <a href="#SkMatrix_MakeRectToRect">MakeRectToRect</a> | constructs from source <a href="SkRect_Reference#Rect">Rect</a> to destination <a href="SkRect_Reference#Rect">Rect</a> | +| <a href="#SkMatrix_MakeScale">MakeScale</a> | constructs from scale in x and y | +| <a href="#SkMatrix_MakeTrans">MakeTrans</a> | constructs from translate in x and y | +| <a href="#SkMatrix_SetAffineIdentity">SetAffineIdentity</a> | sets 3x2 array to identity | +| <a href="#SkMatrix_asAffine">asAffine</a> | copies to 3x2 array | +| <a href="#SkMatrix_cheapEqualTo">cheapEqualTo</a> | compares <a href="#Matrix">Matrix</a> pair using memcmp() | +| <a href="#SkMatrix_decomposeScale">decomposeScale</a> | separates scale if possible | +| <a href="#SkMatrix_dirtyMatrixTypeCache">dirtyMatrixTypeCache</a> | sets internal cache to unknown state | +| <a href="#SkMatrix_dump">dump</a> | sends text representation using floats to standard output | +| <a href="#SkMatrix_fixedStepInX">fixedStepInX</a> | returns step in x for a position in y | +| <a href="#SkMatrix_get">get</a> | returns one of nine <a href="#Matrix">Matrix</a> values | +| <a href="#SkMatrix_get9">get9</a> | returns all nine <a href="#Matrix">Matrix</a> values | +| <a href="#SkMatrix_getMaxScale">getMaxScale</a> | returns maximum scaling, if possible | +| <a href="#SkMatrix_getMinMaxScales">getMinMaxScales</a> | returns minimum and maximum scaling, if possible | +| <a href="#SkMatrix_getMinScale">getMinScale</a> | returns minimum scaling, if possible | +| <a href="#SkMatrix_getPerspX">getPerspX</a> | returns input x perspective factor | +| <a href="#SkMatrix_getPerspY">getPerspY</a> | returns input y perspective factor | +| <a href="#SkMatrix_getScaleX">getScaleX</a> | returns horizontal scale factor | +| <a href="#SkMatrix_getScaleY">getScaleY</a> | returns vertical scale factor | +| <a href="#SkMatrix_getSkewX">getSkewX</a> | returns horizontal skew factor | +| <a href="#SkMatrix_getSkewY">getSkewY</a> | returns vertical skew factor | +| <a href="#SkMatrix_getTranslateX">getTranslateX</a> | returns horizontal translation | +| <a href="#SkMatrix_getTranslateY">getTranslateY</a> | returns vertical translation | +| <a href="#SkMatrix_getType">getType</a> | returns transform complexity | +| <a href="#SkMatrix_hasPerspective">hasPerspective</a> | returns if transform includes perspective | +| <a href="#SkMatrix_invert">invert</a> | returns inverse, if possible | +| <a href="#SkMatrix_isFinite">isFinite</a> | returns if all <a href="#Matrix">Matrix</a> values are not infinity, NaN | +| <a href="#SkMatrix_isFixedStepInX">isFixedStepInX</a> | returns if transformation supports fixed step in x | +| <a href="#SkMatrix_isIdentity">isIdentity</a> | returns if matrix equals the identity <a href="#Matrix">Matrix</a> | +| <a href="#SkMatrix_isScaleTranslate">isScaleTranslate</a> | returns if transform is limited to scale and translate | +| <a href="#SkMatrix_isSimilarity">isSimilarity</a> | returns if transform is limited to square scale and rotation | +| <a href="#SkMatrix_isTranslate">isTranslate</a> | returns if transform is limited to translate | +| <a href="#SkMatrix_mapHomogeneousPoints">mapHomogeneousPoints</a> | maps <a href="undocumented#Point3">Point3</a> array | +| <a href="#SkMatrix_mapPoints">mapPoints</a> | maps <a href="SkPoint_Reference#Point">Point</a> array | +| <a href="#SkMatrix_mapRadius">mapRadius</a> | returns mean radius of mapped <a href="undocumented#Circle">Circle</a> | +| <a href="#SkMatrix_mapRect">mapRect</a> | returns bounds of mapped <a href="SkRect_Reference#Rect">Rect</a> | +| <a href="#SkMatrix_mapRectScaleTranslate">mapRectScaleTranslate</a> | returns bounds of mapped <a href="SkRect_Reference#Rect">Rect</a> | +| <a href="#SkMatrix_mapRectToQuad">mapRectToQuad</a> | maps <a href="SkRect_Reference#Rect">Rect</a> to <a href="SkPoint_Reference#Point">Point</a> array | +| <a href="#SkMatrix_mapVector">mapVector</a> | maps <a href="SkPoint_Reference#Vector">Vector</a> | +| <a href="#SkMatrix_mapVectors">mapVectors</a> | maps <a href="SkPoint_Reference#Vector">Vector</a> array | +| <a href="#SkMatrix_mapXY">mapXY</a> | maps <a href="SkPoint_Reference#Point">Point</a> | +| <a href="#SkMatrix_postConcat">postConcat</a> | post-multiplies <a href="#Matrix">Matrix</a> by <a href="#Matrix">Matrix</a> parameter | +| <a href="#SkMatrix_postIDiv">postIDiv</a> | post-multiplies <a href="#Matrix">Matrix</a> by inverse scale | +| <a href="#SkMatrix_postRotate">postRotate</a> | post-multiplies <a href="#Matrix">Matrix</a> by rotation | +| <a href="#SkMatrix_postScale">postScale</a> | post-multiplies <a href="#Matrix">Matrix</a> by scale | +| <a href="#SkMatrix_postSkew">postSkew</a> | post-multiplies <a href="#Matrix">Matrix</a> by skew | +| <a href="#SkMatrix_postTranslate">postTranslate</a> | post-multiplies <a href="#Matrix">Matrix</a> by translation | +| <a href="#SkMatrix_preConcat">preConcat</a> | pre-multiplies <a href="#Matrix">Matrix</a> by <a href="#Matrix">Matrix</a> parameter | +| <a href="#SkMatrix_preRotate">preRotate</a> | pre-multiplies <a href="#Matrix">Matrix</a> by rotation | +| <a href="#SkMatrix_preScale">preScale</a> | pre-multiplies <a href="#Matrix">Matrix</a> by scale | +| <a href="#SkMatrix_preSkew">preSkew</a> | pre-multiplies <a href="#Matrix">Matrix</a> by skew | +| <a href="#SkMatrix_preTranslate">preTranslate</a> | pre-multiplies <a href="#Matrix">Matrix</a> by translation | +| <a href="#SkMatrix_preservesAxisAlignment">preservesAxisAlignment</a> | returns if mapping restricts to 90 degree multiples and mirroring | +| <a href="#SkMatrix_preservesRightAngles">preservesRightAngles</a> | returns if mapped 90 angle remains 90 degrees | +| <a href="#SkMatrix_rectStaysRect">rectStaysRect</a> | returns if mapped <a href="SkRect_Reference#Rect">Rect</a> can be represented by another <a href="SkRect_Reference#Rect">Rect</a> | +| <a href="#SkMatrix_reset">reset</a> | sets <a href="#Matrix">Matrix</a> to identity | +| <a href="#SkMatrix_set">set</a> | sets one value | +| <a href="#SkMatrix_set9">set9</a> | sets all values from <a href="#Scalar">Scalar</a> array | +| <a href="#SkMatrix_setAffine">setAffine</a> | sets left two columns | +| <a href="#SkMatrix_setAll">setAll</a> | sets all values from parameters | +| <a href="#SkMatrix_setConcat">setConcat</a> | sets to <a href="#Matrix">Matrix</a> parameter multiplied by <a href="#Matrix">Matrix</a> parameter | +| <a href="#SkMatrix_setIdentity">setIdentity</a> | sets <a href="#Matrix">Matrix</a> to identity | +| <a href="#SkMatrix_setPerspX">setPerspX</a> | sets input x perspective factor | +| <a href="#SkMatrix_setPerspY">setPerspY</a> | sets input y perspective factor | +| <a href="#SkMatrix_setPolyToPoly">setPolyToPoly</a> | sets to map one to four points to an equal array of points | +| <a href="#SkMatrix_setRSXform">setRSXform</a> | sets to rotate, scale, and translate | +| <a href="#SkMatrix_setRectToRect">setRectToRect</a> | sets to map one <a href="SkRect_Reference#Rect">Rect</a> to another | +| <a href="#SkMatrix_setRotate">setRotate</a> | sets to rotate about a point | +| <a href="#SkMatrix_setScale">setScale</a> | sets to scale about a point | +| <a href="#SkMatrix_setScaleTranslate">setScaleTranslate</a> | sets to scale and translate | +| <a href="#SkMatrix_setScaleX">setScaleX</a> | sets horizontal scale factor | +| <a href="#SkMatrix_setScaleY">setScaleY</a> | sets vertical scale factor | +| <a href="#SkMatrix_setSinCos">setSinCos</a> | sets to rotate and scale about a point | +| <a href="#SkMatrix_setSkew">setSkew</a> | sets to skew about a point | +| <a href="#SkMatrix_setSkewX">setSkewX</a> | sets horizontal skew factor | +| <a href="#SkMatrix_setSkewY">setSkewY</a> | sets vertical skew factor | +| <a href="#SkMatrix_setTranslate">setTranslate</a> | sets to translate in x and y | +| <a href="#SkMatrix_setTranslateX">setTranslateX</a> | sets horizontal translation | +| <a href="#SkMatrix_setTranslateY">setTranslateY</a> | sets vertical translation | +| <a href="#SkMatrix_toString">toString</a> | converts <a href="#Matrix">Matrix</a> to machine readable form | <a name="SkMatrix_MakeScale"></a> ## MakeScale diff --git a/site/user/api/SkPaint_Reference.md b/site/user/api/SkPaint_Reference.md index fcb0a5829f..1f9d6236fe 100644 --- a/site/user/api/SkPaint_Reference.md +++ b/site/user/api/SkPaint_Reference.md @@ -3,6 +3,19 @@ SkPaint Reference # <a name="Paint"></a> Paint +## <a name="Overview"></a> Overview + +## <a name="Subtopics"></a> Subtopics + +| name | description | +| --- | --- | +| <a href="#Classes_and_Structs">Classes and Structs</a> | embedded struct and class members | +| <a href="#Constants">Constants</a> | enum and enum class, const values | +| <a href="#Constructors">Constructors</a> | functions that construct <a href="SkPaint_Reference#SkPaint">SkPaint</a> | +| <a href="#Member_Functions">Member Functions</a> | static functions and member methods | +| <a href="#Operators">Operators</a> | operator overloading methods | +| <a href="#Related_Functions">Related Functions</a> | similar methods grouped together | + # <a name="SkPaint"></a> Class SkPaint <a href="#Paint">Paint</a> controls options applied when drawing and measuring. <a href="#Paint">Paint</a> collects all options outside of the <a href="#Clip">Canvas Clip</a> and <a href="#Matrix">Canvas Matrix</a>. @@ -30,53 +43,46 @@ is set in <a href="#Paint">Paint</a>. Multiple colors are drawn either by using multiple paints or with objects like <a href="undocumented#Shader">Shader</a> attached to <a href="#Paint">Paint</a>. -# <a name="Overview"></a> Overview - -## <a name="Subtopics"></a> Subtopics - -| name | description | -| --- | --- | -| <a href="#Overview_Classes_and_Structs">Classes and Structs</a> | embedded struct and class members | -| <a href="#Overview_Constants">Constants</a> | enum and enum class, const values | -| <a href="#Overview_Constructors">Constructors</a> | list of functions that construct <a href="SkPath_Reference#SkPath">SkPath</a> | -| <a href="#Overview_Member_Functions">Member Functions</a> | list of static functions and member methods | -| <a href="#Overview_Operators">Operators</a> | operator overloading methods | -| <a href="#Overview_Related_Functions">Related Functions</a> | similar methods grouped together | - ## <a name="Related_Functions"></a> Related Functions | name | description | -| --- | --- | +| --- | --- | +| <a href="#Alpha_Methods">Alpha Methods</a> | get and set <a href="#Alpha">Alpha</a> | | Anti-alias | approximating coverage with transparency | | <a href="#Automatic_Hinting">Automatic Hinting</a> | always adjust glyph paths | | <a href="#Blend_Mode_Methods">Blend Mode Methods</a> | get and set <a href="undocumented#Blend_Mode">Blend Mode</a> | | <a href="#Color_Filter_Methods">Color Filter Methods</a> | get and set <a href="undocumented#Color_Filter">Color Filter</a> | | <a href="#Color_Methods">Color Methods</a> | get and set <a href="undocumented#Color">Color</a> | -| Destructor | paint termination | | <a href="#Device_Text">Device Text</a> | increase precision of glyph position | | <a href="#Dither">Dither</a> | distributing color error | | <a href="#Draw_Looper_Methods">Draw Looper Methods</a> | get and set <a href="undocumented#Draw_Looper">Draw Looper</a> | | <a href="#Fake_Bold">Fake Bold</a> | approximate font styles | | <a href="#Fast_Bounds">Fast Bounds</a> | approximate area required by <a href="#Paint">Paint</a> | +| Fill | fill and stroke | | <a href="#Fill_Path">Fill Path</a> | make <a href="SkPath_Reference#Path">Path</a> from <a href="undocumented#Path_Effect">Path Effect</a>, stroking | | <a href="#Filter_Quality_Methods">Filter Quality Methods</a> | get and set <a href="undocumented#Filter_Quality">Filter Quality</a> | | <a href="#SkPaint_Flags">Flags</a> | attributes represented by single bits | | <a href="SkPaint_Reference#Font_Embedded_Bitmaps">Font Embedded Bitmaps</a> | custom sized bitmap <a href="#Glyph">Glyphs</a> | | <a href="#Font_Metrics">Font Metrics</a> | common glyph dimensions | | <a href="SkPaint_Reference#Full_Hinting_Spacing">Full Hinting Spacing</a> | glyph spacing affected by hinting | +| <a href="#Hairline">Hairline</a> | lines and curves with minimal width | | <a href="#SkPaint_Hinting">Hinting</a> | glyph outline adjustment | | <a href="#Image_Filter_Methods">Image Filter Methods</a> | get and set <a href="undocumented#Image_Filter">Image Filter</a> | | <a href="#Initializers">Initializers</a> | constructors and initialization | +| <a href="SkPaint_Reference#LCD_Text">LCD Text</a> | text relying on the order of <a href="#RGB">Color RGB</a> stripes | +| <a href="SkPaint_Reference#Linear_Text">Linear Text</a> | selects text rendering as <a href="undocumented#Glyph">Glyph</a> or <a href="SkPath_Reference#Path">Path</a> | | <a href="#Management">Management</a> | paint copying, moving, comparing | | <a href="#Mask_Filter_Methods">Mask Filter Methods</a> | get and set <a href="undocumented#Mask_Filter">Mask Filter</a> | | <a href="#Measure_Text">Measure Text</a> | width, height, bounds of text | | <a href="#Miter_Limit">Miter Limit</a> | maximum length of stroked corners | | <a href="#Path_Effect_Methods">Path Effect Methods</a> | get and set <a href="undocumented#Path_Effect">Path Effect</a> | | <a href="#Shader_Methods">Shader Methods</a> | get and set <a href="undocumented#Shader">Shader</a> | +| Stroke | lines and curves with width | | <a href="#Stroke_Cap">Stroke Cap</a> | decorations at ends of open strokes | | <a href="#Stroke_Join">Stroke Join</a> | decoration at corners of strokes | | <a href="#Stroke_Width">Stroke Width</a> | thickness perpendicular to geometry | | <a href="#SkPaint_Style">Style</a> | geometry filling, stroking | +| <a href="SkPaint_Reference#Subpixel_Text">Subpixel Text</a> | uses pixel transparency to represent fractional offset | | <a href="#Text_Align">Text Align</a> | text placement relative to position | | <a href="#Text_Encoding">Text Encoding</a> | text encoded as characters or <a href="#Glyph">Glyphs</a> | | <a href="#Text_Intercepts">Text Intercepts</a> | advanced underline, strike through | @@ -90,35 +96,37 @@ Multiple colors are drawn either by using multiple paints or with objects like ## <a name="Constants"></a> Constants | name | description | -| --- | --- | +| --- | --- | | <a href="#SkPaint_Align">Align</a> | glyph locations relative to text position | | <a href="#SkPaint_Cap">Cap</a> | start and end geometry on stroked shapes | | <a href="#SkPaint_Flags">Flags</a> | values described by bits and masks | -| <a href="#SkPaint_FontMetrics_FontMetricsFlags">FontMetrics::FontMetricsFlags</a> | valid <a href="#Font_Metrics">Font Metrics</a> | | <a href="#SkPaint_Hinting">Hinting</a> | level of glyph outline adjustment | | <a href="#SkPaint_Join">Join</a> | corner geometry on stroked shapes | +| <a href="#SkPaint_ReserveFlags">ReserveFlags</a> | values described by bits and masks | | <a href="#SkPaint_Style">Style</a> | stroke, fill, or both | | <a href="#SkPaint_TextEncoding">TextEncoding</a> | character or glyph encoded size | +| _anonymous | number of <a href="#SkPaint_Style">Style</a> defines | +| _anonymous_2 | number of <a href="#Text_Align">Text Align</a> values | ## <a name="Classes_and_Structs"></a> Classes and Structs | name | description | -| --- | --- | -| <a href="#SkPaint_FontMetrics">FontMetrics</a> | typeface values | +| --- | --- | +| <a href="#SkPaint_FontMetrics">FontMetrics</a> | values computed by <a href="undocumented#Font_Manager">Font Manager</a> using <a href="undocumented#Typeface">Typeface</a> | ## <a name="Constructors"></a> Constructors | name | description | -| --- | --- | +| --- | --- | | <a href="#SkPaint_empty_constructor">SkPaint()</a> | constructs with default values | | <a href="#SkPaint_move_SkPaint">SkPaint(SkPaint&& paint)</a> | moves paint without copying it | | <a href="#SkPaint_copy_const_SkPaint">SkPaint(const SkPaint& paint)</a> | makes a shallow copy | -| | decreases <a href="undocumented#Reference_Count">Reference Count</a> of owned objects | +| <a href="#SkPaint_destructor">~SkPaint()</a> | decreases <a href="undocumented#Reference_Count">Reference Count</a> of owned objects | ## <a name="Operators"></a> Operators | name | description | -| --- | --- | +| --- | --- | | <a href="#SkPaint_notequal_operator">operator!=(const SkPaint& a, const SkPaint& b)</a> | compares paints for inequality | | <a href="#SkPaint_move_operator">operator=(SkPaint&& paint)</a> | moves paint without copying it | | <a href="#SkPaint_copy_operator">operator=(const SkPaint& paint)</a> | makes a shallow copy | @@ -127,7 +135,7 @@ Multiple colors are drawn either by using multiple paints or with objects like ## <a name="Member_Functions"></a> Member Functions | name | description | -| --- | --- | +| --- | --- | | <a href="#SkPaint_breakText">breakText</a> | returns text that fits in a width | | <a href="#SkPaint_canComputeFastBounds">canComputeFastBounds</a> | returns true if settings allow for fast bounds computation | | <a href="#SkPaint_computeFastBounds">computeFastBounds</a> | returns fill bounds for quick reject tests | @@ -150,6 +158,7 @@ Multiple colors are drawn either by using multiple paints or with objects like | <a href="#SkPaint_getHash">getHash</a> | returns a shallow hash for equality checks | | <a href="#SkPaint_getHinting">getHinting</a> | returns <a href="#SkPaint_Hinting">Hinting</a>, glyph outline adjustment level | | <a href="#SkPaint_getImageFilter">getImageFilter</a> | returns <a href="undocumented#Image_Filter">Image Filter</a>, alter pixels; blur | +| <a href="#SkPaint_getLooper">getLooper</a> | deprecated | | <a href="#SkPaint_getMaskFilter">getMaskFilter</a> | returns <a href="undocumented#Mask_Filter">Mask Filter</a>, alterations to <a href="undocumented#Mask_Alpha">Mask Alpha</a> | | <a href="#SkPaint_getPathEffect">getPathEffect</a> | returns <a href="undocumented#Path_Effect">Path Effect</a>, modifications to path geometry; dashing | | <a href="#SkPaint_getPosTextHIntercepts">getPosTextHIntercepts</a> | returns where lines intersect horizontally positioned text; underlines | @@ -179,6 +188,7 @@ Multiple colors are drawn either by using multiple paints or with objects like | <a href="#SkPaint_isEmbeddedBitmapText">isEmbeddedBitmapText</a> | returns true if <a href="SkPaint_Reference#Font_Embedded_Bitmaps">Font Embedded Bitmaps</a> is set | | <a href="#SkPaint_isFakeBoldText">isFakeBoldText</a> | returns true if <a href="#Fake_Bold">Fake Bold</a> is set | | <a href="#SkPaint_isLCDRenderText">isLCDRenderText</a> | returns true if <a href="SkPaint_Reference#LCD_Text">LCD Text</a> is set | +| <a href="#SkPaint_isLinearText">isLinearText</a> | returns true if text is converted to <a href="SkPath_Reference#Path">Path</a> | | <a href="#SkPaint_isSrcOver">isSrcOver</a> | returns true if <a href="undocumented#Blend_Mode">Blend Mode</a> is <a href="#SkBlendMode_kSrcOver">SkBlendMode::kSrcOver</a> | | <a href="#SkPaint_isSubpixelText">isSubpixelText</a> | returns true if <a href="SkPaint_Reference#Subpixel_Text">Subpixel Text</a> is set | | <a href="#SkPaint_isVerticalText">isVerticalText</a> | returns true if <a href="#Vertical_Text">Vertical Text</a> is set | @@ -209,6 +219,8 @@ Multiple colors are drawn either by using multiple paints or with objects like | <a href="#SkPaint_setHinting">setHinting</a> | sets <a href="#SkPaint_Hinting">Hinting</a>, glyph outline adjustment level | | <a href="#SkPaint_setImageFilter">setImageFilter</a> | sets <a href="undocumented#Image_Filter">Image Filter</a>, alter pixels; blur | | <a href="#SkPaint_setLCDRenderText">setLCDRenderText</a> | sets or clears <a href="SkPaint_Reference#LCD_Text">LCD Text</a> | +| <a href="#SkPaint_setLinearText">setLinearText</a> | converts to <a href="SkPath_Reference#Path">Path</a> before draw or measure | +| <a href="#SkPaint_setLooper">setLooper</a> | deprecated | | <a href="#SkPaint_setMaskFilter">setMaskFilter</a> | sets <a href="undocumented#Mask_Filter">Mask Filter</a>, alterations to <a href="undocumented#Mask_Alpha">Mask Alpha</a> | | <a href="#SkPaint_setPathEffect">setPathEffect</a> | sets <a href="undocumented#Path_Effect">Path Effect</a>, modifications to path geometry; dashing | | <a href="#SkPaint_setShader">setShader</a> | sets <a href="undocumented#Shader">Shader</a>, multiple drawing colors; gradients | @@ -229,7 +241,7 @@ Multiple colors are drawn either by using multiple paints or with objects like | <a href="#SkPaint_toString">toString</a> | converts <a href="#Paint">Paint</a> to machine readable form | | <a href="#SkPaint_unflatten">unflatten</a> | populates from a serialized stream | -# <a name="Initializers"></a> Initializers +## <a name="Initializers"></a> Initializers <a name="SkPaint_empty_constructor"></a> ## SkPaint @@ -392,8 +404,6 @@ paint1 == paint2 --- -# <a name="Destructor"></a> Destructor - <a name="SkPaint_destructor"></a> ## ~SkPaint @@ -407,7 +417,7 @@ objects containing <a href="undocumented#Reference_Count">Reference Count</a> go --- -# <a name="Management"></a> Management +## <a name="Management"></a> Management <a name="SkPaint_copy_operator"></a> ## operator= @@ -651,7 +661,7 @@ false if the <a href="#SkPaint_unflatten_buffer">buffer</a> contains invalid dat --- -# <a name="Hinting"></a> Hinting +## <a name="Hinting"></a> Hinting ## <a name="SkPaint_Hinting"></a> Enum SkPaint::Hinting @@ -774,7 +784,7 @@ paint1 == paint2 --- -# <a name="Flags"></a> Flags +## <a name="Flags"></a> Flags ## <a name="SkPaint_Flags"></a> Enum SkPaint::Flags @@ -930,7 +940,8 @@ paint.isDither() --- -# <a name="Anti-alias"></a> Anti-alias +## <a name="Anti-alias"></a> Anti-alias + Anti-alias drawing approximates partial pixel coverage with transparency. If <a href="#SkPaint_kAntiAlias_Flag">kAntiAlias Flag</a> is clear, pixel centers contained by the shape edge are drawn opaque. If <a href="#SkPaint_kAntiAlias_Flag">kAntiAlias Flag</a> is set, pixels are drawn with <a href="#Alpha">Color Alpha</a> equal to their coverage. @@ -1022,7 +1033,8 @@ paint1 == paint2 --- -# <a name="Dither"></a> Dither +## <a name="Dither"></a> Dither + <a href="#Dither">Dither</a> increases fidelity by adjusting the color of adjacent pixels. This can help to smooth color transitions and reducing banding in gradients. Dithering lessens visible banding from <a href="SkImageInfo_Reference#SkColorType">kRGB 565 SkColorType</a> @@ -1121,7 +1133,8 @@ paint1 == paint2 Gradient <a href="#RGB">Color RGB</a>-565 -# <a name="Device_Text"></a> Device Text +## <a name="Device_Text"></a> Device Text + <a href="SkPaint_Reference#LCD_Text">LCD Text</a> and <a href="SkPaint_Reference#Subpixel_Text">Subpixel Text</a> increase the precision of glyph position. When set, <a href="#SkPaint_Flags">Flags</a> <a href="#SkPaint_kLCDRenderText_Flag">kLCDRenderText Flag</a> takes advantage of the organization of <a href="#RGB">Color RGB</a> stripes that @@ -1346,7 +1359,8 @@ paint1 == paint2 --- -# <a name="Font_Embedded_Bitmaps"></a> Font Embedded Bitmaps +## <a name="Font_Embedded_Bitmaps"></a> Font Embedded Bitmaps + <a href="SkPaint_Reference#Font_Embedded_Bitmaps">Font Embedded Bitmaps</a> allows selecting custom sized bitmap <a href="#Glyph">Glyphs</a>. <a href="#SkPaint_Flags">Flags</a> <a href="#SkPaint_kEmbeddedBitmapText_Flag">kEmbeddedBitmapText Flag</a> when set chooses an embedded bitmap glyph over an outline contained in a font if the platform supports this option. @@ -1448,7 +1462,8 @@ paint1 == paint2 --- -# <a name="Automatic_Hinting"></a> Automatic Hinting +## <a name="Automatic_Hinting"></a> Automatic Hinting + If <a href="#SkPaint_Hinting">Hinting</a> is set to <a href="#SkPaint_kNormal_Hinting">kNormal Hinting</a> or <a href="#SkPaint_kFull_Hinting">kFull Hinting</a>, <a href="#Automatic_Hinting">Automatic Hinting</a> instructs the <a href="undocumented#Font_Manager">Font Manager</a> to always hint <a href="#Glyph">Glyphs</a>. <a href="#Automatic_Hinting">Automatic Hinting</a> has no effect if <a href="#SkPaint_Hinting">Hinting</a> is set to <a href="#SkPaint_kNo_Hinting">kNo Hinting</a> or @@ -1526,7 +1541,8 @@ setting for <a href="#SkPaint_kAutoHinting_Flag">kAutoHinting Flag</a></td> --- -# <a name="Vertical_Text"></a> Vertical Text +## <a name="Vertical_Text"></a> Vertical Text + <a href="undocumented#Text">Text</a> may be drawn by positioning each glyph, or by positioning the first glyph and using <a href="#Advance">Font Advance</a> to position subsequent <a href="#Glyph">Glyphs</a>. By default, each successive glyph is positioned to the right of the preceding glyph. <a href="#Vertical_Text">Vertical Text</a> sets successive @@ -1615,7 +1631,8 @@ paint1 == paint2 --- -# <a name="Fake_Bold"></a> Fake Bold +## <a name="Fake_Bold"></a> Fake Bold + <a href="#Fake_Bold">Fake Bold</a> approximates the bold font style accompanying a normal font when a bold font face is not available. Skia does not provide font substitution; it is up to the client to find the bold font face using the platform <a href="undocumented#Font_Manager">Font Manager</a>. @@ -1697,7 +1714,8 @@ paint1 == paint2 --- -# <a name="Full_Hinting_Spacing"></a> Full Hinting Spacing +## <a name="Full_Hinting_Spacing"></a> Full Hinting Spacing + if <a href="#SkPaint_Hinting">Hinting</a> is set to <a href="#SkPaint_kFull_Hinting">kFull Hinting</a>, <a href="SkPaint_Reference#Full_Hinting_Spacing">Full Hinting Spacing</a> adjusts the character spacing by the difference of the hinted and Unhinted <a href="undocumented#Left_Side_Bearing">Left Side Bearing</a> and <a href="undocumented#Right_Side_Bearing">Right Side Bearing</a>. <a href="SkPaint_Reference#Full_Hinting_Spacing">Full Hinting Spacing</a> only applies to platforms that use @@ -1760,7 +1778,8 @@ paint1 == paint2 --- -# <a name="Filter_Quality_Methods"></a> Filter Quality Methods +## <a name="Filter_Quality_Methods"></a> Filter Quality Methods + <a href="undocumented#Filter_Quality">Filter Quality</a> trades speed for image filtering when the image is scaled. A lower <a href="undocumented#Filter_Quality">Filter Quality</a> draws faster, but has less fidelity. A higher <a href="undocumented#Filter_Quality">Filter Quality</a> draws slower, but looks better. @@ -1850,7 +1869,7 @@ kHigh_SkFilterQuality == paint.getFilterQuality() --- -# <a name="Color_Methods"></a> Color Methods +## <a name="Color_Methods"></a> Color Methods | name | description | | --- | --- | @@ -2051,7 +2070,8 @@ transRed1 == transRed2 --- -# <a name="Style"></a> Style +## <a name="Style"></a> Style + <a href="#Style">Style</a> specifies if the geometry is filled, stroked, or both filled and stroked. Some shapes ignore <a href="#Style">Style</a> and are always drawn filled or stroked. @@ -2211,7 +2231,8 @@ one of: <a href="#SkPaint_kFill_Style">kFill Style</a>, <a href="#SkPaint_kStrok <a href="#Fill_Type">Path Fill Type</a> <a href="undocumented#Path_Effect">Path Effect</a> <a href="#Style_Fill">Style Fill</a> <a href="#Style_Stroke">Style Stroke</a> -# <a name="Stroke_Width"></a> Stroke Width +## <a name="Stroke_Width"></a> Stroke Width + <a href="#Stroke_Width">Stroke Width</a> sets the width for stroking. The width is the thickness of the stroke perpendicular to the path direction when the paint style is set to <a href="#SkPaint_kStroke_Style">kStroke Style</a> or <a href="#SkPaint_kStrokeAndFill_Style">kStrokeAndFill Style</a>. @@ -2290,7 +2311,8 @@ zero thickness for <a href="#Hairline">Hairline</a>; greater than zero for pen t --- -# <a name="Miter_Limit"></a> Miter Limit +## <a name="Miter_Limit"></a> Miter Limit + <a href="#Miter_Limit">Miter Limit</a> specifies the maximum miter length, relative to the stroke width. @@ -2395,7 +2417,7 @@ default miter limit == 8 --- -# <a name="Stroke_Cap"></a> Stroke Cap +## <a name="Stroke_Cap"></a> Stroke Cap ## <a name="SkPaint_Cap"></a> Enum SkPaint::Cap @@ -2528,7 +2550,8 @@ kRound_Cap == paint.getStrokeCap() --- -# <a name="Stroke_Join"></a> Stroke Join +## <a name="Stroke_Join"></a> Stroke Join + <a href="#Stroke_Join">Stroke Join</a> draws at the sharp corners of an open or closed <a href="#Contour">Path Contour</a>. Stroke describes the area covered by a pen of <a href="#Stroke_Width">Stroke Width</a> as it @@ -2674,7 +2697,8 @@ kMiter_Join == paint.getStrokeJoin() <a href="#Miter_Limit">Miter Limit</a> -# <a name="Fill_Path"></a> Fill Path +## <a name="Fill_Path"></a> Fill Path + <a href="#Fill_Path">Fill Path</a> creates a <a href="SkPath_Reference#Path">Path</a> by applying the <a href="undocumented#Path_Effect">Path Effect</a>, followed by the <a href="#Style_Stroke">Style Stroke</a>. If <a href="#Paint">Paint</a> contains <a href="undocumented#Path_Effect">Path Effect</a>, <a href="undocumented#Path_Effect">Path Effect</a> operates on the source <a href="SkPath_Reference#Path">Path</a>; the result @@ -2762,7 +2786,8 @@ true if the path represents <a href="#Style_Fill">Style Fill</a>, or false if it <a href="#Style_Stroke">Style Stroke</a> <a href="#Stroke_Width">Stroke Width</a> <a href="undocumented#Path_Effect">Path Effect</a> -# <a name="Shader_Methods"></a> Shader Methods +## <a name="Shader_Methods"></a> Shader Methods + <a href="undocumented#Shader">Shader</a> defines the colors used when drawing a shape. <a href="undocumented#Shader">Shader</a> may be an image, a gradient, or a computed fill. If <a href="#Paint">Paint</a> has no <a href="undocumented#Shader">Shader</a>, then <a href="undocumented#Color">Color</a> fills the shape. @@ -2868,7 +2893,8 @@ how geometry is filled with color; if nullptr, <a href="undocumented#Color">Colo --- -# <a name="Color_Filter_Methods"></a> Color Filter Methods +## <a name="Color_Filter_Methods"></a> Color Filter Methods + <a href="undocumented#Color_Filter">Color Filter</a> alters the color used when drawing a shape. <a href="undocumented#Color_Filter">Color Filter</a> may apply <a href="undocumented#Blend_Mode">Blend Mode</a>, transform the color through a matrix, or composite multiple filters. If <a href="#Paint">Paint</a> has no <a href="undocumented#Color_Filter">Color Filter</a>, the color is unaltered. @@ -2962,7 +2988,8 @@ Increments filter <a href="undocumented#Reference_Count">Reference Count</a> by --- -# <a name="Blend_Mode_Methods"></a> Blend Mode Methods +## <a name="Blend_Mode_Methods"></a> Blend Mode Methods + <a href="undocumented#Blend_Mode">Blend Mode</a> describes how <a href="undocumented#Color">Color</a> combines with the destination color. The default setting, <a href="#SkBlendMode_kSrcOver">SkBlendMode::kSrcOver</a>, draws the source color over the destination color. @@ -3064,7 +3091,8 @@ isSrcOver != true --- -# <a name="Path_Effect_Methods"></a> Path Effect Methods +## <a name="Path_Effect_Methods"></a> Path Effect Methods + <a href="undocumented#Path_Effect">Path Effect</a> modifies the path geometry before drawing it. <a href="undocumented#Path_Effect">Path Effect</a> may implement dashing, custom fill effects and custom stroke effects. If <a href="#Paint">Paint</a> has no <a href="undocumented#Path_Effect">Path Effect</a>, the path geometry is unaltered when filled or stroked. @@ -3160,7 +3188,8 @@ replace <a href="SkPath_Reference#Path">Path</a> with a modification when drawn< --- -# <a name="Mask_Filter_Methods"></a> Mask Filter Methods +## <a name="Mask_Filter_Methods"></a> Mask Filter Methods + <a href="undocumented#Mask_Filter">Mask Filter</a> uses coverage of the shape drawn to create <a href="undocumented#Mask_Alpha">Mask Alpha</a>. <a href="undocumented#Mask_Filter">Mask Filter</a> takes a <a href="undocumented#Mask">Mask</a>, and returns a <a href="undocumented#Mask">Mask</a>. @@ -3257,7 +3286,8 @@ modifies clipping mask generated from drawn geometry</td> --- -# <a name="Typeface_Methods"></a> Typeface Methods +## <a name="Typeface_Methods"></a> Typeface Methods + <a href="undocumented#Typeface">Typeface</a> identifies the font used when drawing and measuring text. <a href="undocumented#Typeface">Typeface</a> may be specified by name, from a file, or from a data stream. The default <a href="undocumented#Typeface">Typeface</a> defers to the platform-specific default font @@ -3348,7 +3378,8 @@ font and style used to draw text</td> --- -# <a name="Image_Filter_Methods"></a> Image Filter Methods +## <a name="Image_Filter_Methods"></a> Image Filter Methods + <a href="undocumented#Image_Filter">Image Filter</a> operates on the pixel representation of the shape, as modified by <a href="#Paint">Paint</a> with <a href="undocumented#Blend_Mode">Blend Mode</a> set to <a href="#SkBlendMode_kSrcOver">SkBlendMode::kSrcOver</a>. <a href="undocumented#Image_Filter">Image Filter</a> creates a new bitmap, which is drawn to the device using the set <a href="undocumented#Blend_Mode">Blend Mode</a>. @@ -3446,7 +3477,8 @@ how <a href="SkImage_Reference#Image">Image</a> is sampled when transformed</td> --- -# <a name="Draw_Looper_Methods"></a> Draw Looper Methods +## <a name="Draw_Looper_Methods"></a> Draw Looper Methods + <a href="undocumented#Draw_Looper">Draw Looper</a> sets a modifier that communicates state from one <a href="undocumented#Draw_Layer">Draw Layer</a> to another to construct the draw. @@ -3580,7 +3612,7 @@ sets <a href="undocumented#Draw_Looper">Draw Looper</a> to <a href="#SkPaint_set </table> -# <a name="Text_Align"></a> Text Align +## <a name="Text_Align"></a> Text Align ## <a name="SkPaint_Align"></a> Enum SkPaint::Align @@ -3701,7 +3733,8 @@ alignment out of range has no effect.</div></fiddle-embed></div> --- -# <a name="Text_Size"></a> Text Size +## <a name="Text_Size"></a> Text Size + <a href="#Text_Size">Text Size</a> adjusts the overall text size in points. <a href="#Text_Size">Text Size</a> can be set to any positive value or zero. <a href="#Text_Size">Text Size</a> defaults to 12. @@ -3753,7 +3786,8 @@ typographic height of text</td> --- -# <a name="Text_Scale_X"></a> Text Scale X +## <a name="Text_Scale_X"></a> Text Scale X + <a href="#Text_Scale_X">Text Scale X</a> adjusts the text horizontal scale. <a href="undocumented#Text">Text</a> scaling approximates condensed and expanded type faces when the actual face is not available. @@ -3807,7 +3841,8 @@ text horizontal scale</td> --- -# <a name="Text_Skew_X"></a> Text Skew X +## <a name="Text_Skew_X"></a> Text Skew X + <a href="#Text_Skew_X">Text Skew X</a> adjusts the text horizontal slant. <a href="undocumented#Text">Text</a> skewing approximates italic and oblique type faces when the actual face is not available. @@ -3861,7 +3896,7 @@ additional shear in x-axis relative to y-axis</td> --- -# <a name="Text_Encoding"></a> Text Encoding +## <a name="Text_Encoding"></a> Text Encoding ## <a name="SkPaint_TextEncoding"></a> Enum SkPaint::TextEncoding @@ -3981,7 +4016,8 @@ one of: <a href="#SkPaint_kUTF8_TextEncoding">kUTF8 TextEncoding</a>, <a href="# --- -# <a name="Font_Metrics"></a> Font Metrics +## <a name="Font_Metrics"></a> Font Metrics + <a href="#Font_Metrics">Font Metrics</a> describe dimensions common to the <a href="#Glyph">Glyphs</a> in <a href="undocumented#Typeface">Typeface</a>. The dimensions are computed by <a href="undocumented#Font_Manager">Font Manager</a> from font data and do not take <a href="#Paint">Paint</a> settings other than <a href="#Text_Size">Text Size</a> into account. @@ -4543,7 +4579,7 @@ storage for character codes, one per glyph</td> --- -# <a name="Measure_Text"></a> Measure Text +## <a name="Measure_Text"></a> Measure Text <a name="SkPaint_measureText"></a> ## measureText @@ -4709,7 +4745,8 @@ The underlines show the <a href="#SkPaint_getTextWidths_text">text</a> advance, --- -# <a name="Text_Path"></a> Text Path +## <a name="Text_Path"></a> Text Path + <a href="#Text_Path">Text Path</a> describes the geometry of <a href="#Glyph">Glyphs</a> used to draw text. <a name="SkPaint_getTextPath"></a> @@ -4780,7 +4817,8 @@ geometry of the <a href="#Glyph">Glyphs</a></td> --- -# <a name="Text_Intercepts"></a> Text Intercepts +## <a name="Text_Intercepts"></a> Text Intercepts + <a href="#Text_Intercepts">Text Intercepts</a> describe the intersection of drawn text <a href="#Glyph">Glyphs</a> with a pair of lines parallel to the text advance. <a href="#Text_Intercepts">Text Intercepts</a> permits creating a underline that skips Descenders. @@ -4992,7 +5030,8 @@ alpha 0 nothing to draw: true --- -# <a name="Fast_Bounds"></a> Fast Bounds +## <a name="Fast_Bounds"></a> Fast Bounds + <a href="#Fast_Bounds">Fast Bounds</a> methods conservatively outset a drawing bounds by additional area <a href="#Paint">Paint</a> may draw to. diff --git a/site/user/api/SkPath_Reference.md b/site/user/api/SkPath_Reference.md index da151c9a75..142ec36ae7 100644 --- a/site/user/api/SkPath_Reference.md +++ b/site/user/api/SkPath_Reference.md @@ -2,6 +2,19 @@ SkPath Reference === # <a name="Path"></a> Path + +## <a name="Overview"></a> Overview + +## <a name="Subtopics"></a> Subtopics + +| name | description | +| --- | --- | +| <a href="#Classes_and_Structs">Classes and Structs</a> | embedded struct and class members | +| <a href="#Constants">Constants</a> | enum and enum class, const values | +| <a href="#Constructors">Constructors</a> | functions that construct <a href="SkPath_Reference#SkPath">SkPath</a> | +| <a href="#Member_Functions">Member Functions</a> | static functions and member methods | +| <a href="#Operators">Operators</a> | operator overloading methods | +| <a href="#Related_Functions">Related Functions</a> | similar methods grouped together | <a href="#Path">Path</a> contains <a href="#Line">Lines</a> and <a href="#Curve">Curves</a> which can be stroked or filled. <a href="#Contour">Contour</a> is composed of a series of connected <a href="#Line">Lines</a> and <a href="#Curve">Curves</a>. <a href="#Path">Path</a> may contain zero, one, or more <a href="#Contour">Contours</a>. @@ -90,41 +103,28 @@ overlapping contours. Internally, <a href="#Path">Path</a> lazily computes metrics likes bounds and convexity. Call <a href="#SkPath_updateBoundsCache">SkPath::updateBoundsCache</a> to make <a href="#Path">Path</a> thread safe. -# <a name="Overview"></a> Overview - -## <a name="Subtopics"></a> Subtopics - -| name | description | -| --- | --- | -| <a href="#Overview_Classes_and_Structs">Classes and Structs</a> | embedded struct and class members | -| <a href="#Overview_Constants">Constants</a> | enum and enum class, const values | -| <a href="#Overview_Constructors">Constructors</a> | functions that construct <a href="#SkPath">SkPath</a> | -| <a href="#Overview_Member_Functions">Member Functions</a> | static functions and member methods | -| <a href="#Overview_Operators">Operators</a> | operator overloading methods | -| <a href="#Overview_Related_Functions">Related Functions</a> | similar methods grouped together | - ## <a name="Related_Functions"></a> Related Functions | name | description | -| --- | --- | +| --- | --- | +| <a href="#Arc">Arc</a> | part of <a href="undocumented#Oval">Oval</a> or <a href="undocumented#Circle">Circle</a> | | <a href="#Conic">Conic</a> | conic section defined by three points and a weight | -| <a href="#Conic_Weight">Conic Weight</a> | strength of control <a href="SkPoint_Reference#Point">Point</a> in <a href="#Conic">Conic</a> | -| <a href="#Contour">Contour</a> | loop of lines and curves | | <a href="#SkPath_Convexity">Convexity</a> | if <a href="#Path">Path</a> is concave or convex | -| <a href="#Cubic">Cubic Bezier</a> | third order curve defined by four points | +| <a href="#Cubic">Cubic</a> | Bezier_Curve described by third-order polynomial | | <a href="#SkPath_Direction">Direction</a> | <a href="#Path">Path</a> contour orientation | | <a href="#Fill_Type">Fill Type</a> | <a href="#Path">Path</a> fill rule, normal and inverted | +| <a href="#Generation_ID">Generation ID</a> | value reflecting contents change | | <a href="#Last_Point">Last Point</a> | final <a href="SkPoint_Reference#Point">Point</a> in <a href="#Contour">Contour</a> | | <a href="#Point_Array">Point Array</a> | end points and control points for lines and curves | -| <a href="#Quad">Quadratic Bezier</a> | parabolic section defined by three points | +| <a href="#Quad">Quad</a> | Bezier_Curve described by second-order polynomial | +| <a href="#SkPath_Verb">Verb</a> | line and curve type | | <a href="#Verb_Array">Verb Array</a> | line and curve type for points | -| <a href="#Verb">Verbs</a> | <a href="#Path">Path</a> line and curve type | -| <a href="SkPath_Reference#Zero_Length">Zero Length Contour</a> | consideration when contour has no length | +| Weight | strength of <a href="#Conic">Conic</a> control <a href="SkPoint_Reference#Point">Point</a> | ## <a name="Constants"></a> Constants | name | description | -| --- | --- | +| --- | --- | | <a href="#SkPath_AddPathMode">AddPathMode</a> | sets <a href="#SkPath_addPath">addPath</a> options | | <a href="#SkPath_ArcSize">ArcSize</a> | used by <a href="#SkPath_arcTo">arcTo</a> variation | | <a href="#SkPath_Convexity">Convexity</a> | returns if <a href="#Path">Path</a> is convex or concave | @@ -136,22 +136,22 @@ Internally, <a href="#Path">Path</a> lazily computes metrics likes bounds and co ## <a name="Classes_and_Structs"></a> Classes and Structs | name | description | -| --- | --- | -| <a href="#SkPath_Iter">Iter</a> | iterates through lines and curves, skipping degenerates | -| <a href="#SkPath_RawIter">RawIter</a> | iterates through lines and curves, including degenerates | +| --- | --- | +| <a href="#SkPath_Iter">Iter</a> | <a href="#Path">Path</a> data iterator | +| <a href="#SkPath_RawIter">RawIter</a> | <a href="#Path">Path</a> raw data iterator | ## <a name="Constructors"></a> Constructors | name | description | -| --- | --- | +| --- | --- | | <a href="#SkPath_empty_constructor">SkPath()</a> | constructs with default values | | <a href="#SkPath_copy_const_SkPath">SkPath(const SkPath& path)</a> | makes a shallow copy | -| | decreases <a href="undocumented#Reference_Count">Reference Count</a> of owned objects | +| <a href="#SkPath_destructor">~SkPath()</a> | decreases <a href="undocumented#Reference_Count">Reference Count</a> of owned objects | ## <a name="Operators"></a> Operators | name | description | -| --- | --- | +| --- | --- | | <a href="#SkPath_notequal_operator">operator!=(const SkPath& a, const SkPath& b)</a> | compares paths for inequality | | <a href="#SkPath_copy_operator">operator=(const SkPath& path)</a> | makes a shallow copy | | <a href="#SkPath_equal_operator">operator==(const SkPath& a, const SkPath& b)</a> | compares paths for equality | @@ -159,7 +159,7 @@ Internally, <a href="#Path">Path</a> lazily computes metrics likes bounds and co ## <a name="Member_Functions"></a> Member Functions | name | description | -| --- | --- | +| --- | --- | | <a href="#SkPath_ConvertConicToQuads">ConvertConicToQuads</a> | approximates <a href="#Conic">Conic</a> with <a href="#Quad">Quad</a> array | | <a href="#SkPath_ConvertToNonInverseFillType">ConvertToNonInverseFillType</a> | returns <a href="#Fill_Type">Fill Type</a> representing inside geometry | | <a href="#SkPath_IsCubicDegenerate">IsCubicDegenerate</a> | returns if <a href="#Cubic">Cubic</a> is very small | @@ -2633,7 +2633,8 @@ offset from <a href="#Last_Point">Last Point</a> x to <a href="#Cubic">Cubic</a> --- -# <a name="Arc"></a> Arc +## <a name="Arc"></a> Arc + <a href="#Arc">Arc</a> can be constructed in a number of ways. <a href="#Arc">Arc</a> may be described by part of <a href="undocumented#Oval">Oval</a> and angles, by start point and end point, and by radius and tangent lines. Each construction has advantages, and some constructions correspond to <a href="#Arc">Arc</a> drawing in graphics standards. diff --git a/site/user/api/SkPixmap_Reference.md b/site/user/api/SkPixmap_Reference.md index 8cd4d86aed..ed044b05c0 100644 --- a/site/user/api/SkPixmap_Reference.md +++ b/site/user/api/SkPixmap_Reference.md @@ -3,6 +3,16 @@ SkPixmap Reference # <a name="Pixmap"></a> Pixmap +## <a name="Overview"></a> Overview + +## <a name="Subtopics"></a> Subtopics + +| name | description | +| --- | --- | +| <a href="#Constructors">Constructors</a> | functions that construct <a href="SkPixmap_Reference#SkPixmap">SkPixmap</a> | +| <a href="#Member_Functions">Member Functions</a> | static functions and member methods | +| <a href="#Related_Functions">Related Functions</a> | similar methods grouped together | + # <a name="SkPixmap"></a> Class SkPixmap <a href="#Pixmap">Pixmap</a> provides a utility to pair <a href="SkImageInfo_Reference#SkImageInfo">SkImageInfo</a> with pixels and row bytes. <a href="#Pixmap">Pixmap</a> is a low level class which provides convenience functions to access @@ -15,20 +25,10 @@ pixels referenced by <a href="#Pixmap">Pixmap</a>. <a href="#Pixmap">Pixmap</a> does not try to manage the lifetime of the pixel memory. Use <a href="undocumented#Pixel_Ref">Pixel Ref</a> to manage pixel memory; <a href="undocumented#Pixel_Ref">Pixel Ref</a> is safe across threads. -# <a name="Overview"></a> Overview - -## <a name="Subtopics"></a> Subtopics - -| name | description | -| --- | --- | -| <a href="#Overview_Constructors">Constructors</a> | list of functions that construct <a href="SkPath_Reference#SkPath">SkPath</a> | -| <a href="#Overview_Member_Functions">Member Functions</a> | list of static functions and member methods | -| <a href="#Overview_Related_Functions">Related Functions</a> | similar methods grouped together | - ## <a name="Related_Functions"></a> Related Functions | name | description | -| --- | --- | +| --- | --- | | <a href="#Image_Info_Access">Image Info Access</a> | returns all or part of <a href="SkImageInfo_Reference#Image_Info">Image Info</a> | | <a href="#Initialization">Initialization</a> | sets fields for use | | <a href="#Readable_Address">Readable Address</a> | returns read only pixels | @@ -38,15 +38,15 @@ to manage pixel memory; <a href="undocumented#Pixel_Ref">Pixel Ref</a> is safe a ## <a name="Constructors"></a> Constructors -| | description | -| --- | --- | +| name | description | +| --- | --- | | <a href="#SkPixmap_empty_constructor">SkPixmap()</a> | constructs with default values | | <a href="#SkPixmap_const_SkImageInfo_const_star">SkPixmap(const SkImageInfo& info, const void* addr, size t rowBytes)</a> | constructs from <a href="SkImageInfo_Reference#Image_Info">Image Info</a>, pixels | ## <a name="Member_Functions"></a> Member Functions | name | description | -| --- | --- | +| --- | --- | | <a href="#SkPixmap_addr">addr</a> | returns readable pixel address as void pointer | | <a href="#SkPixmap_addr16">addr16</a> | returns readable pixel address as 16-bit pointer | | <a href="#SkPixmap_addr32">addr32</a> | returns readable pixel address as 32-bit pointer | diff --git a/site/user/api/SkPoint_Reference.md b/site/user/api/SkPoint_Reference.md index 7381e1bae8..6e831a0c20 100644 --- a/site/user/api/SkPoint_Reference.md +++ b/site/user/api/SkPoint_Reference.md @@ -3,64 +3,75 @@ SkPoint Reference # <a name="Point"></a> Point -# <a name="SkPoint"></a> Struct SkPoint - -# <a name="Overview"></a> Overview +## <a name="Overview"></a> Overview ## <a name="Subtopics"></a> Subtopics -| topics | description | -| --- | --- | +| name | description | +| --- | --- | +| <a href="#Constructors">Constructors</a> | functions that construct <a href="SkPoint_Reference#SkPoint">SkPoint</a> | +| <a href="#Member_Functions">Member Functions</a> | static functions and member methods | +| <a href="#Members">Members</a> | member values | +| <a href="#Operators">Operators</a> | operator overloading methods | + +# <a name="SkPoint"></a> Struct SkPoint ## <a name="Constructors"></a> Constructors | name | description | -| --- | --- | -| <a href="#SkPoint_Make">Make</a> | Constructs from <a href="undocumented#SkScalar">SkScalar</a> inputs. | +| --- | --- | +| <a href="#SkPoint_Make">Make</a> | constructs from <a href="undocumented#SkScalar">SkScalar</a> inputs | ## <a name="Operators"></a> Operators | name | description | -| --- | --- | -| <a href="#SkPoint">SkPoint</a> <a href="#SkPoint_multiply_operator">operator*(SkScalar scale) const</a> | Returns <a href="#Point">Point</a> multiplied by scale. | -| <a href="#SkPoint">SkPoint</a> <a href="#SkPoint_add_operator">operator+(const SkPoint& a, const SkVector& b)</a> | Returns <a href="#Point">Point</a> offset by <a href="SkPoint_Reference#Vector">Vector</a>. | -| <a href="#SkPoint">SkPoint</a> <a href="#SkPoint_minus_operator">operator-() const</a> | Reverses sign of <a href="#Point">Point</a>. | -| <a href="#SkPoint">SkPoint</a>& <a href="#SkPoint_multiplyby_operator">operator*=(SkScalar scale)</a> | Multiplies <a href="#Point">Point</a> by scale factor. | -| <a href="SkPoint_Reference#SkVector">SkVector</a> <a href="#SkPoint_subtract_operator">operator-(const SkPoint& a, const SkPoint& b)</a> | Returns <a href="SkPoint_Reference#Vector">Vector</a> between <a href="#Point">Points</a>. | -| bool <a href="#SkPoint_notequal_operator">operator!=(const SkPoint& a, const SkPoint& b)</a> | Returns true if <a href="#Point">Point</a> are unequal. | -| bool <a href="#SkPoint_equal_operator">operator==(const SkPoint& a, const SkPoint& b)</a> | Returns true if <a href="#Point">Point</a> are equal. | -| void <a href="#SkPoint_addto_operator">operator+=(const SkVector& v)</a> | Adds <a href="SkPoint_Reference#Vector">Vector</a> to <a href="#Point">Point</a>. | -| void <a href="#SkPoint_subtractfrom_operator">operator-=(const SkVector& v)</a> | Subtracts <a href="SkPoint_Reference#Vector">Vector</a> from <a href="#Point">Point</a>. | +| --- | --- | +| <a href="#SkPoint_notequal_operator">operator!=(const SkPoint& a, const SkPoint& b)</a> | returns true if <a href="#Point">Point</a> are unequal | +| <a href="#SkPoint_multiply_operator">operator*(SkScalar scale) const</a> | returns <a href="#Point">Point</a> multiplied by scale | +| <a href="#SkPoint_multiplyby_operator">operator*=(SkScalar scale)</a> | multiplies <a href="#Point">Point</a> by scale factor | +| <a href="#SkPoint_add_operator">operator+(const SkPoint& a, const SkVector& b)</a> | returns <a href="#Point">Point</a> offset by <a href="SkPoint_Reference#Vector">Vector</a> | +| <a href="#SkPoint_addto_operator">operator+=(const SkVector& v)</a> | adds <a href="SkPoint_Reference#Vector">Vector</a> to <a href="#Point">Point</a> | +| <a href="#SkPoint_minus_operator">operator-() const</a> | reverses sign of <a href="#Point">Point</a> | +| <a href="#SkPoint_subtract_operator">operator-(const SkPoint& a, const SkPoint& b)</a> | returns <a href="SkPoint_Reference#Vector">Vector</a> between <a href="#Point">Points</a> | +| <a href="#SkPoint_subtractfrom_operator">operator-=(const SkVector& v)</a> | subtracts <a href="SkPoint_Reference#Vector">Vector</a> from <a href="#Point">Point</a> | +| <a href="#SkPoint_equal_operator">operator==(const SkPoint& a, const SkPoint& b)</a> | returns true if <a href="#Point">Point</a> are equal | ## <a name="Member_Functions"></a> Member Functions | name | description | -| --- | --- | -| <a href="#SkPoint_CrossProduct">CrossProduct</a> | Returns cross product. | -| <a href="#SkPoint_Distance">Distance</a> | Returns straight-line distance between points. | -| <a href="#SkPoint_DotProduct">DotProduct</a> | Returns dot product. | -| <a href="#SkPoint_Length">Length</a> | Returns straight-line distance to origin. | -| <a href="#SkPoint_Make">Make</a> | Constructs from <a href="undocumented#SkScalar">SkScalar</a> inputs. | -| <a href="#SkPoint_Normalize">Normalize</a> | Sets length to one, and returns prior length. | -| <a href="#SkPoint_Offset">Offset</a> | Translates <a href="#Point">Point</a> array. | -| <a href="#SkPoint_cross">cross</a> | Returns cross product. | -| <a href="#SkPoint_distanceToOrigin">distanceToOrigin</a> | Returns straight-line distance to origin. | -| <a href="#SkPoint_dot">dot</a> | Returns dot product. | -| <a href="#SkPoint_equals">equals</a> | Returns true if <a href="#Point">Points</a> are equal. | -| <a href="#SkPoint_isFinite">isFinite</a> | Returns true if no member is infinite or NaN. | -| <a href="#SkPoint_isZero">isZero</a> | Returns true if both members equal zero. | -| <a href="#SkPoint_iset">iset</a> | Sets to integer input. | -| <a href="#SkPoint_length">length</a> | Returns straight-line distance to origin. | -| <a href="#SkPoint_negate">negate</a> | Reverses the sign of both members. | -| <a href="#SkPoint_normalize">normalize</a> | Sets length to one, preserving direction. | -| <a href="#SkPoint_offset">offset</a> | Translates <a href="#Point">Point</a>. | -| <a href="#SkPoint_scale">scale</a> | Multiplies <a href="#Point">Point</a> by scale factor. | -| <a href="#SkPoint_set">set</a> | Sets to <a href="undocumented#SkScalar">SkScalar</a> input. | -| <a href="#SkPoint_setAbs">setAbs</a> | Sets sign of both members to positive. | -| <a href="#SkPoint_setLength">setLength</a> | Sets straight-line distance to origin. | -| <a href="#SkPoint_setNormalize">setNormalize</a> | Sets length to one, in direction of (x, y). | -| <a href="#SkPoint_x">x</a> | Returns <a href="#SkPoint_fX">fX</a>. | -| <a href="#SkPoint_y">y</a> | Returns <a href="#SkPoint_fY">fY</a>. | +| --- | --- | +| <a href="#SkPoint_CrossProduct">CrossProduct</a> | returns cross product | +| <a href="#SkPoint_Distance">Distance</a> | returns straight-line distance between points | +| <a href="#SkPoint_DotProduct">DotProduct</a> | returns dot product | +| <a href="#SkPoint_Length">Length</a> | returns straight-line distance to origin | +| <a href="#SkPoint_Make">Make</a> | constructs from <a href="undocumented#SkScalar">SkScalar</a> inputs | +| <a href="#SkPoint_Normalize">Normalize</a> | sets length to one, and returns prior length | +| <a href="#SkPoint_Offset">Offset</a> | translates <a href="#Point">Point</a> array | +| <a href="#SkPoint_cross">cross</a> | returns cross product | +| <a href="#SkPoint_distanceToOrigin">distanceToOrigin</a> | returns straight-line distance to origin | +| <a href="#SkPoint_dot">dot</a> | returns dot product | +| <a href="#SkPoint_equals">equals</a> | returns true if <a href="#Point">Points</a> are equal | +| <a href="#SkPoint_isFinite">isFinite</a> | returns true if no member is infinite or NaN | +| <a href="#SkPoint_isZero">isZero</a> | returns true if both members equal zero | +| <a href="#SkPoint_iset">iset</a> | sets to integer input | +| <a href="#SkPoint_length">length</a> | returns straight-line distance to origin | +| <a href="#SkPoint_negate">negate</a> | reverses the sign of both members | +| <a href="#SkPoint_normalize">normalize</a> | sets length to one, preserving direction | +| <a href="#SkPoint_offset">offset</a> | translates <a href="#Point">Point</a> | +| <a href="#SkPoint_scale">scale</a> | multiplies <a href="#Point">Point</a> by scale factor | +| <a href="#SkPoint_set">set</a> | sets to <a href="undocumented#SkScalar">SkScalar</a> input | +| <a href="#SkPoint_setAbs">setAbs</a> | sets sign of both members to positive | +| <a href="#SkPoint_setLength">setLength</a> | sets straight-line distance to origin | +| <a href="#SkPoint_setNormalize">setNormalize</a> | sets length to one, in direction of (x, y) | +| <a href="#SkPoint_x">x</a> | returns <a href="#SkPoint_fX">fX</a> | +| <a href="#SkPoint_y">y</a> | returns <a href="#SkPoint_fY">fY</a> | + +## <a name="Members"></a> Members + +| name | description | +| --- | --- | +| <a href="#SkPoint_fX">fX</a> | x-axis value | +| <a href="#SkPoint_fY">fY</a> | y-axis value | <a name="SkPoint_fX"> <code><strong>SkScalar fX</strong></code> </a> diff --git a/site/user/api/SkRect_Reference.md b/site/user/api/SkRect_Reference.md index ac945edf14..d6aea67c64 100644 --- a/site/user/api/SkRect_Reference.md +++ b/site/user/api/SkRect_Reference.md @@ -3,12 +3,12 @@ SkRect Reference # <a name="Rect"></a> Rect -# <a name="Overview"></a> Overview +## <a name="Overview"></a> Overview ## <a name="Subtopics"></a> Subtopics | name | description | -| --- | --- | +| --- | --- | | <a href="#Constructors">Constructors</a> | functions that construct <a href="SkRect_Reference#SkRect">SkRect</a> | | <a href="#Member_Functions">Member Functions</a> | static functions and member methods | | <a href="#Members">Members</a> | member values | @@ -28,7 +28,7 @@ integer input cannot convert to <a href="undocumented#SkScalar">SkScalar</a> wit ## <a name="Related_Functions"></a> Related Functions | name | description | -| --- | --- | +| --- | --- | | <a href="#As_Points">As Points</a> | conversion to and from <a href="#Point">Points</a> | | <a href="#From_Integers">From Integers</a> | set <a href="#Scalar">Scalar</a> values from integer input | | <a href="#Inset_Outset_Offset">Inset Outset Offset</a> | moves sides | @@ -41,8 +41,8 @@ integer input cannot convert to <a href="undocumented#SkScalar">SkScalar</a> wit ## <a name="Member_Functions"></a> Member Functions -| description | function | -| --- | --- | +| name | description | +| --- | --- | | <a href="#SkRect_Intersects">Intersects</a> | returns true if areas overlap | | <a href="#SkRect_Make">Make</a> | constructs from <a href="undocumented#ISize">ISize</a> returning (0, 0, width, height) | | <a href="#SkRect_MakeEmpty">MakeEmpty</a> | constructs from bounds of (0, 0, 0, 0) | @@ -100,6 +100,13 @@ integer input cannot convert to <a href="undocumented#SkScalar">SkScalar</a> wit ## <a name="Members"></a> Members +| name | description | +| --- | --- | +| <a href="#SkRect_fBottom">fBottom</a> | larger y-axis bounds | +| <a href="#SkRect_fLeft">fLeft</a> | smaller x-axis bounds | +| <a href="#SkRect_fRight">fRight</a> | larger x-axis bounds | +| <a href="#SkRect_fTop">fTop</a> | smaller y-axis bounds | + <a name="SkRect_fLeft"> <code><strong>SkScalar fLeft</strong></code> </a> May contain any value, including infinities and NaN. The smaller of the diff --git a/site/user/api/SkSurface_Reference.md b/site/user/api/SkSurface_Reference.md index f8b141a20b..1195fd886b 100644 --- a/site/user/api/SkSurface_Reference.md +++ b/site/user/api/SkSurface_Reference.md @@ -3,6 +3,16 @@ SkSurface Reference # <a name="Surface"></a> Surface +## <a name="Overview"></a> Overview + +## <a name="Subtopics"></a> Subtopics + +| name | description | +| --- | --- | +| Constants | enum and enum class, const values | +| <a href="#Constructors">Constructors</a> | functions that construct <a href="SkSurface_Reference#SkSurface">SkSurface</a> | +| <a href="#Member_Functions">Member Functions</a> | static functions and member methods | + # <a name="SkSurface"></a> Class SkSurface <a href="#SkSurface">SkSurface</a> is responsible for managing the pixels that a canvas draws into. The pixels can be allocated either in CPU memory (a raster surface) or on the GPU (a <a href="undocumented#GrRenderTarget">GrRenderTarget</a> surface). @@ -11,19 +21,10 @@ surface-><a href="#SkSurface_getCanvas">getCanvas</a> to use that canvas (but do <a href="#SkSurface">SkSurface</a> always has non-zero dimensions. If there is a request for a new surface, and either of the requested dimensions are zero, then nullptr will be returned. -# <a name="Overview"></a> Overview - -## <a name="Subtopics"></a> Subtopics - -| topics | description | -| --- | --- | -| <a href="#Overview_Constructors">Constructors</a> | functions that construct <a href="SkIPoint16_Reference#SkIPoint16">SkIPoint16</a> | -| <a href="#Overview_Member_Functions">Member Functions</a> | static functions and member methods | - ## <a name="Constructors"></a> Constructors | name | description | -| --- | --- | +| --- | --- | | <a href="#SkSurface_MakeFromBackendRenderTarget">MakeFromBackendRenderTarget</a> | creates <a href="#Surface">Surface</a> from GPU memory buffer | | <a href="#SkSurface_MakeFromBackendTexture">MakeFromBackendTexture</a> | creates <a href="#Surface">Surface</a> from GPU-backed texture | | <a href="#SkSurface_MakeFromBackendTextureAsRenderTarget">MakeFromBackendTextureAsRenderTarget</a> | creates <a href="#Surface">Surface</a> from GPU-backed texture | @@ -33,13 +34,13 @@ of the requested dimensions are zero, then nullptr will be returned. | <a href="#SkSurface_MakeRasterDirectReleaseProc">MakeRasterDirectReleaseProc</a> | creates <a href="#Surface">Surface</a> from <a href="SkImageInfo_Reference#SkImageInfo">SkImageInfo</a> and <a href="#Storage">Pixel Storage</a> | | <a href="#SkSurface_MakeRasterN32Premul">MakeRasterN32Premul</a> | creates <a href="#Surface">Surface</a> from width, height matching output | | <a href="#SkSurface_MakeRenderTarget">MakeRenderTarget</a> | creates <a href="#Surface">Surface</a> pointing to new GPU memory buffer | -| <a href="#SkCanvas_makeSurface">SkCanvas::makeSurface</a> | creates <a href="#Surface">Surface</a> matching <a href="SkCanvas_Reference#Canvas">Canvas</a> <a href="SkImageInfo_Reference#Image_Info">Image Info</a>, <a href="#Properties">Surface Properties</a> | +| <a href="#SkSurface_makeImageSnapshot">makeImageSnapshot</a> | creates <a href="SkImage_Reference#Image">Image</a> capturing <a href="#Surface">Surface</a> contents | | <a href="#SkSurface_makeSurface">makeSurface</a> | creates a compatible <a href="#Surface">Surface</a> | ## <a name="Member_Functions"></a> Member Functions -| description | function | -| --- | --- | +| name | description | +| --- | --- | | <a href="#SkSurface_MakeFromBackendRenderTarget">MakeFromBackendRenderTarget</a> | creates <a href="#Surface">Surface</a> from GPU memory buffer | | <a href="#SkSurface_MakeFromBackendTexture">MakeFromBackendTexture</a> | creates <a href="#Surface">Surface</a> from GPU-backed texture | | <a href="#SkSurface_MakeFromBackendTextureAsRenderTarget">MakeFromBackendTextureAsRenderTarget</a> | creates <a href="#Surface">Surface</a> from GPU-backed texture | @@ -309,7 +310,7 @@ Allocates raster <a href="#Surface">Surface</a>. <a href="SkCanvas_Reference#Can Allocates and zeroes pixel memory. <a href="undocumented#Pixel">Pixel</a> memory size is height times width times four. <a href="undocumented#Pixel">Pixel</a> memory is deleted when <a href="#Surface">Surface</a> is deleted. -Internally, sets <a href="SkImageInfo_Reference#Image_Info">Image Info</a> to width, height, <a href="SkImageInfo_Reference#Native_Color_Type">Native Color Type</a>, and +Internally, sets <a href="SkImageInfo_Reference#Image_Info">Image Info</a> to width, height, <a href="SkImageInfo_Reference#Color_Type">Native Color Type</a>, and <a href="SkImageInfo_Reference#SkAlphaType">kPremul SkAlphaType</a>. <a href="#Surface">Surface</a> is returned if width and height are greater than zero. |