diff options
author | Cary Clark <caryclark@skia.org> | 2018-02-06 09:41:53 -0500 |
---|---|---|
committer | Skia Commit-Bot <skia-commit-bot@chromium.org> | 2018-02-06 15:20:25 +0000 |
commit | 4855f78dd16ad50003ec537c98062e24a831cd45 (patch) | |
tree | 9566730a4f8416078131a0dc8255aecdeb9e3bf3 /site | |
parent | 2aa5bab573cff2d9bfb40f7af6014a93bf2d4fda (diff) |
fix bookmaker nightly
- mark the interfaces that use SkMask as deprecated
- add more autogenerated subtopics
- make subtopic names singular, avoiding collision with Skia names
- simplify #Deprecated and #Bug tags
- add "#Deprecated soon" to note things to be deprecated
- fix some spelling errors
- refresh web docs
- add self-check functionality to find methods outside subtopics
TBR=caryclark@google.com
Docs-Preview: https://skia.org/?cl=102150
Bug: skia:6898
Change-Id: I0e742a56d49dccd4409bb68eed9167c8ad7611ce
Reviewed-on: https://skia-review.googlesource.com/102150
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 | 10 | ||||
-rw-r--r-- | site/user/api/SkBitmap_Reference.md | 66 | ||||
-rw-r--r-- | site/user/api/SkCanvas_Reference.md | 52 | ||||
-rw-r--r-- | site/user/api/SkIPoint16_Reference.md | 37 | ||||
-rw-r--r-- | site/user/api/SkIPoint_Reference.md | 62 | ||||
-rw-r--r-- | site/user/api/SkIRect_Reference.md | 91 | ||||
-rw-r--r-- | site/user/api/SkImageInfo_Reference.md | 39 | ||||
-rw-r--r-- | site/user/api/SkImage_Reference.md | 449 | ||||
-rw-r--r-- | site/user/api/SkMatrix_Reference.md | 137 | ||||
-rw-r--r-- | site/user/api/SkPaint_Reference.md | 62 | ||||
-rw-r--r-- | site/user/api/SkPath_Reference.md | 164 | ||||
-rw-r--r-- | site/user/api/SkPixmap_Reference.md | 49 | ||||
-rw-r--r-- | site/user/api/SkPoint_Reference.md | 109 | ||||
-rw-r--r-- | site/user/api/SkRect_Reference.md | 110 | ||||
-rw-r--r-- | site/user/api/SkSurface_Reference.md | 130 | ||||
-rw-r--r-- | site/user/api/catalog.htm | 47 | ||||
-rw-r--r-- | site/user/api/usingBookmaker.md | 11 |
17 files changed, 799 insertions, 826 deletions
diff --git a/site/user/api/SkAutoCanvasRestore_Reference.md b/site/user/api/SkAutoCanvasRestore_Reference.md index 901e763ed4..f3dce64a2e 100644 --- a/site/user/api/SkAutoCanvasRestore_Reference.md +++ b/site/user/api/SkAutoCanvasRestore_Reference.md @@ -5,24 +5,24 @@ SkAutoCanvasRestore Reference ## <a name="Overview"></a> Overview -## <a name="Subtopics"></a> Subtopics +## <a name="Subtopic"></a> Subtopic | name | description | | --- | --- | -| <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 href="SkAutoCanvasRestore_Reference#Automatic_Canvas_Restore_Constructor">Constructor</a> | functions that construct <a href="SkAutoCanvasRestore_Reference#SkAutoCanvasRestore">SkAutoCanvasRestore</a> | +| <a href="SkAutoCanvasRestore_Reference#Automatic_Canvas_Restore_Member_Function">Member Function</a> | static functions and member methods | # <a name="SkAutoCanvasRestore"></a> Class SkAutoCanvasRestore Stack helper class calls -## <a name="Constructors"></a> Constructors +## <a name="Constructor"></a> Constructor | name | description | | --- | --- | | <a href="#SkAutoCanvasRestore_SkCanvas_star">SkAutoCanvasRestore(SkCanvas* canvas, bool doSave)</a> | preserves <a href="SkCanvas_Reference#Canvas">Canvas</a> save count | | <a href="#SkAutoCanvasRestore_destructor">~SkAutoCanvasRestore()</a> | restores <a href="SkCanvas_Reference#Canvas">Canvas</a> to saved state | -## <a name="Member_Functions"></a> Member Functions +## <a name="Member_Function"></a> Member Function | name | description | | --- | --- | diff --git a/site/user/api/SkBitmap_Reference.md b/site/user/api/SkBitmap_Reference.md index 41d6378396..edef11b2ec 100644 --- a/site/user/api/SkBitmap_Reference.md +++ b/site/user/api/SkBitmap_Reference.md @@ -5,16 +5,16 @@ SkBitmap Reference ## <a name="Overview"></a> Overview -## <a name="Subtopics"></a> Subtopics +## <a name="Subtopic"></a> Subtopic | 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 href="#Class_or_Struct">Class or Struct</a> | embedded struct and class members | +| <a href="#Constant">Constant</a> | enum and enum class, const values | +| <a href="#Constructor">Constructor</a> | functions that construct <a href="SkBitmap_Reference#SkBitmap">SkBitmap</a> | +| <a href="#Member_Function">Member Function</a> | static functions and member methods | +| <a href="#Operator">Operator</a> | operator overloading methods | +| <a href="#Related_Function">Related Function</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 @@ -45,20 +45,26 @@ sometimes passing zero will compute the <a href="#Row_Bytes">Row Bytes</a> from 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="Related_Functions"></a> Related Functions +## <a name="Related_Function"></a> Related Function | name | description | | --- | --- | | <a href="#Row_Bytes">Row Bytes</a> | interval from one row to the next | -## <a name="Classes_and_Structs"></a> Classes and Structs +## <a name="Constant"></a> Constant + +| name | description | +| --- | --- | +| <a href="#SkBitmap_AllocFlags">AllocFlags</a> | zero pixel memory | + +## <a name="Class_or_Struct"></a> Class or Struct | name | description | | --- | --- | | <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 +## <a name="Constructor"></a> Constructor | name | description | | --- | --- | @@ -67,14 +73,14 @@ is useful to position one or more <a href="#Bitmap">Bitmaps</a> within a shared | <a href="#SkBitmap_copy_const_SkBitmap">SkBitmap(const SkBitmap& src)</a> | shares ownership of pixels | | <a href="#SkBitmap_destructor">~SkBitmap()</a> | releases ownership of pixels | -## <a name="Operators"></a> Operators +## <a name="Operator"></a> Operator | 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 +## <a name="Member_Function"></a> Member Function | name | description | | --- | --- | @@ -93,7 +99,6 @@ is useful to position one or more <a href="#Bitmap">Bitmaps</a> within a shared | <a href="#SkBitmap_empty">empty</a> | returns true if <a href="SkImageInfo_Reference#Image_Info">Image Info</a> has zero <a href="#SkBitmap_width">width</a> or <a href="#SkBitmap_height">height</a> | | <a href="#SkBitmap_erase">erase</a> | writes <a href="undocumented#Color">Color</a> to rectangle of pixels | | <a href="#SkBitmap_eraseARGB">eraseARGB</a> | writes <a href="undocumented#Color">Color</a> to pixels | -| <a href="#SkBitmap_eraseArea">eraseArea</a> | deprecated | | <a href="#SkBitmap_eraseColor">eraseColor</a> | writes <a href="undocumented#Color">Color</a> to pixels | | <a href="#SkBitmap_eraseRGB">eraseRGB</a> | deprecated | | <a href="#SkBitmap_extractAlpha">extractAlpha</a> | creates <a href="#Bitmap">Bitmap</a> containing <a href="#Alpha">Alpha</a> of pixels | @@ -107,10 +112,9 @@ is useful to position one or more <a href="#Bitmap">Bitmaps</a> within a shared | <a href="#SkBitmap_getGenerationID">getGenerationID</a> | returns unique ID | | <a href="#SkBitmap_getPixels">getPixels</a> | returns address of pixels | | <a href="#SkBitmap_getSubset">getSubset</a> | returns bounds offset by origin | -| <a href="#SkBitmap_hasHardwareMipMap">hasHardwareMipMap</a> | returns <a href="undocumented#Mip_Map">Mip Map</a> support present; Android only | +| <a href="#SkBitmap_hasHardwareMipMap">hasHardwareMipMap</a> | returns Mip_Map support present; Android only | | <a href="#SkBitmap_height">height</a> | returns pixel row count | | <a href="#SkBitmap_info">info</a> | returns <a href="SkImageInfo_Reference#Image_Info">Image Info</a> | -| <a href="#SkBitmap_installMaskPixels">installMaskPixels</a> | creates <a href="undocumented#Pixel_Ref">Pixel Ref</a> from <a href="undocumented#Mask">Mask</a> | | <a href="#SkBitmap_installPixels">installPixels</a> | creates <a href="undocumented#Pixel_Ref">Pixel Ref</a>, with optional release function | | <a href="#SkBitmap_isImmutable">isImmutable</a> | returns true if pixels will not change | | <a href="#SkBitmap_isNull">isNull</a> | returns true if <a href="undocumented#Pixel_Ref">Pixel Ref</a> is nullptr | @@ -128,7 +132,7 @@ is useful to position one or more <a href="#Bitmap">Bitmaps</a> within a shared | <a href="#SkBitmap_rowBytes">rowBytes</a> | returns interval between rows in bytes | | <a href="#SkBitmap_rowBytesAsPixels">rowBytesAsPixels</a> | returns interval between rows in pixels | | <a href="#SkBitmap_setAlphaType">setAlphaType</a> | sets <a href="SkImageInfo_Reference#Alpha_Type">Alpha Type</a> of shared pixels | -| <a href="#SkBitmap_setHasHardwareMipMap">setHasHardwareMipMap</a> | sets <a href="undocumented#Mip_Map">Mip Map</a> support present; Android only | +| <a href="#SkBitmap_setHasHardwareMipMap">setHasHardwareMipMap</a> | sets Mip_Map support present; Android only | | <a href="#SkBitmap_setImmutable">setImmutable</a> | marks that pixels will not change | | <a href="#SkBitmap_setInfo">setInfo</a> | sets height, width, <a href="SkImageInfo_Reference#Color_Type">Color Type</a>, and so on, releasing pixels | | <a href="#SkBitmap_setIsVolatile">setIsVolatile</a> | marks if pixels should not be cached | @@ -2086,33 +2090,7 @@ true if <a href="SkImageInfo_Reference#Image_Info">Image Info</a> was set to pix bool installMaskPixels(const SkMask& mask) </pre> -Sets <a href="SkImageInfo_Reference#Image_Info">Image Info</a> to <a href="#SkBitmap_installMaskPixels_mask">mask</a> width, <a href="#SkBitmap_installMaskPixels_mask">mask</a> height, <a href="SkImageInfo_Reference#SkColorType">kAlpha 8 SkColorType</a>, and -<a href="SkImageInfo_Reference#SkAlphaType">kPremul SkAlphaType</a>. Sets <a href="undocumented#Pixel_Ref">Pixel Ref</a> to <a href="#SkBitmap_installMaskPixels_mask">mask</a> image and <a href="#SkBitmap_installMaskPixels_mask">mask</a> <a href="#SkBitmap_rowBytes">rowBytes</a>. - -Returns false and calls <a href="#SkBitmap_reset">reset</a> if <a href="#SkBitmap_installMaskPixels_mask">mask</a> format is not <a href="#SkMask_kA8_Format">SkMask::kA8 Format</a>, -or if <a href="#SkBitmap_installMaskPixels_mask">mask</a> width or <a href="#SkBitmap_installMaskPixels_mask">mask</a> height is negative, or if <a href="#SkBitmap_installMaskPixels_mask">mask</a> <a href="#SkBitmap_rowBytes">rowBytes</a> is less -than <a href="#SkBitmap_installMaskPixels_mask">mask</a> width. - -Caller must ensure that <a href="#SkBitmap_installMaskPixels_mask">mask</a> is valid for the lifetime of <a href="#Bitmap">Bitmap</a> and <a href="undocumented#Pixel_Ref">Pixel Ref</a>. - -### Parameters - -<table> <tr> <td><a name="SkBitmap_installMaskPixels_mask"> <code><strong>mask </strong></code> </a></td> <td> -<a href="#Alpha">Alpha</a> 8-bit bitmap</td> - </tr> -</table> - -### Return Value - -true if <a href="SkImageInfo_Reference#Image_Info">Image Info</a> and <a href="undocumented#Pixel_Ref">Pixel Ref</a> refer to <a href="#SkBitmap_installMaskPixels_mask">mask</a> - -### Example - -<div><fiddle-embed name="b0456fc063ca467ccecf2105160a3d1d"><div>Draw a five by five bitmap, and draw it again with a center white pixel.</div></fiddle-embed></div> - -### See Also - -<a href="#SkBitmap_installPixels">installPixels</a><sup><a href="#SkBitmap_installPixels_2">[2]</a></sup><sup><a href="#SkBitmap_installPixels_3">[3]</a></sup> <a href="#SkBitmap_allocPixels">allocPixels</a><sup><a href="#SkBitmap_allocPixels_2">[2]</a></sup><sup><a href="#SkBitmap_allocPixels_3">[3]</a></sup><sup><a href="#SkBitmap_allocPixels_4">[4]</a></sup> +soon --- @@ -2581,8 +2559,6 @@ rectangle to fill</td> void eraseArea(const SkIRect& area, SkColor c) const </pre> -Legacy call to be deprecated. - --- <a name="SkBitmap_getColor"></a> diff --git a/site/user/api/SkCanvas_Reference.md b/site/user/api/SkCanvas_Reference.md index 2dd0073d2b..ebd746356f 100644 --- a/site/user/api/SkCanvas_Reference.md +++ b/site/user/api/SkCanvas_Reference.md @@ -5,15 +5,15 @@ SkCanvas Reference ## <a name="Overview"></a> Overview -## <a name="Subtopics"></a> Subtopics +## <a name="Subtopic"></a> Subtopic | 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 href="#Class_or_Struct">Class or Struct</a> | embedded struct and class members | +| <a href="#Constant">Constant</a> | enum and enum class, const values | +| <a href="#Constructor">Constructor</a> | functions that construct <a href="SkCanvas_Reference#SkCanvas">SkCanvas</a> | +| <a href="#Member_Function">Member Function</a> | static functions and member methods | +| <a href="#Related_Function">Related Function</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. @@ -37,7 +37,7 @@ 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="Related_Functions"></a> Related Functions +## <a name="Related_Function"></a> Related Function | name | description | | --- | --- | @@ -47,7 +47,7 @@ This approach may be deprecated in the future. | <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 +## <a name="Constant"></a> Constant | name | description | | --- | --- | @@ -56,16 +56,16 @@ This approach may be deprecated in the future. | <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 +## <a name="Class_or_Struct"></a> Class or Struct | name | description | | --- | --- | | <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 +## <a name="Constructor"></a> Constructor -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 +Create the desired type of <a href="SkSurface_Reference#Surface">Surface</a> to obtain its <a href="#Canvas">Canvas</a> when possible. 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 | @@ -73,7 +73,6 @@ when no <a href="SkSurface_Reference#Surface">Surface</a> is required, and some | <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 | -| <a href="#SkCanvas_copy_SkBaseDevice_star">SkCanvas(SkBaseDevice* device)</a> | to be deprecated | | <a href="#SkCanvas_copy_const_SkBitmap">SkCanvas(const SkBitmap& bitmap)</a> | uses existing <a href="SkBitmap_Reference#Bitmap">Bitmap</a> | | <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> | @@ -81,7 +80,7 @@ when no <a href="SkSurface_Reference#Surface">Surface</a> is required, and some | <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 +## <a name="Member_Function"></a> Member Function | name | description | | --- | --- | @@ -137,7 +136,6 @@ when no <a href="SkSurface_Reference#Surface">Surface</a> is required, and some | <a href="#SkCanvas_flush">flush</a> | triggers execution of all pending draw operations | | <a href="#SkCanvas_getBaseLayerSize">getBaseLayerSize</a> | returns size of base <a href="#Layer">Layer</a> in global coordinates | | <a href="#SkCanvas_getDeviceClipBounds">getDeviceClipBounds</a> | returns <a href="SkIRect_Reference#IRect">IRect</a> bounds of <a href="#Clip">Clip</a> | -| <a href="#SkCanvas_getDrawFilter">getDrawFilter</a> | legacy; to be deprecated | | <a href="#SkCanvas_getGrContext">getGrContext</a> | returns <a href="undocumented#GPU_Context">GPU Context</a> of the <a href="undocumented#GPU_Surface">GPU Surface</a> | | <a href="#SkCanvas_getLocalClipBounds">getLocalClipBounds</a> | returns <a href="#Clip">Clip</a> bounds in source coordinates | | <a href="#SkCanvas_getMetaData">getMetaData</a> | associates additional data with the canvas | @@ -161,7 +159,6 @@ when no <a href="SkSurface_Reference#Surface">Surface</a> is required, and some | <a href="#SkCanvas_saveLayerPreserveLCDTextRequests">saveLayerPreserveLCDTextRequests</a> | saves <a href="#Clip">Clip</a> and <a href="#Matrix">Matrix</a> on stack; creates <a href="#Layer">Layer</a> for LCD text | | <a href="#SkCanvas_scale">scale</a> | scales <a href="#Matrix">Matrix</a> | | <a href="#SkCanvas_setAllowSimplifyClip">setAllowSimplifyClip</a> | experimental | -| <a href="#SkCanvas_setDrawFilter">setDrawFilter</a> | legacy; to be deprecated | | <a href="#SkCanvas_setMatrix">setMatrix</a> | sets <a href="#Matrix">Matrix</a> | | <a href="#SkCanvas_skew">skew</a> | skews <a href="#Matrix">Matrix</a> | | <a href="#SkCanvas_translate">translate</a> | translates <a href="#Matrix">Matrix</a> | @@ -389,23 +386,7 @@ canvas is empty explicit SkCanvas(SkBaseDevice* device) </pre> -Construct a canvas that draws into <a href="#SkCanvas_copy_SkBaseDevice_star_device">device</a>. -Used by child classes of <a href="#SkCanvas">SkCanvas</a>. - -### Parameters - -<table> <tr> <td><a name="SkCanvas_copy_SkBaseDevice_star_device"> <code><strong>device </strong></code> </a></td> <td> -specifies a <a href="#SkCanvas_copy_SkBaseDevice_star_device">device</a> for the canvas to draw into</td> - </tr> -</table> - -### Return Value - -<a href="#Canvas">Canvas</a> that can be used to draw into <a href="#SkCanvas_copy_SkBaseDevice_star_device">device</a> - -### 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> +soon --- @@ -1697,8 +1678,7 @@ defining how <a href="#Layer">Layer</a> allocated by <a href="#SkCanvas_saveLaye <td><a name="SkCanvas_kInitWithPrevious_SaveLayerFlag"> <code><strong>SkCanvas::kInitWithPrevious_SaveLayerFlag </strong></code> </a></td><td>4</td><td>Initializes <a href="#Layer">Layer</a> with the contents of the previous <a href="#Layer">Layer</a>.</td> </tr> <tr> - <td><a name="SkCanvas_kDontClipToLayer_Legacy_SaveLayerFlag"> <code><strong>SkCanvas::kDontClipToLayer_Legacy_SaveLayerFlag </strong></code> </a></td><td>0x80000000</td><td>Only present on Android. -Skips setting a clip to the <a href="#Layer">Layer</a> bounds.</td> + <td><a name="SkCanvas_kDontClipToLayer_Legacy_SaveLayerFlag"> <code><strong>SkCanvas::kDontClipToLayer_Legacy_SaveLayerFlag </strong></code> </a></td><td>0x80000000</td><td>soon</td> </tr> </table> @@ -5731,7 +5711,7 @@ data holding <a href="#SkCanvas_drawAnnotation_2_value">value</a> stored in anno SkDrawFilter* getDrawFilter() const </pre> -Legacy call to be deprecated. +soon --- @@ -5742,7 +5722,7 @@ Legacy call to be deprecated. virtual SkDrawFilter* setDrawFilter(SkDrawFilter* filter) </pre> -Legacy call to be deprecated. +soon --- diff --git a/site/user/api/SkIPoint16_Reference.md b/site/user/api/SkIPoint16_Reference.md index 8d6e962beb..fdc2672d06 100644 --- a/site/user/api/SkIPoint16_Reference.md +++ b/site/user/api/SkIPoint16_Reference.md @@ -5,24 +5,26 @@ SkIPoint16 Reference ## <a name="Overview"></a> Overview -## <a name="Subtopics"></a> Subtopics +## <a name="Subtopic"></a> Subtopic | name | description | | --- | --- | -| <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 href="#Constructor">Constructor</a> | functions that construct <a href="SkIPoint16_Reference#SkIPoint16">SkIPoint16</a> | +| <a href="#Member_Function">Member Function</a> | static functions and member methods | +| <a href="#Member">Member</a> | member values | +| <a href="#Related_Function">Related Function</a> | similar methods grouped together | # <a name="SkIPoint16"></a> Struct SkIPoint16 <a href="#SkIPoint16">SkIPoint16</a> holds two 16 bit integer coordinates. -## <a name="Constructors"></a> Constructors +## <a name="Related_Function"></a> Related Function | name | description | | --- | --- | -| <a href="#SkIPoint16_Make">Make</a> | constructs from integer inputs | +| <a href="#Property">Property</a> | member values | +| <a href="#Set">Set</a> | replaces all values | -## <a name="Member_Functions"></a> Member Functions +## <a name="Member_Function"></a> Member Function | name | description | | --- | --- | @@ -31,7 +33,7 @@ SkIPoint16 Reference | <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 +## <a name="Member"></a> Member | name | description | | --- | --- | @@ -46,6 +48,12 @@ x-axis value used by <a href="#IPoint16">IPoint16</a> y-axis value used by <a href="#IPoint16">IPoint16</a> +## <a name="Constructor"></a> Constructor + +| name | description | +| --- | --- | +| <a href="#SkIPoint16_Make">Make</a> | constructs from integer inputs | + <a name="SkIPoint16_Make"></a> ## Make @@ -88,6 +96,13 @@ pt1.fY == pt2.fY --- +## <a name="Property"></a> Property + +| name | description | +| --- | --- | +| <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="SkIPoint16_x"></a> ## x @@ -150,6 +165,12 @@ pt1.fY == pt1.y() --- +## <a name="Set"></a> Set + +| name | description | +| --- | --- | +| <a href="#SkIPoint16_set">set</a> | sets to integer input | + <a name="SkIPoint16_set"></a> ## set diff --git a/site/user/api/SkIPoint_Reference.md b/site/user/api/SkIPoint_Reference.md index d43a9b8bc9..cae7fb38ca 100644 --- a/site/user/api/SkIPoint_Reference.md +++ b/site/user/api/SkIPoint_Reference.md @@ -5,37 +5,24 @@ SkIPoint Reference ## <a name="Overview"></a> Overview -## <a name="Subtopics"></a> Subtopics +## <a name="Subtopic"></a> Subtopic | name | description | | --- | --- | -| <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 href="#Constructor">Constructor</a> | functions that construct <a href="SkIPoint_Reference#SkIPoint">SkIPoint</a> | +| <a href="#Member_Function">Member Function</a> | static functions and member methods | +| <a href="#Member">Member</a> | member values | +| <a href="#Operator">Operator</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 +## <a name="Related_Function"></a> Related Function | 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_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 +## <a name="Member_Function"></a> Member Function | name | description | | --- | --- | @@ -46,7 +33,7 @@ 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 +## <a name="Member"></a> Member | name | description | | --- | --- | @@ -61,6 +48,12 @@ x-axis value used by <a href="#IPoint">IPoint</a>. y-axis value used by <a href="#IPoint">IPoint</a>. +## <a name="Constructor"></a> Constructor + +| name | description | +| --- | --- | +| <a href="#SkIPoint_Make">Make</a> | constructs from integer inputs | + <a name="SkIPoint_Make"></a> ## Make @@ -101,6 +94,14 @@ pt1 == pt2 --- +## <a name="Property"></a> Property + +| name | description | +| --- | --- | +| <a href="#SkIPoint_isZero">isZero</a> | returns true if both members equal zero | +| <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="SkIPoint_x"></a> ## x @@ -194,6 +195,12 @@ pt.isZero() == true --- +## <a name="Set"></a> Set + +| name | description | +| --- | --- | +| <a href="#SkIPoint_set">set</a> | sets to integer input | + <a name="SkIPoint_set"></a> ## set @@ -230,6 +237,19 @@ pt1 == pt2 --- +## <a name="Operator"></a> Operator + +| name | description | +| --- | --- | +| <a href="#SkIPoint_equals">equals</a> | returns true if members are equal | +| <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_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="SkIPoint_minus_operator"></a> ## operator- diff --git a/site/user/api/SkIRect_Reference.md b/site/user/api/SkIRect_Reference.md index 78129ec813..ec9a7249cd 100644 --- a/site/user/api/SkIRect_Reference.md +++ b/site/user/api/SkIRect_Reference.md @@ -5,15 +5,15 @@ SkIRect Reference ## <a name="Overview"></a> Overview -## <a name="Subtopics"></a> Subtopics +## <a name="Subtopic"></a> Subtopic | 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 | -| <a href="#Operators">Operators</a> | operator overloading methods | -| <a href="#Related_Functions">Related Functions</a> | similar methods grouped together | +| <a href="#Constructor">Constructor</a> | functions that construct <a href="SkIRect_Reference#SkIRect">SkIRect</a> | +| <a href="#Member_Function">Member Function</a> | static functions and member methods | +| <a href="#Member">Member</a> | member values | +| <a href="#Operator">Operator</a> | operator overloading methods | +| <a href="#Related_Function">Related Function</a> | similar methods grouped together | # <a name="SkIRect"></a> Struct SkIRect <a href="#SkIRect">SkIRect</a> holds four 32 bit integer coordinates describing the upper and @@ -22,19 +22,16 @@ from position, width, and height. <a href="#SkIRect">SkIRect</a> describes an ar is less than or equal to its left, or if its bottom is less than or equal to its top, it is considered empty. -## <a name="Related_Functions"></a> Related Functions +## <a name="Related_Function"></a> Related Function | name | description | -| --- | --- | +| --- | --- | | <a href="#Inset_Outset_Offset">Inset Outset Offset</a> | moves sides | | <a href="#Intersection">Intersection</a> | set to shared bounds | -| Join | set to union of bounds | -| Properties | side values, center, validity | -| Rounding | adjust to integer bounds | -| Set | replaces all values | -| Sorting | orders sides | +| <a href="#Join">Join</a> | set to union of bounds | +| <a href="#Sorting">Sorting</a> | orders sides | -## <a name="Member_Functions"></a> Member Functions +## <a name="Member_Function"></a> Member Function | name | description | | --- | --- | @@ -43,7 +40,6 @@ its top, it is considered empty. | <a href="#SkIRect_IntersectsNoEmptyCheck">IntersectsNoEmptyCheck</a> | returns true if areas overlap skips empty check | | <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 | | <a href="#SkIRect_MakeSize">MakeSize</a> | constructs from <a href="undocumented#ISize">ISize</a> returning (0, 0, width, height) | | <a href="#SkIRect_MakeWH">MakeWH</a> | constructs from int input returning (0, 0, width, height) | | <a href="#SkIRect_MakeXYWH">MakeXYWH</a> | constructs from int input returning (x, y, width, height) | @@ -83,7 +79,7 @@ its top, it is considered empty. | <a href="#SkIRect_x">x</a> | returns bounds left | | <a href="#SkIRect_y">y</a> | returns bounds top | -## <a name="Members"></a> Members +## <a name="Member"></a> Member | name | description | | --- | --- | @@ -112,13 +108,13 @@ When equal to or less than <a href="#SkIRect_fLeft">fLeft</a>, <a href="#IRect"> May contain any value. The larger of the vertical values when sorted. When equal to or less than <a href="#SkIRect_fTop">fTop</a>, <a href="#IRect">IRect</a> is empty. -## <a name="Constructors"></a> Constructors +## <a name="Constructor"></a> Constructor | name | description | | --- | --- | +| <a href="#SkIRect_EmptyIRect">EmptyIRect</a> | returns immutable bounds of (0, 0, 0, 0) | | <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 | | <a href="#SkIRect_MakeSize">MakeSize</a> | constructs from <a href="undocumented#ISize">ISize</a> returning (0, 0, width, height) | | <a href="#SkIRect_MakeWH">MakeWH</a> | constructs from int input returning (0, 0, width, height) | | <a href="#SkIRect_MakeXYWH">MakeXYWH</a> | constructs from int input returning (x, y, width, height) | @@ -339,6 +335,27 @@ rect: -10, 35, 5, 60 isEmpty: false --- +## <a name="Property"></a> Property + +| name | description | +| --- | --- | +| <a href="#SkIRect_bottom">bottom</a> | returns larger bounds in y, if sorted | +| <a href="#SkIRect_centerX">centerX</a> | returns midpoint in x | +| <a href="#SkIRect_centerY">centerY</a> | returns midpoint in y | +| <a href="#SkIRect_height">height</a> | returns span in y | +| <a href="#SkIRect_height64">height64</a> | returns span in y as int64_t | +| <a href="#SkIRect_is16Bit">is16Bit</a> | returns true if members fit in 16-bit word | +| <a href="#SkIRect_isEmpty">isEmpty</a> | returns true if width or height are zero or negative or they exceed int32_t | +| <a href="#SkIRect_isEmpty64">isEmpty64</a> | returns true if width or height are zero or negative | +| <a href="#SkIRect_left">left</a> | returns smaller bounds in x, if sorted | +| <a href="#SkIRect_right">right</a> | returns larger bounds in x, if sorted | +| <a href="#SkIRect_size">size</a> | returns <a href="undocumented#ISize">ISize</a> (width, height) | +| <a href="#SkIRect_top">top</a> | returns smaller bounds in y, if sorted | +| <a href="#SkIRect_width">width</a> | returns span in x | +| <a href="#SkIRect_width64">width64</a> | returns span in y as int64_t | +| <a href="#SkIRect_x">x</a> | returns bounds left | +| <a href="#SkIRect_y">y</a> | returns bounds top | + <a name="SkIRect_left"></a> ## left @@ -832,7 +849,7 @@ sorted: {20, 40, 20, 50} is empty --- -## <a name="Operators"></a> Operators +## <a name="Operator"></a> Operator | name | description | | --- | --- | @@ -1119,14 +1136,9 @@ rect: -10, 35, 5, 60 isEmpty: false ## <a name="Inset_Outset_Offset"></a> Inset Outset Offset | name | description | -| --- | --- | +| --- | --- | | <a href="#SkIRect_inset">inset</a> | moves the sides symmetrically about the center | -| <a href="#SkIRect_makeInset">makeInset</a> | constructs from sides moved symmetrically about the center | -| <a href="#SkIRect_makeOffset">makeOffset</a> | constructs from translated sides | -| <a href="#SkIRect_makeOutset">makeOutset</a> | constructs from sides moved symmetrically about the center | | <a href="#SkIRect_offset">offset</a> | translates sides without changing width and height | -| | void <a href="#SkIRect_offset">offset(int32 t dx, int32 t dy)</a> | -| | void <a href="#SkIRect_offset_2">offset(const SkIPoint& delta)</a> | | <a href="#SkIRect_offsetTo">offsetTo</a> | translates to (x, y) without changing width and height | | <a href="#SkIRect_outset">outset</a> | moves the sides symmetrically about the center | @@ -1480,17 +1492,12 @@ The intersection is only meaningful if the resulting <a href="#IRect">IRect</a> describes an area: <a href="#SkIRect_fLeft">fLeft</a> is less than <a href="#SkIRect_fRight">fRight</a>, and <a href="#SkIRect_fTop">fTop</a> is less than <a href="#SkIRect_fBottom">fBottom</a>. | name | description | -| --- | --- | +| --- | --- | | <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 | | <a href="#SkIRect_contains">contains</a> | returns true if points are equal or inside | -| | bool <a href="#SkIRect_contains">contains(int32 t x, int32 t y)</a> const | -| | bool <a href="#SkIRect_contains_2">contains(int32 t left, int32 t top, int32 t right, int32 t bottom)</a> const | -| | bool <a href="#SkIRect_contains_3">contains(const SkIRect& r)</a> const | +| <a href="#SkIRect_containsNoEmptyCheck">containsNoEmptyCheck</a> | returns true if points are equal or inside skips empty check | | <a href="#SkIRect_intersect">intersect</a> | sets to shared area; returns true if not empty | -| | bool <a href="#SkIRect_intersect">intersect(const SkIRect& r)</a> | -| | bool <a href="#SkIRect_intersect_2">intersect(const SkIRect& a, const SkIRect& b)</a> | -| | bool <a href="#SkIRect_intersect_3">intersect(int32 t left, int32 t top, int32 t right, int32 t bottom)</a> | | <a href="#SkIRect_intersectNoEmptyCheck">intersectNoEmptyCheck</a> | sets to shared area; returns true if not empty skips empty check | | <a href="#SkIRect_quickReject">quickReject</a> | returns true if rectangles do not intersect | @@ -2081,6 +2088,13 @@ intersection --- +## <a name="Join"></a> Join + +| name | description | +| --- | --- | +| <a href="#SkIRect_join">join</a> | sets to union of bounds | +| | join | + <a name="SkIRect_join"></a> ## join @@ -2162,6 +2176,12 @@ join: 10, 20, 55, 65 --- +## <a name="Sorting"></a> Sorting + +| name | description | +| --- | --- | +| <a href="#SkIRect_sort">sort</a> | orders sides from smaller to larger | + <a name="SkIRect_sort"></a> ## sort @@ -2264,12 +2284,5 @@ rect: 0, 0, 0, 0 static SkIRect SK_WARN_UNUSED_RESULT MakeLargest() </pre> -Returns constructed <a href="#SkIRect">SkIRect</a> setting left and top to most negative value, and -setting right and bottom to most positive value. - -### Return Value - -bounds (<a href="undocumented#SK_MinS32">SK MinS32</a>, <a href="undocumented#SK_MinS32">SK MinS32</a>, <a href="undocumented#SK_MaxS32">SK MaxS32</a>, <a href="undocumented#SK_MaxS32">SK MaxS32</a>) - --- diff --git a/site/user/api/SkImageInfo_Reference.md b/site/user/api/SkImageInfo_Reference.md index c947cb4223..0ad21b609a 100644 --- a/site/user/api/SkImageInfo_Reference.md +++ b/site/user/api/SkImageInfo_Reference.md @@ -5,15 +5,15 @@ SkImageInfo Reference ## <a name="Overview"></a> Overview -## <a name="Subtopics"></a> Subtopics +## <a name="Subtopic"></a> Subtopic | name | description | | --- | --- | -| <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 href="SkImageInfo_Reference#Image_Info_Constructor">Constructor</a> | functions that construct <a href="SkImageInfo_Reference#SkImageInfo">SkImageInfo</a> | +| <a href="SkImageInfo_Reference#Image_Info_Member_Function">Member Function</a> | static functions and member methods | +| <a href="SkImageInfo_Reference#Image_Info_Operator">Operator</a> | operator overloading methods | -## <a name="Constants"></a> Constants +## <a name="Constant"></a> Constant | name | description | | --- | --- | @@ -75,7 +75,10 @@ enum <a href="#SkColorType">SkColorType</a> { <a href="SkImageInfo_Reference#kRGB_565_SkColorType">kRGB 565 SkColorType</a>, <a href="SkImageInfo_Reference#kARGB_4444_SkColorType">kARGB 4444 SkColorType</a>, <a href="SkImageInfo_Reference#kRGBA_8888_SkColorType">kRGBA 8888 SkColorType</a>, +<a href="SkImageInfo_Reference#kRGB_888x_SkColorType">kRGB 888x SkColorType</a>, <a href="SkImageInfo_Reference#kBGRA_8888_SkColorType">kBGRA 8888 SkColorType</a>, +<a href="SkImageInfo_Reference#kRGBA_1010102_SkColorType">kRGBA 1010102 SkColorType</a>, +<a href="SkImageInfo_Reference#kRGB_101010x_SkColorType">kRGB 101010x SkColorType</a>, <a href="SkImageInfo_Reference#kGray_8_SkColorType">kGray 8 SkColorType</a>, <a href="SkImageInfo_Reference#kRGBA_F16_SkColorType">kRGBA F16 SkColorType</a>, kLastEnum_SkColorType = <a href="SkImageInfo_Reference#kRGBA_F16_SkColorType">kRGBA F16 SkColorType</a>, @@ -84,9 +87,11 @@ kLastEnum_SkColorType = <a href="SkImageInfo_Reference#kRGBA_F16_SkColorType">kR };</pre> Describes how to interpret the components of a pixel. -<a href="SkImageInfo_Reference#kN32_SkColorType">kN32 SkColorType</a> is an alias for whichever 32 bit <a href="#ARGB">Color ARGB</a> format is the "" -form for skia's blitters. Use this if you don't have a swizzle preference -for 32 bit pixels. + +<a href="SkImageInfo_Reference#kN32_SkColorType">kN32 SkColorType</a> selects the native 32-bit <a href="#ARGB">Color ARGB</a> format. On Little_Endian +processors, pixels containing 8-bit <a href="#ARGB">Color ARGB</a> components pack into 32-bit +<a href="SkImageInfo_Reference#kBGRA_8888_SkColorType">kBGRA 8888 SkColorType</a>. On Big_Endian processors, pixels pack into 32-bit +<a href="SkImageInfo_Reference#kRGBA_8888_SkColorType">kRGBA 8888 SkColorType</a>. ### Constants @@ -212,17 +217,17 @@ incomplete # <a name="SkImageInfo"></a> Struct SkImageInfo -Describe an image's dimensions and pixel type. -Used for both src images and render-targets (surfaces). +Describes <a href="SkImage_Reference#Image">Image</a> dimensions and pixel type. +Used for both source images and render-targets (surfaces). -## <a name="Operators"></a> Operators +## <a name="Operator"></a> Operator | name | description | | --- | --- | | <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 +## <a name="Member_Function"></a> Member Function | name | description | | --- | --- | @@ -261,7 +266,7 @@ Used for both src images and render-targets (surfaces). | <a href="#SkImageInfo_validate">validate</a> | incomplete | | <a href="#SkImageInfo_width">width</a> | incomplete | -## <a name="Constructors"></a> Constructors +## <a name="Constructor"></a> Constructor | name | description | | --- | --- | @@ -269,8 +274,10 @@ Used for both src images and render-targets (surfaces). | <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#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_MakeN32Premul">MakeN32Premul</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_MakeUnknown">MakeUnknown</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> | | <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> | @@ -342,7 +349,7 @@ incomplete static SkImageInfo MakeN32(int width, int height, SkAlphaType at, sk_sp<SkColorSpace> cs = nullptr) </pre> -Sets colortype to <a href="SkImageInfo_Reference#SkColorType">kN32 SkColorType</a>. +Sets <a href="SkImageInfo_Reference#Color_Type">Color Type</a> to <a href="SkImageInfo_Reference#SkColorType">kN32 SkColorType</a>. ### Parameters @@ -412,7 +419,7 @@ incomplete static SkImageInfo MakeN32Premul(int width, int height, sk_sp<SkColorSpace> cs = nullptr) </pre> -Sets colortype to <a href="SkImageInfo_Reference#SkColorType">kN32 SkColorType</a>, and the alphatype to premul. +Sets <a href="SkImageInfo_Reference#Color_Type">Color Type</a> to <a href="SkImageInfo_Reference#SkColorType">kN32 SkColorType</a>, and the <a href="SkImageInfo_Reference#Alpha_Type">Alpha Type</a> to <a href="SkImageInfo_Reference#SkAlphaType">kPremul SkAlphaType</a>. ### Parameters @@ -784,7 +791,7 @@ incomplete SkImageInfo makeWH(int newWidth, int newHeight) const </pre> -Creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with the same colortype and alphatype as this info, +Creates <a href="SkImageInfo_Reference#Image_Info">Image Info</a> with the same <a href="SkImageInfo_Reference#Color_Type">Color Type</a> and <a href="SkImageInfo_Reference#Alpha_Type">Alpha Type</a> as this info, but with the specified width and height. ### Parameters diff --git a/site/user/api/SkImage_Reference.md b/site/user/api/SkImage_Reference.md index 019f23c4be..bf5e0cabee 100644 --- a/site/user/api/SkImage_Reference.md +++ b/site/user/api/SkImage_Reference.md @@ -5,19 +5,19 @@ SkImage Reference ## <a name="Overview"></a> Overview -## <a name="Subtopics"></a> Subtopics +## <a name="Subtopic"></a> Subtopic | 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 href="#Class_or_Struct">Class or Struct</a> | embedded struct and class members | +| Constant | enum and enum class, const values | +| <a href="#Constructor">Constructor</a> | functions that construct <a href="SkImage_Reference#SkImage">SkImage</a> | +| <a href="#Member_Function">Member Function</a> | static functions and member methods | +| <a href="#Related_Function">Related Function</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, +decoded in a <a href="undocumented#Raster_Bitmap">Raster Bitmap</a>, encoded in a <a href="undocumented#Picture">Picture</a> or compressed data stream, or located in GPU memory as a <a href="undocumented#GPU_Texture">GPU Texture</a>. <a href="#Image">Image</a> cannot be modified after it is created. <a href="#Image">Image</a> may allocate additional @@ -28,12 +28,12 @@ or height returns <a href="#Image">Image</a> equal to nullptr. <a href="#Image">Image</a> may be created from <a href="SkBitmap_Reference#Bitmap">Bitmap</a>, <a href="SkPixmap_Reference#Pixmap">Pixmap</a>, <a href="SkSurface_Reference#Surface">Surface</a>, <a href="undocumented#Picture">Picture</a>, encoded streams, <a href="undocumented#GPU_Texture">GPU Texture</a>, <a href="undocumented#YUV_ColorSpace">YUV ColorSpace</a> data, or hardware buffer. Encoded streams supported -include BMP, GIF, HEIF, ICO, JPEG, PNG, WBMP, WebP. Supported encodings details +include BMP, GIF, HEIF, ICO, JPEG, PNG, WBMP, WebP. Supported encoding details vary with platform. ## <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 +<a href="SkImage_Reference#Raster_Image">Raster Image</a> pixels are decoded 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. @@ -50,98 +50,93 @@ performance. <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="Related_Functions"></a> Related Functions +## <a name="Related_Function"></a> Related Function | 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="SkImage_Reference#Raster_Image">Raster Image</a> | pixels decoded in <a href="undocumented#Raster_Bitmap">Raster Bitmap</a> | | <a href="#Texture_Image">Texture Image</a> | pixels located on GPU | -## <a name="Classes_and_Structs"></a> Classes and Structs +## <a name="Class_or_Struct"></a> Class or Struct | name | description | | --- | --- | -| <a href="#SkImage_DeferredTextureImageUsageParams">DeferredTextureImageUsageParams</a> | to be deprecated | -## <a name="Constructors"></a> Constructors +## <a name="Constructor"></a> Constructor | 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. | -| <a href="#SkImage_MakeFromAHardwareBuffer">MakeFromAHardwareBuffer</a> | Creates <a href="#Image">Image</a> from Android hardware buffer. | -| <a href="#SkImage_MakeFromAdoptedTexture">MakeFromAdoptedTexture</a> | Creates <a href="#Image">Image</a> from <a href="undocumented#GPU_Texture">GPU Texture</a>, managed internally. | -| <a href="#SkImage_MakeFromBitmap">MakeFromBitmap</a> | Creates <a href="#Image">Image</a> from <a href="SkBitmap_Reference#Bitmap">Bitmap</a>, sharing or copying pixels. | -| <a href="#SkImage_MakeFromDeferredTextureImageData">MakeFromDeferredTextureImageData</a> | To be deprecated. | -| <a href="#SkImage_MakeFromEncoded">MakeFromEncoded</a> | Creates <a href="#Image">Image</a> from encoded data. | -| <a href="#SkImage_MakeFromGenerator">MakeFromGenerator</a> | Creates <a href="#Image">Image</a> from a stream of data. | -| <a href="#SkImage_MakeFromNV12TexturesCopy">MakeFromNV12TexturesCopy</a> | Creates <a href="#Image">Image</a> from <a href="undocumented#YUV_ColorSpace">YUV ColorSpace</a> data in two planes. | -| <a href="#SkImage_MakeFromPicture">MakeFromPicture</a> | Creates <a href="#Image">Image</a> from <a href="undocumented#Picture">Picture</a>. | -| <a href="#SkImage_MakeFromRaster">MakeFromRaster</a> | Creates <a href="#Image">Image</a> from <a href="SkPixmap_Reference#Pixmap">Pixmap</a>, with release. | -| <a href="#SkImage_MakeFromTexture">MakeFromTexture</a> | Creates <a href="#Image">Image</a> from <a href="undocumented#GPU_Texture">GPU Texture</a>, managed externally. | -| <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="#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 +| <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 | +| <a href="#SkImage_MakeFromAHardwareBuffer">MakeFromAHardwareBuffer</a> | creates <a href="#Image">Image</a> from Android hardware buffer | +| <a href="#SkImage_MakeFromBitmap">MakeFromBitmap</a> | creates <a href="#Image">Image</a> from <a href="SkBitmap_Reference#Bitmap">Bitmap</a>, sharing or copying pixels | +| <a href="#SkImage_MakeFromEncoded">MakeFromEncoded</a> | creates <a href="#Image">Image</a> from encoded data | +| <a href="#SkImage_MakeFromGenerator">MakeFromGenerator</a> | creates <a href="#Image">Image</a> from a stream of data | +| <a href="#SkImage_MakeFromNV12TexturesCopy">MakeFromNV12TexturesCopy</a> | creates <a href="#Image">Image</a> from <a href="undocumented#YUV_ColorSpace">YUV ColorSpace</a> data in two planes | +| | <a href="#SkImage_MakeFromNV12TexturesCopy">MakeFromNV12TexturesCopy</a> | +| <a href="#SkImage_MakeFromPicture">MakeFromPicture</a> | creates <a href="#Image">Image</a> from <a href="undocumented#Picture">Picture</a> | +| <a href="#SkImage_MakeFromRaster">MakeFromRaster</a> | creates <a href="#Image">Image</a> from <a href="SkPixmap_Reference#Pixmap">Pixmap</a>, with release | +| <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_MakeFromYUVTexturesCopy">MakeFromYUVTexturesCopy</a> | +| <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="#SkImage_asLegacyBitmap">asLegacyBitmap</a> | returns as <a href="undocumented#Raster_Bitmap">Raster Bitmap</a> | +| <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_makeShader">makeShader</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_Function"></a> Member 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. | -| <a href="#SkImage_MakeFromAHardwareBuffer">MakeFromAHardwareBuffer</a> | Creates <a href="#Image">Image</a> from Android hardware buffer. | -| <a href="#SkImage_MakeFromAdoptedTexture">MakeFromAdoptedTexture</a> | Creates <a href="#Image">Image</a> from <a href="undocumented#GPU_Texture">GPU Texture</a>, managed internally. | -| <a href="#SkImage_MakeFromBitmap">MakeFromBitmap</a> | Creates <a href="#Image">Image</a> from <a href="SkBitmap_Reference#Bitmap">Bitmap</a>, sharing or copying pixels. | -| <a href="#SkImage_MakeFromDeferredTextureImageData">MakeFromDeferredTextureImageData</a> | To be deprecated. | -| <a href="#SkImage_MakeFromEncoded">MakeFromEncoded</a> | Creates <a href="#Image">Image</a> from encoded data. | -| <a href="#SkImage_MakeFromGenerator">MakeFromGenerator</a> | Creates <a href="#Image">Image</a> from a stream of data. | -| <a href="#SkImage_MakeFromNV12TexturesCopy">MakeFromNV12TexturesCopy</a> | Creates <a href="#Image">Image</a> from <a href="undocumented#YUV_ColorSpace">YUV ColorSpace</a> data in two planes. | -| <a href="#SkImage_MakeFromPicture">MakeFromPicture</a> | Creates <a href="#Image">Image</a> from <a href="undocumented#Picture">Picture</a>. | -| <a href="#SkImage_MakeFromRaster">MakeFromRaster</a> | Creates <a href="#Image">Image</a> from <a href="SkPixmap_Reference#Pixmap">Pixmap</a>, with release. | -| <a href="#SkImage_MakeFromTexture">MakeFromTexture</a> | Creates <a href="#Image">Image</a> from <a href="undocumented#GPU_Texture">GPU Texture</a>, managed externally. | -| <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="#SkImage_alphaType">alphaType</a> | Returns <a href="SkImageInfo_Reference#Alpha_Type">Alpha Type</a>. | -| <a href="#SkImage_asLegacyBitmap">asLegacyBitmap</a> | Returns as <a href="undocumented#Raster_Bitmap">Raster Bitmap</a>. | -| <a href="#SkImage_bounds">bounds</a> | Returns <a href="#SkImage_width">width</a> and <a href="#SkImage_height">height</a> as Rectangle. | -| <a href="#SkImage_colorSpace">colorSpace</a> | Returns <a href="undocumented#Color_Space">Color Space</a>. | -| <a href="#SkImage_dimensions">dimensions</a> | Returns <a href="#SkImage_width">width</a> and <a href="#SkImage_height">height</a>. | -| <a href="#SkImage_encodeToData">encodeToData</a> | Returns encoded <a href="#Image">Image</a> as <a href="undocumented#SkData">SkData</a>. | -| <a href="#SkImage_getDeferredTextureImageData">getDeferredTextureImageData</a> | To be deprecated. | -| <a href="#SkImage_getTexture">getTexture</a> | Deprecated. | -| <a href="#SkImage_getTextureHandle">getTextureHandle</a> | Returns GPU reference to <a href="#Image">Image</a> as texture. | -| <a href="#SkImage_height">height</a> | Returns pixel row count. | -| <a href="#SkImage_isAlphaOnly">isAlphaOnly</a> | Returns if pixels represent a transparency mask. | -| <a href="#SkImage_isLazyGenerated">isLazyGenerated</a> | Returns if <a href="#Image">Image</a> is created as needed. | -| <a href="#SkImage_isOpaque">isOpaque</a> | Returns if <a href="SkImageInfo_Reference#Alpha_Type">Alpha Type</a> is <a href="SkImageInfo_Reference#SkAlphaType">kOpaque SkAlphaType</a>. | -| <a href="#SkImage_isTextureBacked">isTextureBacked</a> | Returns if <a href="#Image">Image</a> was created from <a href="undocumented#GPU_Texture">GPU Texture</a>. | -| <a href="#SkImage_isValid">isValid</a> | Returns if <a href="#Image">Image</a> can draw to <a href="undocumented#Raster_Surface">Raster Surface</a> or <a href="undocumented#GPU_Context">GPU Context</a>. | -| <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 href="#SkImage_peekPixels">peekPixels</a> | Returns <a href="SkPixmap_Reference#Pixmap">Pixmap</a> if possible. | -| <a href="#SkImage_readPixels">readPixels</a> | Copies and converts pixels. | -| <a href="#SkImage_refColorSpace">refColorSpace</a> | Returns <a href="#Info">Image Info</a> <a href="undocumented#Color_Space">Color Space</a>. | -| <a href="#SkImage_refEncodedData">refEncodedData</a> | Returns <a href="#Image">Image</a> encoded in <a href="undocumented#SkData">SkData</a> if present. | -| <a href="#SkImage_scalePixels">scalePixels</a> | Scales and converts one <a href="#Image">Image</a> to another. | -| <a href="#SkImage_toString">toString</a> | Converts <a href="#Image">Image</a> to machine readable form. | -| <a href="#SkImage_uniqueID">uniqueID</a> | Identifier for <a href="#Image">Image</a>. | -| <a href="#SkImage_width">width</a> | Returns pixel column count. | +| <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 | +| <a href="#SkImage_MakeFromAHardwareBuffer">MakeFromAHardwareBuffer</a> | creates <a href="#Image">Image</a> from Android hardware buffer | +| <a href="#SkImage_MakeFromBitmap">MakeFromBitmap</a> | creates <a href="#Image">Image</a> from <a href="SkBitmap_Reference#Bitmap">Bitmap</a>, sharing or copying pixels | +| <a href="#SkImage_MakeFromEncoded">MakeFromEncoded</a> | creates <a href="#Image">Image</a> from encoded data | +| <a href="#SkImage_MakeFromGenerator">MakeFromGenerator</a> | creates <a href="#Image">Image</a> from a stream of data | +| <a href="#SkImage_MakeFromNV12TexturesCopy">MakeFromNV12TexturesCopy</a> | creates <a href="#Image">Image</a> from <a href="undocumented#YUV_ColorSpace">YUV ColorSpace</a> data in two planes | +| <a href="#SkImage_MakeFromPicture">MakeFromPicture</a> | creates <a href="#Image">Image</a> from <a href="undocumented#Picture">Picture</a> | +| <a href="#SkImage_MakeFromRaster">MakeFromRaster</a> | creates <a href="#Image">Image</a> from <a href="SkPixmap_Reference#Pixmap">Pixmap</a>, with release | +| <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="#SkImage_alphaType">alphaType</a> | returns <a href="SkImageInfo_Reference#Alpha_Type">Alpha Type</a> | +| <a href="#SkImage_asLegacyBitmap">asLegacyBitmap</a> | returns as <a href="undocumented#Raster_Bitmap">Raster Bitmap</a> | +| <a href="#SkImage_bounds">bounds</a> | returns <a href="#SkImage_width">width</a> and <a href="#SkImage_height">height</a> as Rectangle | +| <a href="#SkImage_colorSpace">colorSpace</a> | returns <a href="undocumented#Color_Space">Color Space</a> | +| <a href="#SkImage_dimensions">dimensions</a> | returns <a href="#SkImage_width">width</a> and <a href="#SkImage_height">height</a> | +| <a href="#SkImage_encodeToData">encodeToData</a> | returns encoded <a href="#Image">Image</a> as <a href="undocumented#SkData">SkData</a> | +| <a href="#SkImage_getTextureHandle">getTextureHandle</a> | returns GPU reference to <a href="#Image">Image</a> as texture | +| <a href="#SkImage_height">height</a> | returns pixel row count | +| <a href="#SkImage_isAlphaOnly">isAlphaOnly</a> | returns if pixels represent a transparency mask | +| <a href="#SkImage_isLazyGenerated">isLazyGenerated</a> | returns if <a href="#Image">Image</a> is created as needed | +| <a href="#SkImage_isOpaque">isOpaque</a> | returns if <a href="SkImageInfo_Reference#Alpha_Type">Alpha Type</a> is <a href="SkImageInfo_Reference#SkAlphaType">kOpaque SkAlphaType</a> | +| <a href="#SkImage_isTextureBacked">isTextureBacked</a> | returns if <a href="#Image">Image</a> was created from <a href="undocumented#GPU_Texture">GPU Texture</a> | +| <a href="#SkImage_isValid">isValid</a> | returns if <a href="#Image">Image</a> can draw to <a href="undocumented#Raster_Surface">Raster Surface</a> or <a href="undocumented#GPU_Context">GPU Context</a> | +| <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 href="#SkImage_peekPixels">peekPixels</a> | returns <a href="SkPixmap_Reference#Pixmap">Pixmap</a> if possible | +| <a href="#SkImage_readPixels">readPixels</a> | copies and converts pixels | +| <a href="#SkImage_refColorSpace">refColorSpace</a> | returns <a href="#Info">Image Info</a> <a href="undocumented#Color_Space">Color Space</a> | +| <a href="#SkImage_refEncodedData">refEncodedData</a> | returns <a href="#Image">Image</a> encoded in <a href="undocumented#SkData">SkData</a> if present | +| <a href="#SkImage_scalePixels">scalePixels</a> | scales and converts one <a href="#Image">Image</a> to another | +| <a href="#SkImage_toString">toString</a> | converts <a href="#Image">Image</a> to machine readable form | +| <a href="#SkImage_uniqueID">uniqueID</a> | identifier for <a href="#Image">Image</a> | +| <a href="#SkImage_width">width</a> | returns pixel column count | <a name="SkImage_MakeRasterCopy"></a> ## MakeRasterCopy @@ -390,7 +385,7 @@ Creates <a href="#Image">Image</a> from <a href="#SkImage_MakeFromEncoded_encode otherwise, <a href="#SkImage_MakeFromEncoded_subset">subset</a> must be contained by image bounds. <a href="#Image">Image</a> is returned if format of the <a href="#SkImage_MakeFromEncoded_encoded">encoded</a> data is recognized and supported. -Recognized formats vary by platfrom. +Recognized formats vary by platform. ### Parameters @@ -424,28 +419,6 @@ static sk_sp<SkImage> MakeFromTexture(GrContext* context, const GrBackendT sk_sp<SkColorSpace> colorSpace) </pre> -Deprecated. - -### Parameters - -<table> <tr> <td><a name="SkImage_MakeFromTexture_context"> <code><strong>context </strong></code> </a></td> <td> -<a href="undocumented#GPU_Context">GPU Context</a></td> - </tr> <tr> <td><a name="SkImage_MakeFromTexture_backendTexture"> <code><strong>backendTexture </strong></code> </a></td> <td> -texture residing on GPU</td> - </tr> <tr> <td><a name="SkImage_MakeFromTexture_origin"> <code><strong>origin </strong></code> </a></td> <td> -one of: <a href="undocumented#GrSurfaceOrigin">kBottomLeft GrSurfaceOrigin</a>, <a href="undocumented#GrSurfaceOrigin">kTopLeft GrSurfaceOrigin</a></td> - </tr> <tr> <td><a name="SkImage_MakeFromTexture_alphaType"> <code><strong>alphaType </strong></code> </a></td> <td> -one of: <a href="SkImageInfo_Reference#SkAlphaType">kUnknown SkAlphaType</a>, <a href="SkImageInfo_Reference#SkAlphaType">kOpaque SkAlphaType</a>, -<a href="SkImageInfo_Reference#SkAlphaType">kPremul SkAlphaType</a>, <a href="SkImageInfo_Reference#SkAlphaType">kUnpremul SkAlphaType</a></td> - </tr> <tr> <td><a name="SkImage_MakeFromTexture_colorSpace"> <code><strong>colorSpace </strong></code> </a></td> <td> -range of colors; may be nullptr</td> - </tr> -</table> - -### Return Value - -created <a href="#Image">Image</a>, or nullptr - --- <a name="SkImage_MakeFromTexture_2"></a> @@ -458,32 +431,6 @@ static sk_sp<SkImage> MakeFromTexture(GrContext* context, const GrBackendT ReleaseContext releaseContext) </pre> -Deprecated. - -### Parameters - -<table> <tr> <td><a name="SkImage_MakeFromTexture_2_context"> <code><strong>context </strong></code> </a></td> <td> -<a href="undocumented#GPU_Context">GPU Context</a></td> - </tr> <tr> <td><a name="SkImage_MakeFromTexture_2_backendTexture"> <code><strong>backendTexture </strong></code> </a></td> <td> -texture residing on GPU</td> - </tr> <tr> <td><a name="SkImage_MakeFromTexture_2_origin"> <code><strong>origin </strong></code> </a></td> <td> -one of: <a href="undocumented#GrSurfaceOrigin">kBottomLeft GrSurfaceOrigin</a>, <a href="undocumented#GrSurfaceOrigin">kTopLeft GrSurfaceOrigin</a></td> - </tr> <tr> <td><a name="SkImage_MakeFromTexture_2_alphaType"> <code><strong>alphaType </strong></code> </a></td> <td> -one of: <a href="SkImageInfo_Reference#SkAlphaType">kUnknown SkAlphaType</a>, <a href="SkImageInfo_Reference#SkAlphaType">kOpaque SkAlphaType</a>, -<a href="SkImageInfo_Reference#SkAlphaType">kPremul SkAlphaType</a>, <a href="SkImageInfo_Reference#SkAlphaType">kUnpremul SkAlphaType</a></td> - </tr> <tr> <td><a name="SkImage_MakeFromTexture_2_colorSpace"> <code><strong>colorSpace </strong></code> </a></td> <td> -range of colors; may be nullptr</td> - </tr> <tr> <td><a name="SkImage_MakeFromTexture_2_textureReleaseProc"> <code><strong>textureReleaseProc </strong></code> </a></td> <td> -function called when texture can be released</td> - </tr> <tr> <td><a name="SkImage_MakeFromTexture_2_releaseContext"> <code><strong>releaseContext </strong></code> </a></td> <td> -state passed to <a href="#SkImage_MakeFromTexture_2_textureReleaseProc">textureReleaseProc</a></td> - </tr> -</table> - -### Return Value - -created <a href="#Image">Image</a>, or nullptr - --- <a name="SkImage_MakeFromTexture_3"></a> @@ -624,7 +571,7 @@ moving resources between contexts. </tr> <tr> <td><a name="SkImage_MakeCrossContextFromEncoded_data"> <code><strong>data </strong></code> </a></td> <td> <a href="#Image">Image</a> to decode</td> </tr> <tr> <td><a name="SkImage_MakeCrossContextFromEncoded_buildMips"> <code><strong>buildMips </strong></code> </a></td> <td> -create <a href="#Image">Image</a> as <a href="undocumented#Mip_Map">Mip Map</a> if true</td> +create <a href="#Image">Image</a> as Mip_Map if true</td> </tr> <tr> <td><a name="SkImage_MakeCrossContextFromEncoded_dstColorSpace"> <code><strong>dstColorSpace </strong></code> </a></td> <td> range of colors of matching <a href="SkSurface_Reference#Surface">Surface</a> on GPU</td> </tr> @@ -677,7 +624,7 @@ Recognized GPU formats vary by platform and GPU back-end. </tr> <tr> <td><a name="SkImage_MakeCrossContextFromPixmap_pixmap"> <code><strong>pixmap </strong></code> </a></td> <td> <a href="#Info">Image Info</a>, pixel address, and row bytes</td> </tr> <tr> <td><a name="SkImage_MakeCrossContextFromPixmap_buildMips"> <code><strong>buildMips </strong></code> </a></td> <td> -create <a href="#Image">Image</a> as <a href="undocumented#Mip_Map">Mip Map</a> if true</td> +create <a href="#Image">Image</a> as Mip_Map if true</td> </tr> <tr> <td><a name="SkImage_MakeCrossContextFromPixmap_dstColorSpace"> <code><strong>dstColorSpace </strong></code> </a></td> <td> range of colors of matching <a href="SkSurface_Reference#Surface">Surface</a> on GPU</td> </tr> @@ -708,32 +655,6 @@ static sk_sp<SkImage> MakeFromAdoptedTexture(GrContext* context, sk_sp<SkColorSpace> colorSpace = nullptr) </pre> -Deprecated. - -### Parameters - -<table> <tr> <td><a name="SkImage_MakeFromAdoptedTexture_context"> <code><strong>context </strong></code> </a></td> <td> -<a href="undocumented#GPU_Context">GPU Context</a></td> - </tr> <tr> <td><a name="SkImage_MakeFromAdoptedTexture_backendTexture"> <code><strong>backendTexture </strong></code> </a></td> <td> -texture residing on GPU</td> - </tr> <tr> <td><a name="SkImage_MakeFromAdoptedTexture_surfaceOrigin"> <code><strong>surfaceOrigin </strong></code> </a></td> <td> -one of: <a href="undocumented#GrSurfaceOrigin">kBottomLeft GrSurfaceOrigin</a>, <a href="undocumented#GrSurfaceOrigin">kTopLeft GrSurfaceOrigin</a></td> - </tr> <tr> <td><a name="SkImage_MakeFromAdoptedTexture_alphaType"> <code><strong>alphaType </strong></code> </a></td> <td> -one of: <a href="SkImageInfo_Reference#SkAlphaType">kUnknown SkAlphaType</a>, <a href="SkImageInfo_Reference#SkAlphaType">kOpaque SkAlphaType</a>, -<a href="SkImageInfo_Reference#SkAlphaType">kPremul SkAlphaType</a>, <a href="SkImageInfo_Reference#SkAlphaType">kUnpremul SkAlphaType</a></td> - </tr> <tr> <td><a name="SkImage_MakeFromAdoptedTexture_colorSpace"> <code><strong>colorSpace </strong></code> </a></td> <td> -range of colors; may be nullptr</td> - </tr> -</table> - -### Return Value - -created <a href="#Image">Image</a>, or nullptr - -### See Also - -<a href="#SkImage_MakeFromTexture">MakeFromTexture</a><sup><a href="#SkImage_MakeFromTexture_2">[2]</a></sup><sup><a href="#SkImage_MakeFromTexture_3">[3]</a></sup><sup><a href="#SkImage_MakeFromTexture_4">[4]</a></sup> <a href="#SkImage_MakeFromYUVTexturesCopy">MakeFromYUVTexturesCopy</a><sup><a href="#SkImage_MakeFromYUVTexturesCopy_2">[2]</a></sup> - --- <a name="SkImage_MakeFromAdoptedTexture_2"></a> @@ -800,7 +721,7 @@ static sk_sp<SkImage> MakeFromYUVTexturesCopy(GrContext* context, SkYUVCol Creates <a href="#Image">Image</a> from copy of <a href="#SkImage_MakeFromYUVTexturesCopy_yuvTextureHandles">yuvTextureHandles</a>, an array of textures on GPU. <a href="#SkImage_MakeFromYUVTexturesCopy_yuvTextureHandles">yuvTextureHandles</a> contain pixels for YUV planes of <a href="#Image">Image</a>. -<a href="#SkImage_MakeFromYUVTexturesCopy_yuvSizes">yuvSizes</a> conain dimensions for each pixel plane. Dimensions must be greater than +<a href="#SkImage_MakeFromYUVTexturesCopy_yuvSizes">yuvSizes</a> contain dimensions for each pixel plane. Dimensions must be greater than zero but may differ from plane to plane. Returned <a href="#Image">Image</a> has the dimensions <a href="#SkImage_MakeFromYUVTexturesCopy_yuvSizes">yuvSizes</a>[0]. <a href="#SkImage_MakeFromYUVTexturesCopy_yuvColorSpace">yuvColorSpace</a> describes how YUV colors convert to RGB colors. @@ -809,8 +730,8 @@ zero but may differ from plane to plane. Returned <a href="#Image">Image</a> has <table> <tr> <td><a name="SkImage_MakeFromYUVTexturesCopy_context"> <code><strong>context </strong></code> </a></td> <td> <a href="undocumented#GPU_Context">GPU Context</a></td> </tr> <tr> <td><a name="SkImage_MakeFromYUVTexturesCopy_yuvColorSpace"> <code><strong>yuvColorSpace </strong></code> </a></td> <td> -one of: <a href="undocumented#YUV_ColorSpace">kJPEG SkYUVColorSpace</a>, <a href="undocumented#YUV_ColorSpace">kRec601 SkYUVColorSpace</a>, -<a href="undocumented#YUV_ColorSpace">kRec709 SkYUVColorSpace</a></td> +one of: <a href="SkImageInfo_Reference#SkYUVColorSpace">kJPEG SkYUVColorSpace</a>, <a href="SkImageInfo_Reference#SkYUVColorSpace">kRec601 SkYUVColorSpace</a>, +<a href="SkImageInfo_Reference#SkYUVColorSpace">kRec709 SkYUVColorSpace</a></td> </tr> <tr> <td><a name="SkImage_MakeFromYUVTexturesCopy_yuvTextureHandles"> <code><strong>yuvTextureHandles </strong></code> </a></td> <td> array of YUV textures on GPU</td> </tr> <tr> <td><a name="SkImage_MakeFromYUVTexturesCopy_yuvSizes"> <code><strong>yuvSizes </strong></code> </a></td> <td> @@ -844,7 +765,7 @@ static sk_sp<SkImage> MakeFromYUVTexturesCopy(GrContext* context, SkYUVCol Creates <a href="#Image">Image</a> from copy of <a href="#SkImage_MakeFromYUVTexturesCopy_2_yuvTextureHandles">yuvTextureHandles</a>, an array of textures on GPU. <a href="#SkImage_MakeFromYUVTexturesCopy_2_yuvTextureHandles">yuvTextureHandles</a> contain pixels for YUV planes of <a href="#Image">Image</a>. -<a href="#SkImage_MakeFromYUVTexturesCopy_2_yuvSizes">yuvSizes</a> conain dimensions for each pixel plane. Dimensions must be greater than +<a href="#SkImage_MakeFromYUVTexturesCopy_2_yuvSizes">yuvSizes</a> contain dimensions for each pixel plane. Dimensions must be greater than zero but may differ from plane to plane. Returned <a href="#Image">Image</a> has the dimensions <a href="#SkImage_MakeFromYUVTexturesCopy_2_yuvSizes">yuvSizes</a>[0]. <a href="#SkImage_MakeFromYUVTexturesCopy_2_yuvColorSpace">yuvColorSpace</a> describes how YUV colors convert to RGB colors. @@ -853,8 +774,8 @@ zero but may differ from plane to plane. Returned <a href="#Image">Image</a> has <table> <tr> <td><a name="SkImage_MakeFromYUVTexturesCopy_2_context"> <code><strong>context </strong></code> </a></td> <td> <a href="undocumented#GPU_Context">GPU Context</a></td> </tr> <tr> <td><a name="SkImage_MakeFromYUVTexturesCopy_2_yuvColorSpace"> <code><strong>yuvColorSpace </strong></code> </a></td> <td> -one of: <a href="undocumented#YUV_ColorSpace">kJPEG SkYUVColorSpace</a>, <a href="undocumented#YUV_ColorSpace">kRec601 SkYUVColorSpace</a>, -<a href="undocumented#YUV_ColorSpace">kRec709 SkYUVColorSpace</a></td> +one of: <a href="SkImageInfo_Reference#SkYUVColorSpace">kJPEG SkYUVColorSpace</a>, <a href="SkImageInfo_Reference#SkYUVColorSpace">kRec601 SkYUVColorSpace</a>, +<a href="SkImageInfo_Reference#SkYUVColorSpace">kRec709 SkYUVColorSpace</a></td> </tr> <tr> <td><a name="SkImage_MakeFromYUVTexturesCopy_2_yuvTextureHandles"> <code><strong>yuvTextureHandles </strong></code> </a></td> <td> array of YUV textures on GPU</td> </tr> <tr> <td><a name="SkImage_MakeFromYUVTexturesCopy_2_yuvSizes"> <code><strong>yuvSizes </strong></code> </a></td> <td> @@ -891,7 +812,7 @@ Creates <a href="#Image">Image</a> from copy of <a href="#SkImage_MakeFromNV12Te <a href="#SkImage_MakeFromNV12TexturesCopy_nv12TextureHandles">nv12TextureHandles</a>[0] contains pixels for YUV_Component_Y plane. <a href="#SkImage_MakeFromNV12TexturesCopy_nv12TextureHandles">nv12TextureHandles</a>[1] contains pixels for YUV_Component_U plane, followed by pixels for YUV_Component_V plane. -<a href="#SkImage_MakeFromNV12TexturesCopy_nv12Sizes">nv12Sizes</a> conain dimensions for each pixel plane. Dimensions must be greater than +<a href="#SkImage_MakeFromNV12TexturesCopy_nv12Sizes">nv12Sizes</a> contain dimensions for each pixel plane. Dimensions must be greater than zero but may differ from plane to plane. Returned <a href="#Image">Image</a> has the dimensions <a href="#SkImage_MakeFromNV12TexturesCopy_nv12Sizes">nv12Sizes</a>[0]. <a href="#SkImage_MakeFromNV12TexturesCopy_yuvColorSpace">yuvColorSpace</a> describes how YUV colors convert to RGB colors. @@ -900,8 +821,8 @@ zero but may differ from plane to plane. Returned <a href="#Image">Image</a> has <table> <tr> <td><a name="SkImage_MakeFromNV12TexturesCopy_context"> <code><strong>context </strong></code> </a></td> <td> <a href="undocumented#GPU_Context">GPU Context</a></td> </tr> <tr> <td><a name="SkImage_MakeFromNV12TexturesCopy_yuvColorSpace"> <code><strong>yuvColorSpace </strong></code> </a></td> <td> -one of: <a href="undocumented#YUV_ColorSpace">kJPEG SkYUVColorSpace</a>, <a href="undocumented#YUV_ColorSpace">kRec601 SkYUVColorSpace</a>, -<a href="undocumented#YUV_ColorSpace">kRec709 SkYUVColorSpace</a></td> +one of: <a href="SkImageInfo_Reference#SkYUVColorSpace">kJPEG SkYUVColorSpace</a>, <a href="SkImageInfo_Reference#SkYUVColorSpace">kRec601 SkYUVColorSpace</a>, +<a href="SkImageInfo_Reference#SkYUVColorSpace">kRec709 SkYUVColorSpace</a></td> </tr> <tr> <td><a name="SkImage_MakeFromNV12TexturesCopy_nv12TextureHandles"> <code><strong>nv12TextureHandles </strong></code> </a></td> <td> array of YUV textures on GPU</td> </tr> <tr> <td><a name="SkImage_MakeFromNV12TexturesCopy_nv12Sizes"> <code><strong>nv12Sizes </strong></code> </a></td> <td> @@ -937,7 +858,7 @@ Creates <a href="#Image">Image</a> from copy of <a href="#SkImage_MakeFromNV12Te <a href="#SkImage_MakeFromNV12TexturesCopy_2_nv12TextureHandles">nv12TextureHandles</a>[0] contains pixels for YUV_Component_Y plane. <a href="#SkImage_MakeFromNV12TexturesCopy_2_nv12TextureHandles">nv12TextureHandles</a>[1] contains pixels for YUV_Component_U plane, followed by pixels for YUV_Component_V plane. -<a href="#SkImage_MakeFromNV12TexturesCopy_2_nv12Sizes">nv12Sizes</a> conain dimensions for each pixel plane. Dimensions must be greater than +<a href="#SkImage_MakeFromNV12TexturesCopy_2_nv12Sizes">nv12Sizes</a> contain dimensions for each pixel plane. Dimensions must be greater than zero but may differ from plane to plane. Returned <a href="#Image">Image</a> has the dimensions <a href="#SkImage_MakeFromNV12TexturesCopy_2_nv12Sizes">nv12Sizes</a>[0]. <a href="#SkImage_MakeFromNV12TexturesCopy_2_yuvColorSpace">yuvColorSpace</a> describes how YUV colors convert to RGB colors. @@ -946,8 +867,8 @@ zero but may differ from plane to plane. Returned <a href="#Image">Image</a> has <table> <tr> <td><a name="SkImage_MakeFromNV12TexturesCopy_2_context"> <code><strong>context </strong></code> </a></td> <td> <a href="undocumented#GPU_Context">GPU Context</a></td> </tr> <tr> <td><a name="SkImage_MakeFromNV12TexturesCopy_2_yuvColorSpace"> <code><strong>yuvColorSpace </strong></code> </a></td> <td> -one of: <a href="undocumented#YUV_ColorSpace">kJPEG SkYUVColorSpace</a>, <a href="undocumented#YUV_ColorSpace">kRec601 SkYUVColorSpace</a>, -<a href="undocumented#YUV_ColorSpace">kRec709 SkYUVColorSpace</a></td> +one of: <a href="SkImageInfo_Reference#SkYUVColorSpace">kJPEG SkYUVColorSpace</a>, <a href="SkImageInfo_Reference#SkYUVColorSpace">kRec601 SkYUVColorSpace</a>, +<a href="SkImageInfo_Reference#SkYUVColorSpace">kRec709 SkYUVColorSpace</a></td> </tr> <tr> <td><a name="SkImage_MakeFromNV12TexturesCopy_2_nv12TextureHandles"> <code><strong>nv12TextureHandles </strong></code> </a></td> <td> array of YUV textures on GPU</td> </tr> <tr> <td><a name="SkImage_MakeFromNV12TexturesCopy_2_nv12Sizes"> <code><strong>nv12Sizes </strong></code> </a></td> <td> @@ -1076,6 +997,24 @@ created <a href="#Image">Image</a>, or nullptr --- +## <a name="Property"></a> Property + +| name | description | +| --- | --- | +| <a href="#SkImage_alphaType">alphaType</a> | returns <a href="SkImageInfo_Reference#Alpha_Type">Alpha Type</a> | +| <a href="#SkImage_bounds">bounds</a> | returns <a href="#SkImage_width">width</a> and <a href="#SkImage_height">height</a> as Rectangle | +| <a href="#SkImage_colorSpace">colorSpace</a> | returns <a href="undocumented#Color_Space">Color Space</a> | +| <a href="#SkImage_dimensions">dimensions</a> | returns <a href="#SkImage_width">width</a> and <a href="#SkImage_height">height</a> | +| <a href="#SkImage_height">height</a> | returns pixel row count | +| <a href="#SkImage_isAlphaOnly">isAlphaOnly</a> | returns if pixels represent a transparency mask | +| <a href="#SkImage_isLazyGenerated">isLazyGenerated</a> | returns if <a href="#Image">Image</a> is created as needed | +| <a href="#SkImage_isOpaque">isOpaque</a> | returns if <a href="SkImageInfo_Reference#Alpha_Type">Alpha Type</a> is <a href="SkImageInfo_Reference#SkAlphaType">kOpaque SkAlphaType</a> | +| <a href="#SkImage_isTextureBacked">isTextureBacked</a> | returns if <a href="#Image">Image</a> was created from <a href="undocumented#GPU_Texture">GPU Texture</a> | +| <a href="#SkImage_isValid">isValid</a> | returns if <a href="#Image">Image</a> can draw to <a href="undocumented#Raster_Surface">Raster Surface</a> or <a href="undocumented#GPU_Context">GPU Context</a> | +| <a href="#SkImage_refColorSpace">refColorSpace</a> | returns <a href="#Info">Image Info</a> <a href="undocumented#Color_Space">Color Space</a> | +| <a href="#SkImage_uniqueID">uniqueID</a> | identifier for <a href="#Image">Image</a> | +| <a href="#SkImage_width">width</a> | returns pixel column count | + <a name="SkImage_width"></a> ## width @@ -1471,8 +1410,6 @@ true if <a href="#Image">Image</a> has direct access to pixels GrTexture* getTexture() const </pre> -Deprecated. - --- <a name="SkImage_isTextureBacked"></a> @@ -1895,6 +1832,12 @@ encoded <a href="#Image">Image</a>, or nullptr --- +## <a name="Utility"></a> Utility + +| name | description | +| --- | --- | +| <a href="#SkImage_toString">toString</a> | converts <a href="#Image">Image</a> to machine readable form | + <a name="SkImage_toString"></a> ## toString @@ -2005,7 +1948,7 @@ sk_sp<SkImage> makeNonTextureImage() const </pre> Returns <a href="SkImage_Reference#Raster_Image">Raster Image</a> or <a href="#Lazy_Image">Lazy Image</a>. Copies <a href="#Image">Image</a> backed by <a href="undocumented#GPU_Texture">GPU Texture</a> into -CPU memory if needed. Returns original <a href="#Image">Image</a> if unencoded in <a href="undocumented#Raster_Bitmap">Raster Bitmap</a>, +CPU memory if needed. Returns original <a href="#Image">Image</a> if decoded in <a href="undocumented#Raster_Bitmap">Raster Bitmap</a>, or if encoded in a stream. Returns nullptr if backed by <a href="undocumented#GPU_Texture">GPU Texture</a> and copy fails. @@ -2032,7 +1975,7 @@ sk_sp<SkImage> makeRasterImage() const </pre> Returns <a href="SkImage_Reference#Raster_Image">Raster Image</a>. Copies <a href="#Image">Image</a> backed by <a href="undocumented#GPU_Texture">GPU Texture</a> into CPU memory, -or decodes <a href="#Image">Image</a> from <a href="#Lazy_Image">Lazy Image</a>. Returns original <a href="#Image">Image</a> if unencoded in +or decodes <a href="#Image">Image</a> from <a href="#Lazy_Image">Lazy Image</a>. Returns original <a href="#Image">Image</a> if decoded in <a href="undocumented#Raster_Bitmap">Raster Bitmap</a>. Returns nullptr if copy, decode, or pixel read fails. @@ -2107,63 +2050,7 @@ By translating canvas by returned <a href="#SkImage_makeWithFilter_offset">offse --- # <a name="SkImage_DeferredTextureImageUsageParams"></a> Struct SkImage::DeferredTextureImageUsageParams -Used only by Chrome; to be deprecated. - -<pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> -struct <a href="#SkImage_DeferredTextureImageUsageParams_DeferredTextureImageUsageParams">DeferredTextureImageUsageParams</a> { -<a href="#SkImage_DeferredTextureImageUsageParams_DeferredTextureImageUsageParams">DeferredTextureImageUsageParams(const SkMatrix matrix, const SkFilterQuality quality, -int preScaleMipLevel)</a>; -<a href="SkMatrix_Reference#SkMatrix">SkMatrix</a> <a href="#SkImage_DeferredTextureImageUsageParams_fMatrix">fMatrix</a>; -<a href="undocumented#SkFilterQuality">SkFilterQuality</a> <a href="#SkImage_DeferredTextureImageUsageParams_fQuality">fQuality</a>; -int <a href="#SkImage_DeferredTextureImageUsageParams_fPreScaleMipLevel">fPreScaleMipLevel</a>; -};</pre> - -<a name="SkImage_DeferredTextureImageUsageParams_fMatrix"> <code><strong>SkMatrix fMatrix</strong></code> </a> - -<a name="SkImage_DeferredTextureImageUsageParams_fQuality"> <code><strong>SkFilterQuality fQuality</strong></code> </a> - -<a name="SkImage_DeferredTextureImageUsageParams_fPreScaleMipLevel"> <code><strong>int fPreScaleMipLevel</strong></code> </a> - -<a name="SkImage_DeferredTextureImageUsageParams_DeferredTextureImageUsageParams"></a> -## DeferredTextureImageUsageParams - -<pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> -DeferredTextureImageUsageParams(const SkMatrix matrix, const SkFilterQuality quality, - int preScaleMipLevel) -</pre> - -### Parameters - -<table> <tr> <td><a name="SkImage_DeferredTextureImageUsageParams_DeferredTextureImageUsageParams_matrix"> <code><strong>matrix </strong></code> </a></td> <td> -incomplete</td> - </tr> <tr> <td><a name="SkImage_DeferredTextureImageUsageParams_DeferredTextureImageUsageParams_quality"> <code><strong>quality </strong></code> </a></td> <td> -incomplete</td> - </tr> <tr> <td><a name="SkImage_DeferredTextureImageUsageParams_DeferredTextureImageUsageParams_preScaleMipLevel"> <code><strong>preScaleMipLevel </strong></code> </a></td> <td> -incomplete</td> - </tr> -</table> - -### Return Value - -incomplete - -### Example - -<div><fiddle-embed name="882e8e0103048009a25cfc20400492f7"></fiddle-embed></div> - -### See Also - -incomplete - ---- - -### Example - -<div><fiddle-embed name="882e8e0103048009a25cfc20400492f7"></fiddle-embed></div> - -### See Also - -incomplete +soonUsed only by Chrome. <a name="SkImage_getDeferredTextureImageData"></a> ## getDeferredTextureImageData @@ -2175,64 +2062,7 @@ size_t getDeferredTextureImageData(const GrContextThreadSafeProxy& contextThread SkColorType dstColorType = kN32_SkColorType) const </pre> -Used only by Chrome; to be deprecated. - -This method allows clients to capture the data necessary to turn a <a href="#SkImage">SkImage</a> into a texture- -backed image. If the original image is codec-backed this will decode into a format optimized -for the context represented by the proxy. This method is thread safe with respect to the -<a href="undocumented#GrContext">GrContext</a> whence the proxy came. Clients allocate and manage the storage of the deferred -texture data and control its lifetime. No cleanup is required, thus it is safe to simply free -the memory out from under the data. - -The same method is used both for getting the size necessary for pre-uploaded texture data -and for retrieving the data. The params array represents the set of draws over which to -optimize the pre-upload data. - -When called with a null <a href="#SkImage_getDeferredTextureImageData_buffer">buffer</a> this returns the size that the client must allocate in order -to create deferred texture data for this image (or zero if this is an inappropriate -candidate). The <a href="#SkImage_getDeferredTextureImageData_buffer">buffer</a> allocated by the client should be 8 byte aligned. - -When <a href="#SkImage_getDeferredTextureImageData_buffer">buffer</a> is not null this fills in the deferred texture data for this image in the -provided <a href="#SkImage_getDeferredTextureImageData_buffer">buffer</a> (assuming this is an appropriate candidate image and the <a href="#SkImage_getDeferredTextureImageData_buffer">buffer</a> is -appropriately aligned). Upon success the size written is returned, otherwise 0. - -<a href="#SkImage_getDeferredTextureImageData_dstColorSpace">dstColorSpace</a> is the <a href="undocumented#Color_Space">Color Space</a> of the surface where this texture will ultimately be used. -If the method determines that mip-maps are needed, this helps determine the correct strategy -for building them (gamma-correct or not). - -<a href="#SkImage_getDeferredTextureImageData_dstColorType">dstColorType</a> is the color type of the surface where this texture will ultimately be used. -This determines the format with which the image will be uploaded to the GPU. If <a href="#SkImage_getDeferredTextureImageData_dstColorType">dstColorType</a> -does not support <a href="undocumented#Color_Space">Color Space</a> (low bit depth types such as <a href="SkImageInfo_Reference#SkColorType">kARGB 4444 SkColorType</a>), -then <a href="#SkImage_getDeferredTextureImageData_dstColorSpace">dstColorSpace</a> must be null. - -### Parameters - -<table> <tr> <td><a name="SkImage_getDeferredTextureImageData_contextThreadSafeProxy"> <code><strong>contextThreadSafeProxy </strong></code> </a></td> <td> -thread safe GPU context</td> - </tr> <tr> <td><a name="SkImage_getDeferredTextureImageData_deferredTextureImageUsageParams"> <code><strong>deferredTextureImageUsageParams </strong></code> </a></td> <td> -array of <a href="#Image">Image</a> transformations</td> - </tr> <tr> <td><a name="SkImage_getDeferredTextureImageData_paramCnt"> <code><strong>paramCnt </strong></code> </a></td> <td> -entries in <a href="#SkImage_getDeferredTextureImageData_deferredTextureImageUsageParams">deferredTextureImageUsageParams</a> array</td> - </tr> <tr> <td><a name="SkImage_getDeferredTextureImageData_buffer"> <code><strong>buffer </strong></code> </a></td> <td> -storage for <a href="undocumented#GPU_Texture">GPU Texture</a> data, or nullptr</td> - </tr> <tr> <td><a name="SkImage_getDeferredTextureImageData_dstColorSpace"> <code><strong>dstColorSpace </strong></code> </a></td> <td> -<a href="SkSurface_Reference#Surface">Surface</a> <a href="undocumented#Color_Space">Color Space</a>, or nullptr</td> - </tr> <tr> <td><a name="SkImage_getDeferredTextureImageData_dstColorType"> <code><strong>dstColorType </strong></code> </a></td> <td> -<a href="SkSurface_Reference#Surface">Surface</a> <a href="SkImageInfo_Reference#Color_Type">Color Type</a></td> - </tr> -</table> - -### Return Value - -size of storage for <a href="undocumented#GPU_Texture">GPU Texture</a> data - -### Example - -<div><fiddle-embed name="31d224ac4d22ba60221c565f9a12ad50" gpu="true"></fiddle-embed></div> - -### See Also - -<a href="#SkImage_MakeFromDeferredTextureImageData">MakeFromDeferredTextureImageData</a> +soonUsed only by Chrome. --- @@ -2244,34 +2074,7 @@ static sk_sp<SkImage> MakeFromDeferredTextureImageData(GrContext* context, SkBudgeted budgeted) </pre> -Used only by Chrome; to be deprecated. - -Returns a texture-backed image from <a href="#SkImage_MakeFromDeferredTextureImageData_data">data</a> produced in <a href="#SkImage_getDeferredTextureImageData">SkImage::getDeferredTextureImageData</a>. -The <a href="#SkImage_MakeFromDeferredTextureImageData_context">context</a> must be the <a href="#SkImage_MakeFromDeferredTextureImageData_context">context</a> that provided the proxy passed to -<a href="#SkImage_getDeferredTextureImageData">getDeferredTextureImageData</a>. - -### Parameters - -<table> <tr> <td><a name="SkImage_MakeFromDeferredTextureImageData_context"> <code><strong>context </strong></code> </a></td> <td> -<a href="undocumented#GPU_Context">GPU Context</a></td> - </tr> <tr> <td><a name="SkImage_MakeFromDeferredTextureImageData_data"> <code><strong>data </strong></code> </a></td> <td> -incomplete</td> - </tr> <tr> <td><a name="SkImage_MakeFromDeferredTextureImageData_budgeted"> <code><strong>budgeted </strong></code> </a></td> <td> -incomplete</td> - </tr> -</table> - -### Return Value - -incomplete - -### Example - -<div><fiddle-embed name="882e8e0103048009a25cfc20400492f7"></fiddle-embed></div> - -### See Also - -incomplete +soonUsed only by Chrome. --- @@ -2297,8 +2100,8 @@ If <a href="#SkImage_MakeBackendTextureFromSkImage_image">image</a> is both text reference was transferred using std::move(): <a href="#SkImage_MakeBackendTextureFromSkImage_image">image</a> is returned in <a href="#SkImage_MakeBackendTextureFromSkImage_backendTexture">backendTexture</a> without conversion or making a copy. -If the <a href="#SkImage">SkImage</a> is not texture backed, this function will generate a texture with the <a href="#SkImage_MakeBackendTextureFromSkImage_image">image</a>'s -contents and return that. +If <a href="#Image">Image</a> is not texture backed, this function returns texture with <a href="#Image">Image</a> +contents. ### Parameters diff --git a/site/user/api/SkMatrix_Reference.md b/site/user/api/SkMatrix_Reference.md index bcfa5412c0..9563cc568f 100644 --- a/site/user/api/SkMatrix_Reference.md +++ b/site/user/api/SkMatrix_Reference.md @@ -5,14 +5,14 @@ SkMatrix Reference ## <a name="Overview"></a> Overview -## <a name="Subtopics"></a> Subtopics +## <a name="Subtopic"></a> Subtopic | 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 | +| Constant | enum and enum class, const values | +| <a href="#Constructor">Constructor</a> | functions that construct <a href="SkMatrix_Reference#SkMatrix">SkMatrix</a> | +| <a href="#Member_Function">Member Function</a> | static functions and member methods | +| <a href="#Operator">Operator</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 @@ -27,25 +27,49 @@ 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="Constructors"></a> Constructors +## <a name="Constructor"></a> Constructor | name | description | | --- | --- | +| 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_MakeScale">MakeScale</a> | | <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_reset">reset</a> | sets <a href="#Matrix">Matrix</a> to identity | +| <a href="#SkMatrix_setAffine">setAffine</a> | sets left two columns | +| <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_setRSXform">setRSXform</a> | sets to rotate, scale, and translate | +| <a href="#SkMatrix_setRotate">setRotate</a> | sets to rotate about a point | +| | <a href="#SkMatrix_setRotate">setRotate</a> | +| <a href="#SkMatrix_setScale">setScale</a> | sets to scale about a point | +| | <a href="#SkMatrix_setScale">setScale</a> | +| <a href="#SkMatrix_setScaleTranslate">setScaleTranslate</a> | sets to scale and translate | +| <a href="#SkMatrix_setSinCos">setSinCos</a> | sets to rotate and scale about a point | +| | <a href="#SkMatrix_setSinCos">setSinCos</a> | +| <a href="#SkMatrix_setSkew">setSkew</a> | sets to skew about a point | +| | <a href="#SkMatrix_setSkew">setSkew</a> | +| <a href="#SkMatrix_setTranslate">setTranslate</a> | sets to translate in x and y | +| | <a href="#SkMatrix_setTranslate">setTranslate</a> | -## <a name="Operators"></a> Operators +## <a name="Operator"></a> Operator | name | description | | --- | --- | +| <a href="#SkMatrix_Concat">Concat</a> | returns the concatenation of <a href="#Matrix">Matrix</a> pair | +| <a href="#SkMatrix_cheapEqualTo">cheapEqualTo</a> | compares <a href="#Matrix">Matrix</a> pair using memcmp() | +| <a href="#SkMatrix_invert">invert</a> | returns inverse, if possible | | <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 +## <a name="Member_Function"></a> Member Function | name | description | | --- | --- | @@ -351,6 +375,37 @@ after setPolyToPoly: kTranslate_Mask kScale_Mask kAffine_Mask kPerspective_Mask +## <a name="Property"></a> Property + +| name | description | +| --- | --- | +| <a href="#SkMatrix_decomposeScale">decomposeScale</a> | separates scale if possible | +| <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_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_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 name="SkMatrix_getType"></a> ## getType @@ -1190,6 +1245,41 @@ after dirty cache: x = 66 --- +## <a name="Set"></a> Set + +| name | description | +| --- | --- | +| <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_postRotate">postRotate</a> | +| <a href="#SkMatrix_postScale">postScale</a> | post-multiplies <a href="#Matrix">Matrix</a> by scale | +| | <a href="#SkMatrix_postScale">postScale</a> | +| <a href="#SkMatrix_postSkew">postSkew</a> | post-multiplies <a href="#Matrix">Matrix</a> by skew | +| | <a href="#SkMatrix_postSkew">postSkew</a> | +| <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_preRotate">preRotate</a> | +| <a href="#SkMatrix_preScale">preScale</a> | pre-multiplies <a href="#Matrix">Matrix</a> by scale | +| | <a href="#SkMatrix_preScale">preScale</a> | +| <a href="#SkMatrix_preSkew">preSkew</a> | pre-multiplies <a href="#Matrix">Matrix</a> by skew | +| | <a href="#SkMatrix_preSkew">preSkew</a> | +| <a href="#SkMatrix_preTranslate">preTranslate</a> | pre-multiplies <a href="#Matrix">Matrix</a> by translation | +| <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_setAll">setAll</a> | sets all values from parameters | +| <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_setRectToRect">setRectToRect</a> | sets to map one <a href="SkRect_Reference#Rect">Rect</a> to another | +| <a href="#SkMatrix_setScaleX">setScaleX</a> | sets horizontal scale factor | +| <a href="#SkMatrix_setScaleY">setScaleY</a> | sets vertical scale factor | +| <a href="#SkMatrix_setSkewX">setSkewX</a> | sets horizontal skew factor | +| <a href="#SkMatrix_setSkewY">setSkewY</a> | sets vertical skew factor | +| <a href="#SkMatrix_setTranslateX">setTranslateX</a> | sets horizontal translation | +| <a href="#SkMatrix_setTranslateY">setTranslateY</a> | sets vertical translation | + <a name="SkMatrix_set"></a> ## set @@ -3202,6 +3292,25 @@ ScaleX: 2 SkewY: 5 SkewX: 3 ScaleY: 6 TransX: 4 TransY: 7 --- +## <a name="Transform"></a> Transform + +| name | description | +| --- | --- | +| <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_mapPoints">mapPoints</a> | +| <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_mapRect">mapRect</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_mapVector">mapVector</a> | +| <a href="#SkMatrix_mapVectors">mapVectors</a> | maps <a href="SkPoint_Reference#Vector">Vector</a> array | +| | <a href="#SkMatrix_mapVectors">mapVectors</a> | +| <a href="#SkMatrix_mapXY">mapXY</a> | maps <a href="SkPoint_Reference#Point">Point</a> | +| | <a href="#SkMatrix_mapXY">mapXY</a> | + <a name="SkMatrix_mapPoints"></a> ## mapPoints @@ -3954,7 +4063,7 @@ contains NaN, even if the other <a href="#Matrix">Matrix</a> also contains NaN. ### Return Value -true if m and <a href="#Matrix">Matrix</a> are numerically equal +true if <a href="#Matrix">Matrix</a> <a href="#SkMatrix_equal_operator_a">a</a> and <a href="#Matrix">Matrix</a> <a href="#SkMatrix_equal_operator_b">b</a> are numerically equal ### Example @@ -3996,7 +4105,7 @@ contains NaN, even if the other <a href="#Matrix">Matrix</a> also contains NaN. ### Return Value -true if m and <a href="#Matrix">Matrix</a> are numerically not equal +true if <a href="#Matrix">Matrix</a> <a href="#SkMatrix_notequal_operator_a">a</a> and <a href="#Matrix">Matrix</a> <a href="#SkMatrix_notequal_operator_b">b</a> are numerically not equal ### Example @@ -4008,6 +4117,14 @@ true if m and <a href="#Matrix">Matrix</a> are numerically not equal --- +## <a name="Utility"></a> Utility + +| name | description | +| --- | --- | +| <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_toString">toString</a> | converts <a href="#Matrix">Matrix</a> to machine readable form | + <a name="SkMatrix_dump"></a> ## dump diff --git a/site/user/api/SkPaint_Reference.md b/site/user/api/SkPaint_Reference.md index 1f9d6236fe..635142d06a 100644 --- a/site/user/api/SkPaint_Reference.md +++ b/site/user/api/SkPaint_Reference.md @@ -5,16 +5,16 @@ SkPaint Reference ## <a name="Overview"></a> Overview -## <a name="Subtopics"></a> Subtopics +## <a name="Subtopic"></a> Subtopic | 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 href="#Class_or_Struct">Class or Struct</a> | embedded struct and class members | +| <a href="#Constant">Constant</a> | enum and enum class, const values | +| <a href="#Constructor">Constructor</a> | functions that construct <a href="SkPaint_Reference#SkPaint">SkPaint</a> | +| <a href="#Member_Function">Member Function</a> | static functions and member methods | +| <a href="#Operator">Operator</a> | operator overloading methods | +| <a href="#Related_Function">Related Function</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 @@ -43,7 +43,7 @@ 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="Related_Functions"></a> Related Functions +## <a name="Related_Function"></a> Related Function | name | description | | --- | --- | @@ -93,7 +93,7 @@ Multiple colors are drawn either by using multiple paints or with objects like | <a href="#Typeface_Methods">Typeface Methods</a> | get and set <a href="undocumented#Typeface">Typeface</a> | | <a href="#Vertical_Text">Vertical Text</a> | orient text from top to bottom | -## <a name="Constants"></a> Constants +## <a name="Constant"></a> Constant | name | description | | --- | --- | @@ -102,19 +102,18 @@ Multiple colors are drawn either by using multiple paints or with objects like | <a href="#SkPaint_Flags">Flags</a> | values described by bits and masks | | <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 +## <a name="Class_or_Struct"></a> Class or Struct | name | description | | --- | --- | | <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 +## <a name="Constructor"></a> Constructor | name | description | | --- | --- | @@ -123,7 +122,7 @@ Multiple colors are drawn either by using multiple paints or with objects like | <a href="#SkPaint_copy_const_SkPaint">SkPaint(const SkPaint& paint)</a> | makes a shallow copy | | <a href="#SkPaint_destructor">~SkPaint()</a> | decreases <a href="undocumented#Reference_Count">Reference Count</a> of owned objects | -## <a name="Operators"></a> Operators +## <a name="Operator"></a> Operator | name | description | | --- | --- | @@ -132,7 +131,7 @@ Multiple colors are drawn either by using multiple paints or with objects like | <a href="#SkPaint_copy_operator">operator=(const SkPaint& paint)</a> | makes a shallow copy | | <a href="#SkPaint_equal_operator">operator==(const SkPaint& a, const SkPaint& b)</a> | compares paints for equality | -## <a name="Member_Functions"></a> Member Functions +## <a name="Member_Function"></a> Member Function | name | description | | --- | --- | @@ -158,7 +157,6 @@ 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 | @@ -220,7 +218,6 @@ Multiple colors are drawn either by using multiple paints or with objects like | <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 | @@ -857,6 +854,8 @@ multiple settings at once. ## <a name="SkPaint_ReserveFlags"></a> Enum SkPaint::ReserveFlags +soonOnly valid for Android framework. + <pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> enum <a href="#SkPaint_ReserveFlags">ReserveFlags</a> { <a href="#SkPaint_kUnderlineText_ReserveFlag">kUnderlineText ReserveFlag</a> = 0x08, @@ -867,18 +866,13 @@ enum <a href="#SkPaint_ReserveFlags">ReserveFlags</a> { <table> <tr> - <td><a name="SkPaint_kUnderlineText_ReserveFlag"> <code><strong>SkPaint::kUnderlineText_ReserveFlag </strong></code> </a></td><td>0x0008</td><td>mask for underline text</td> + <td><a name="SkPaint_kUnderlineText_ReserveFlag"> <code><strong>SkPaint::kUnderlineText_ReserveFlag </strong></code> </a></td><td>0x0008</td><td>soon</td> </tr> <tr> - <td><a name="SkPaint_kStrikeThruText_ReserveFlag"> <code><strong>SkPaint::kStrikeThruText_ReserveFlag </strong></code> </a></td><td>0x0010</td><td>mask for strike-thru text</td> + <td><a name="SkPaint_kStrikeThruText_ReserveFlag"> <code><strong>SkPaint::kStrikeThruText_ReserveFlag </strong></code> </a></td><td>0x0010</td><td>soon</td> </tr> -</table> - -### See Also - -<a href="#Flags">Flags</a> <a href="#SkPaint_getFlags">getFlags</a> - +</table> <a name="SkPaint_getFlags"></a> ## getFlags @@ -3555,14 +3549,6 @@ draw looper unique: false SkDrawLooper* getLooper() const </pre> -Deprecated. - -(see bug.skia.org/6259) - -### Return Value - -<a href="undocumented#Draw_Looper">Draw Looper</a> if previously set, nullptr otherwise - --- <a name="SkPaint_setDrawLooper"></a> @@ -3598,20 +3584,8 @@ iterates through drawing one or more time, altering <a href="#Paint">Paint</a></ void setLooper(sk_sp<SkDrawLooper> drawLooper) </pre> -Deprecated. - -(see bug.skia.org/6259) - -### Parameters - -<table> <tr> <td><a name="SkPaint_setLooper_drawLooper"> <code><strong>drawLooper </strong></code> </a></td> <td> -sets <a href="undocumented#Draw_Looper">Draw Looper</a> to <a href="#SkPaint_setLooper_drawLooper">drawLooper</a></td> - </tr> - --- -</table> - ## <a name="Text_Align"></a> Text Align ## <a name="SkPaint_Align"></a> Enum SkPaint::Align diff --git a/site/user/api/SkPath_Reference.md b/site/user/api/SkPath_Reference.md index 142ec36ae7..2b3aecf28a 100644 --- a/site/user/api/SkPath_Reference.md +++ b/site/user/api/SkPath_Reference.md @@ -5,16 +5,16 @@ SkPath Reference ## <a name="Overview"></a> Overview -## <a name="Subtopics"></a> Subtopics +## <a name="Subtopic"></a> Subtopic | 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="#Class_or_Struct">Class or Struct</a> | embedded struct and class members | +| <a href="#Constant">Constant</a> | enum and enum class, const values | +| <a href="#Constructor">Constructor</a> | functions that construct <a href="SkPath_Reference#SkPath">SkPath</a> | +| <a href="#Member_Function">Member Function</a> | static functions and member methods | +| <a href="#Operator">Operator</a> | operator overloading methods | +| <a href="#Related_Function">Related Function</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>. @@ -103,25 +103,29 @@ 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="Related_Functions"></a> Related Functions +## <a name="Related_Function"></a> Related Function | name | description | | --- | --- | | <a href="#Arc">Arc</a> | part of <a href="undocumented#Oval">Oval</a> or <a href="undocumented#Circle">Circle</a> | +| <a href="#Build">Build</a> | adds points and verbs to path | | <a href="#Conic">Conic</a> | conic section defined by three points and a weight | | <a href="#SkPath_Convexity">Convexity</a> | if <a href="#Path">Path</a> is concave or convex | | <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="#Interpolate">Interpolate</a> | weighted average of <a href="#Path">Path</a> pair | | <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">Quad</a> | Bezier_Curve described by second-order polynomial | +| <a href="#Utility">Utility</a> | rarely called management functions | | <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="#Volatile">Volatile</a> | caching attribute | | Weight | strength of <a href="#Conic">Conic</a> control <a href="SkPoint_Reference#Point">Point</a> | -## <a name="Constants"></a> Constants +## <a name="Constant"></a> Constant | name | description | | --- | --- | @@ -133,30 +137,33 @@ Internally, <a href="#Path">Path</a> lazily computes metrics likes bounds and co | <a href="#SkPath_SegmentMask">SegmentMask</a> | returns <a href="#SkPath_Verb">Verb</a> types in <a href="#Path">Path</a> | | <a href="#SkPath_Verb">Verb</a> | controls how <a href="#Path">Path</a> <a href="#Point">Points</a> are interpreted | -## <a name="Classes_and_Structs"></a> Classes and Structs +## <a name="Class_or_Struct"></a> Class or Struct | name | description | | --- | --- | | <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 +## <a name="Constructor"></a> Constructor | 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 | +| <a href="#SkPath_reset">reset</a> | removes <a href="#Verb_Array">Verb Array</a>, <a href="#Point_Array">Point Array</a>, and <a href="#Weight">Weights</a>; frees memory | +| <a href="#SkPath_rewind">rewind</a> | removes <a href="#Verb_Array">Verb Array</a>, <a href="#Point_Array">Point Array</a>, and <a href="#Weight">Weights</a>, keeping memory | | <a href="#SkPath_destructor">~SkPath()</a> | decreases <a href="undocumented#Reference_Count">Reference Count</a> of owned objects | -## <a name="Operators"></a> Operators +## <a name="Operator"></a> Operator | 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 | +| <a href="#SkPath_swap">swap</a> | exchanges <a href="#Path">Path</a> pair | -## <a name="Member_Functions"></a> Member Functions +## <a name="Member_Function"></a> Member Function | name | description | | --- | --- | @@ -213,7 +220,6 @@ Internally, <a href="#Path">Path</a> lazily computes metrics likes bounds and co | <a href="#SkPath_lineTo">lineTo</a> | appends <a href="undocumented#Line">Line</a> | | <a href="#SkPath_moveTo">moveTo</a> | starts <a href="#Contour">Contour</a> | | <a href="#SkPath_offset">offset</a> | translates <a href="#Point_Array">Point Array</a> | -| <a href="#SkPath_pathRefIsValid">pathRefIsValid</a> | to be deprecated | | <a href="#SkPath_quadTo">quadTo</a> | appends <a href="#Quad">Quad</a> | | <a href="#SkPath_rArcTo">rArcTo</a> | appends <a href="#Arc">Arc</a> relative to <a href="#Last_Point">Last Point</a> | | <a href="#SkPath_rConicTo">rConicTo</a> | appends <a href="#Conic">Conic</a> relative to <a href="#Last_Point">Last Point</a> | @@ -228,13 +234,11 @@ Internally, <a href="#Path">Path</a> lazily computes metrics likes bounds and co | <a href="#SkPath_serialize">serialize</a> | copies data to buffer | | <a href="#SkPath_setConvexity">setConvexity</a> | sets if geometry is convex to avoid future computation | | <a href="#SkPath_setFillType">setFillType</a> | sets <a href="#Fill_Type">Fill Type</a>: winding, even-odd, inverse | -| <a href="#SkPath_setIsConvex">setIsConvex</a> | deprecated | | <a href="#SkPath_setIsVolatile">setIsVolatile</a> | sets if <a href="undocumented#Device">Device</a> should not cache | | <a href="#SkPath_setLastPt">setLastPt</a> | replaces <a href="#Last_Point">Last Point</a> | | <a href="#SkPath_swap">swap</a> | exchanges <a href="#Path">Path</a> pair | | <a href="#SkPath_toggleInverseFillType">toggleInverseFillType</a> | toggles <a href="#Fill_Type">Fill Type</a> between inside and outside geometry | | <a href="#SkPath_transform">transform</a> | applies <a href="SkMatrix_Reference#Matrix">Matrix</a> to <a href="#Point_Array">Point Array</a> and <a href="#Weight">Weights</a> | -| <a href="#SkPath_unique">unique</a> | returns if data has single owner | | <a href="#SkPath_updateBoundsCache">updateBoundsCache</a> | refreshes result of <a href="#SkPath_getBounds">getBounds</a> | | <a href="#SkPath_writeToMemory">writeToMemory</a> | copies data to buffer | @@ -589,6 +593,31 @@ convexity != --- +## <a name="Property"></a> Property + +| name | description | +| --- | --- | +| <a href="#SkPath_IsCubicDegenerate">IsCubicDegenerate</a> | returns if <a href="#Cubic">Cubic</a> is very small | +| <a href="#SkPath_IsInverseFillType">IsInverseFillType</a> | returns if <a href="#Fill_Type">Fill Type</a> represents outside geometry | +| <a href="#SkPath_IsLineDegenerate">IsLineDegenerate</a> | returns if <a href="undocumented#Line">Line</a> is very small | +| <a href="#SkPath_IsQuadDegenerate">IsQuadDegenerate</a> | returns if <a href="#Quad">Quad</a> is very small | +| <a href="#SkPath_computeTightBounds">computeTightBounds</a> | returns extent of geometry | +| <a href="#SkPath_conservativelyContainsRect">conservativelyContainsRect</a> | returns true if <a href="SkRect_Reference#Rect">Rect</a> may be inside | +| <a href="#SkPath_contains">contains</a> | returns if <a href="SkPoint_Reference#Point">Point</a> is in fill area | +| <a href="#SkPath_getBounds">getBounds</a> | returns maximum and minimum of <a href="#Point_Array">Point Array</a> | +| <a href="#SkPath_getLastPt">getLastPt</a> | returns <a href="#Last_Point">Last Point</a> | +| <a href="#SkPath_isEmpty">isEmpty</a> | returns if verb count is zero | +| <a href="#SkPath_isFinite">isFinite</a> | returns if all <a href="SkPoint_Reference#Point">Point</a> values are finite | +| <a href="#SkPath_isInterpolatable">isInterpolatable</a> | returns if pair contains equal counts of <a href="#Verb_Array">Verb Array</a> and <a href="#Weight">Weights</a> | +| <a href="#SkPath_isLastContourClosed">isLastContourClosed</a> | returns if final <a href="#Contour">Contour</a> forms a loop | +| <a href="#SkPath_isLine">isLine</a> | returns if describes <a href="undocumented#Line">Line</a> | +| <a href="#SkPath_isNestedFillRects">isNestedFillRects</a> | returns if describes <a href="SkRect_Reference#Rect">Rect</a> pair, one inside the other | +| <a href="#SkPath_isOval">isOval</a> | returns if describes <a href="undocumented#Oval">Oval</a> | +| <a href="#SkPath_isRRect">isRRect</a> | returns if describes <a href="undocumented#Round_Rect">Round Rect</a> | +| <a href="#SkPath_isRect">isRect</a> | returns if describes <a href="SkRect_Reference#Rect">Rect</a> | +| <a href="#SkPath_isValid">isValid</a> | returns if data is internally consistent | +| <a href="#SkPath_isVolatile">isVolatile</a> | returns if <a href="undocumented#Device">Device</a> should not cache | + <a name="SkPath_isInterpolatable"></a> ## isInterpolatable @@ -632,6 +661,12 @@ paths are interpolatable --- +## <a name="Interpolate"></a> Interpolate + +| name | description | +| --- | --- | +| <a href="#SkPath_interpolate">interpolate</a> | interpolates between <a href="#Path">Path</a> pair | + <a name="SkPath_interpolate"></a> ## interpolate @@ -639,7 +674,7 @@ paths are interpolatable bool interpolate(const SkPath& ending, SkScalar weight, SkPath* out) const </pre> -Interpolate between <a href="#Path">Paths</a> with <a href="#Point_Array">Point Array</a> of equal size. +<a href="#Interpolate">Interpolate</a> between <a href="#Path">Paths</a> with <a href="#Point_Array">Point Array</a> of equal size. Copy <a href="#Verb_Array">Verb Array</a> and <a href="#Weight">Weights</a> to <a href="#SkPath_interpolate_out">out</a>, and set <a href="#SkPath_interpolate_out">out</a> <a href="#Point_Array">Point Array</a> to a weighted average of this <a href="#Point_Array">Point Array</a> and <a href="#SkPath_interpolate_ending">ending</a> <a href="#Point_Array">Point Array</a>, using the formula: (<a href="#Path">Path</a> <a href="SkPoint_Reference#Point">Point</a> * <a href="#SkPath_interpolate_weight">weight</a>) + <a href="#SkPath_interpolate_ending">ending</a> <a href="SkPoint_Reference#Point">Point</a> * (1 - <a href="#SkPath_interpolate_weight">weight</a>). @@ -685,9 +720,7 @@ true if <a href="#Path">Paths</a> contain same number of <a href="#Point">Points bool unique() const </pre> -### Return Value - -true if <a href="#Path">Path</a> has one owner +soonOnly valid for Android framework. --- @@ -1029,11 +1062,7 @@ true if <a href="#Convexity">Convexity</a> stored or computed is <a href="#SkPat void setIsConvex(bool isConvex) </pre> -Deprecated. Use <a href="#SkPath_setConvexity">setConvexity</a>. - -### See Also - -<a href="#Convexity">Convexity</a> <a href="#SkPath_setConvexity">setConvexity</a> <a href="#SkPath_getConvexity">getConvexity</a> +Use <a href="#SkPath_setConvexity">setConvexity</a>. --- @@ -1315,6 +1344,12 @@ volatile by default is false --- +## <a name="Volatile"></a> Volatile + +| name | description | +| --- | --- | +| <a href="#SkPath_setIsVolatile">setIsVolatile</a> | sets if <a href="undocumented#Device">Device</a> should not cache | + <a name="SkPath_setIsVolatile"></a> ## setIsVolatile @@ -1843,6 +1878,23 @@ rotated circle bounds = 14.6447, 9.64466, 85.3553, 80.3553 --- +## <a name="Utility"></a> Utility + +| 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_dump_2">dump</a> | sends text representation using floats to standard output | +| | dump | +| <a href="#SkPath_dumpHex">dumpHex</a> | sends text representation using hexadecimal to standard output | +| <a href="#SkPath_getSegmentMasks">getSegmentMasks</a> | returns types in <a href="#Verb_Array">Verb Array</a> | +| <a href="#SkPath_incReserve">incReserve</a> | reserves space for additional data | +| <a href="#SkPath_readFromMemory">readFromMemory</a> | Initializes from buffer | +| <a href="#SkPath_serialize">serialize</a> | copies data to buffer | +| <a href="#SkPath_setLastPt">setLastPt</a> | replaces <a href="#Last_Point">Last Point</a> | +| <a href="#SkPath_updateBoundsCache">updateBoundsCache</a> | refreshes result of <a href="#SkPath_getBounds">getBounds</a> | +| <a href="#SkPath_writeToMemory">writeToMemory</a> | copies data to buffer | + <a name="SkPath_updateBoundsCache"></a> ## updateBoundsCache @@ -1986,6 +2038,40 @@ number of additional <a href="#Point">Points</a> to allocate</td> --- +## <a name="Build"></a> Build + +| name | description | +| --- | --- | +| <a href="#SkPath_addArc">addArc</a> | adds one <a href="#Contour">Contour</a> containing <a href="#Arc">Arc</a> | +| <a href="#SkPath_addCircle">addCircle</a> | adds one <a href="#Contour">Contour</a> containing <a href="undocumented#Circle">Circle</a> | +| <a href="#SkPath_addOval">addOval</a> | adds one <a href="#Contour">Contour</a> containing <a href="undocumented#Oval">Oval</a> | +| | <a href="#SkPath_addOval">addOval</a> | +| <a href="#SkPath_addPath">addPath</a> | adds contents of <a href="#Path">Path</a> | +| | <a href="#SkPath_addPath">addPath</a> | +| | <a href="#SkPath_addPath">addPath</a> | +| <a href="#SkPath_addPoly">addPoly</a> | adds one <a href="#Contour">Contour</a> containing connected lines | +| <a href="#SkPath_addRRect">addRRect</a> | adds one <a href="#Contour">Contour</a> containing <a href="undocumented#Round_Rect">Round Rect</a> | +| | <a href="#SkPath_addRRect">addRRect</a> | +| <a href="#SkPath_addRect">addRect</a> | adds one <a href="#Contour">Contour</a> containing <a href="SkRect_Reference#Rect">Rect</a> | +| | <a href="#SkPath_addRect">addRect</a> | +| | <a href="#SkPath_addRect">addRect</a> | +| <a href="#SkPath_addRoundRect">addRoundRect</a> | adds one <a href="#Contour">Contour</a> containing <a href="undocumented#Round_Rect">Round Rect</a> with common corner radii | +| | <a href="#SkPath_addRoundRect">addRoundRect</a> | +| <a href="#SkPath_arcTo">arcTo</a> | appends <a href="#Arc">Arc</a> | +| <a href="#SkPath_close">close</a> | makes last <a href="#Contour">Contour</a> a loop | +| <a href="#SkPath_cubicTo">cubicTo</a> | appends <a href="#Cubic">Cubic</a> | +| <a href="#SkPath_lineTo">lineTo</a> | appends <a href="undocumented#Line">Line</a> | +| | <a href="#SkPath_lineTo">lineTo</a> | +| <a href="#SkPath_moveTo">moveTo</a> | starts <a href="#Contour">Contour</a> | +| | <a href="#SkPath_moveTo">moveTo</a> | +| <a href="#SkPath_rArcTo">rArcTo</a> | appends <a href="#Arc">Arc</a> relative to <a href="#Last_Point">Last Point</a> | +| <a href="#SkPath_rConicTo">rConicTo</a> | appends <a href="#Conic">Conic</a> relative to <a href="#Last_Point">Last Point</a> | +| <a href="#SkPath_rCubicTo">rCubicTo</a> | appends <a href="#Cubic">Cubic</a> relative to <a href="#Last_Point">Last Point</a> | +| <a href="#SkPath_rLineTo">rLineTo</a> | appends <a href="undocumented#Line">Line</a> relative to <a href="#Last_Point">Last Point</a> | +| <a href="#SkPath_rMoveTo">rMoveTo</a> | starts <a href="#Contour">Contour</a> relative to <a href="#Last_Point">Last Point</a> | +| <a href="#SkPath_rQuadTo">rQuadTo</a> | appends <a href="#Quad">Quad</a> relative to <a href="#Last_Point">Last Point</a> | +| <a href="#SkPath_reverseAddPath">reverseAddPath</a> | adds contents of <a href="#Path">Path</a> back to front | + <a name="SkPath_moveTo"></a> ## moveTo @@ -3973,6 +4059,15 @@ overwritten, translated copy of <a href="#Path">Path</a>; may be nullptr</td> --- +## <a name="Transform"></a> Transform + +| name | description | +| --- | --- | +| <a href="#SkPath_offset">offset</a> | translates <a href="#Point_Array">Point Array</a> | +| | offset | +| <a href="#SkPath_transform">transform</a> | applies <a href="SkMatrix_Reference#Matrix">Matrix</a> to <a href="#Point_Array">Point Array</a> and <a href="#Weight">Weights</a> | +| | transform | + <a name="SkPath_offset_2"></a> <pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> @@ -4007,7 +4102,7 @@ offset added to <a href="#Point_Array">Point Array</a> y coordinates</td> void transform(const SkMatrix& matrix, SkPath* dst) const </pre> -Transform <a href="#Verb_Array">Verb Array</a>, <a href="#Point_Array">Point Array</a>, and weight by <a href="#SkPath_transform_matrix">matrix</a>. +<a href="#Transform">Transform</a> <a href="#Verb_Array">Verb Array</a>, <a href="#Point_Array">Point Array</a>, and weight by <a href="#SkPath_transform_matrix">matrix</a>. transform may change <a href="#Verb">Verbs</a> and increase their number. Transformed <a href="#Path">Path</a> replaces <a href="#SkPath_transform_dst">dst</a>; if <a href="#SkPath_transform_dst">dst</a> is nullptr, original data is replaced. @@ -4037,7 +4132,7 @@ overwritten, transformed copy of <a href="#Path">Path</a>; may be nullptr</td> void transform(const SkMatrix& matrix) </pre> -Transform <a href="#Verb_Array">Verb Array</a>, <a href="#Point_Array">Point Array</a>, and weight by <a href="#SkPath_transform_2_matrix">matrix</a>. +<a href="#Transform">Transform</a> <a href="#Verb_Array">Verb Array</a>, <a href="#Point_Array">Point Array</a>, and weight by <a href="#SkPath_transform_2_matrix">matrix</a>. transform may change <a href="#Verb">Verbs</a> and increase their number. <a href="#Path">Path</a> is replaced by transformed data. @@ -4555,6 +4650,8 @@ Setting <a href="#Fill_Type">Fill Type</a> does not change <a href="#Generation_ Each time the path is modified, a different <a href="#Generation_ID">Generation ID</a> will be returned. +<a href="#Fill_Type">Fill Type</a> does affect <a href="#Generation_ID">Generation ID</a> on Android framework. + ### Return Value non-zero, globally unique value @@ -4604,13 +4701,7 @@ true if <a href="#Path">Path</a> data is consistent bool pathRefIsValid() const </pre> -Returns if <a href="#Path">Path</a> data is consistent. - -To be deprecated soon. - -### Return Value - -true if <a href="#Path">Path</a> data is consistent +soon --- @@ -5110,6 +5201,11 @@ peek Done == verb Done </fiddle-embed></div> +StdOut isn't really volatile, it just produces the wrong result. +A simple fix changes the output of hairlines and needs to be +investigated to see if the change is correct or not. +https://skia-review.googlesource.com/c/21340/ + ### See Also <a href="#SkPath_RawIter_next">next</a> diff --git a/site/user/api/SkPixmap_Reference.md b/site/user/api/SkPixmap_Reference.md index ed044b05c0..97753c3bbd 100644 --- a/site/user/api/SkPixmap_Reference.md +++ b/site/user/api/SkPixmap_Reference.md @@ -5,13 +5,13 @@ SkPixmap Reference ## <a name="Overview"></a> Overview -## <a name="Subtopics"></a> Subtopics +## <a name="Subtopic"></a> Subtopic | 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 href="#Constructor">Constructor</a> | functions that construct <a href="SkPixmap_Reference#SkPixmap">SkPixmap</a> | +| <a href="#Member_Function">Member Function</a> | static functions and member methods | +| <a href="#Related_Function">Related Function</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. @@ -25,7 +25,7 @@ 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="Related_Functions"></a> Related Functions +## <a name="Related_Function"></a> Related Function | name | description | | --- | --- | @@ -36,14 +36,14 @@ to manage pixel memory; <a href="undocumented#Pixel_Ref">Pixel Ref</a> is safe a | <a href="#Writable_Address">Writable Address</a> | returns writable pixels | | <a href="#Writer">Writer</a> | copy to pixel values | -## <a name="Constructors"></a> Constructors +## <a name="Constructor"></a> Constructor | 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 +## <a name="Member_Function"></a> Member Function | name | description | | --- | --- | @@ -285,40 +285,7 @@ is not unique bool SK_WARN_UNUSED_RESULT reset(const SkMask& mask) </pre> -Sets width, height, pixel address, and row bytes to <a href="undocumented#Mask">Mask</a> properties, if <a href="undocumented#Mask">Mask</a> -format is <a href="#SkMask_kA8_Format">SkMask::kA8 Format</a>; and returns true. Otherwise sets width, height, -row bytes to zero; pixel address to nullptr; <a href="SkImageInfo_Reference#SkColorType">SkColorType</a> to <a href="SkImageInfo_Reference#SkColorType">kUnknown SkColorType</a>; -and <a href="SkImageInfo_Reference#SkAlphaType">SkAlphaType</a> to <a href="SkImageInfo_Reference#SkAlphaType">kUnknown SkAlphaType</a>; and returns false. - -Failing to read the return value generates a compile time warning. - -### Parameters - -<table> <tr> <td><a name="SkPixmap_reset_3_mask"> <code><strong>mask </strong></code> </a></td> <td> -<a href="undocumented#Mask">Mask</a> containing pixels and dimensions</td> - </tr> -</table> - -### Return Value - -true if set to <a href="undocumented#Mask">Mask</a> properties - -### Example - -<div><fiddle-embed name="379761a97bd7a116638a34eb3e80bf0d"> - -#### Example Output - -~~~~ -success: true width: 2 height: 2 -success: false width: 0 height: 0 -~~~~ - -</fiddle-embed></div> - -### See Also - -<a href="undocumented#Mask">Mask</a> <a href="#SkPixmap_reset">reset</a><sup><a href="#SkPixmap_reset_2">[2]</a></sup><sup><a href="#SkPixmap_reset_3">[3]</a></sup> +soon --- diff --git a/site/user/api/SkPoint_Reference.md b/site/user/api/SkPoint_Reference.md index 6e831a0c20..a7f759a206 100644 --- a/site/user/api/SkPoint_Reference.md +++ b/site/user/api/SkPoint_Reference.md @@ -5,38 +5,26 @@ SkPoint Reference ## <a name="Overview"></a> Overview -## <a name="Subtopics"></a> Subtopics +## <a name="Subtopic"></a> Subtopic | 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 href="#Constructor">Constructor</a> | functions that construct <a href="SkPoint_Reference#SkPoint">SkPoint</a> | +| <a href="#Member_Function">Member Function</a> | static functions and member methods | +| <a href="#Member">Member</a> | member values | +| <a href="#Operator">Operator</a> | operator overloading methods | +| <a href="#Related_Function">Related Function</a> | similar methods grouped together | # <a name="SkPoint"></a> Struct SkPoint +<a href="#SkPoint">SkPoint</a> holds two 32 bit floating point coordinates. -## <a name="Constructors"></a> Constructors +## <a name="Related_Function"></a> Related Function | name | description | | --- | --- | -| <a href="#SkPoint_Make">Make</a> | constructs from <a href="undocumented#SkScalar">SkScalar</a> inputs | +| <a href="#SkPoint_Offset">Offset</a> | moves sides | -## <a name="Operators"></a> Operators - -| name | description | -| --- | --- | -| <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 +## <a name="Member_Function"></a> Member Function | name | description | | --- | --- | @@ -66,7 +54,7 @@ SkPoint Reference | <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 +## <a name="Member"></a> Member | name | description | | --- | --- | @@ -83,6 +71,12 @@ infinities and NaN. y-axis value used by both <a href="#Point">Point</a> and <a href="SkPoint_Reference#Vector">Vector</a>. May contain any value, including infinities and NaN. +## <a name="Constructor"></a> Constructor + +| name | description | +| --- | --- | +| <a href="#SkPoint_Make">Make</a> | constructs from <a href="undocumented#SkScalar">SkScalar</a> inputs | + <a name="SkPoint_Make"></a> ## Make @@ -123,6 +117,19 @@ all equal --- +## <a name="Property"></a> Property + +| name | description | +| --- | --- | +| <a href="#SkPoint_Distance">Distance</a> | returns straight-line distance between points | +| <a href="#SkPoint_Length">Length</a> | returns straight-line distance to origin | +| <a href="#SkPoint_distanceToOrigin">distanceToOrigin</a> | returns straight-line distance to origin | +| <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_length">length</a> | returns straight-line distance to origin | +| <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="SkPoint_x"></a> ## x @@ -217,6 +224,19 @@ pt.isZero() == true --- +## <a name="Set"></a> Set + +| name | description | +| --- | --- | +| <a href="#SkPoint_iset">iset</a> | sets to integer input | +| | iset | +| <a href="#SkPoint_normalize">normalize</a> | sets length to one, preserving direction | +| <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_setLength">setLength</a> | +| <a href="#SkPoint_setNormalize">setNormalize</a> | sets length to one, in direction of (x, y) | + <a name="SkPoint_set"></a> ## set @@ -360,6 +380,17 @@ pt: nan, -nan abs: nan, nan --- +## <a name="Offset"></a> Offset + +| name | description | +| --- | --- | +| <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_Offset">Offset</a> | +| <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 | +| | scale | + <a name="SkPoint_Offset"></a> ## Offset @@ -631,6 +662,26 @@ true if (x, y) length is not zero or nearly zero --- +## <a name="Operator"></a> Operator + +| name | description | +| --- | --- | +| <a href="#SkPoint_CrossProduct">CrossProduct</a> | returns cross product | +| <a href="#SkPoint_DotProduct">DotProduct</a> | returns dot product | +| <a href="#SkPoint_cross">cross</a> | returns cross product | +| <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_negate">negate</a> | reverses the sign of both members | +| <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="SkPoint_scale"></a> ## scale @@ -1243,9 +1294,9 @@ static SkScalar CrossProduct(const SkVector& a, const SkVector& b) Returns the cross product of <a href="SkPoint_Reference#Vector">Vector</a> <a href="#SkPoint_CrossProduct_a">a</a> and <a href="SkPoint_Reference#Vector">Vector</a> <a href="#SkPoint_CrossProduct_b">b</a>. -<a href="#SkPoint_CrossProduct_a">a</a> and <a href="#SkPoint_CrossProduct_b">b</a> form three-dimensional vectors with z equal to zero. The cross product -is <a href="#SkPoint_CrossProduct_a">a</a> three-dimensional vector with x and y equal to zero. The cross product z -term equals the returned value. +<a href="#SkPoint_CrossProduct_a">a</a> and <a href="#SkPoint_CrossProduct_b">b</a> form three-dimensional vectors with z-axis value equal to zero. The +cross product is <a href="#SkPoint_CrossProduct_a">a</a> three-dimensional vector with x-axis and y-axis values equal +to zero. The cross product z-axis component is returned. ### Parameters @@ -1279,9 +1330,9 @@ SkScalar cross(const SkVector& vec) const Returns the cross product of <a href="SkPoint_Reference#Vector">Vector</a> and <a href="#SkPoint_cross_vec">vec</a>. -<a href="SkPoint_Reference#Vector">Vector</a> and <a href="#SkPoint_cross_vec">vec</a> form three-dimensional vectors with z equal to zero. The -cross product is a three-dimensional vector with x and y equal to zero. -The cross product z term equals the returned value. +<a href="SkPoint_Reference#Vector">Vector</a> and <a href="#SkPoint_cross_vec">vec</a> form three-dimensional vectors with z-axis value equal to zero. +The cross product is a three-dimensional vector with x-axis and y-axis values +equal to zero. The cross product z-axis component is returned. ### Parameters diff --git a/site/user/api/SkRect_Reference.md b/site/user/api/SkRect_Reference.md index d6aea67c64..2db62a5454 100644 --- a/site/user/api/SkRect_Reference.md +++ b/site/user/api/SkRect_Reference.md @@ -5,15 +5,15 @@ SkRect Reference ## <a name="Overview"></a> Overview -## <a name="Subtopics"></a> Subtopics +## <a name="Subtopic"></a> Subtopic | 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 | -| <a href="#Operators">Operators</a> | operator overloading methods | -| <a href="#Related_Functions">Related Functions</a> | similar methods grouped together | +| <a href="#Constructor">Constructor</a> | functions that construct <a href="SkRect_Reference#SkRect">SkRect</a> | +| <a href="#Member_Function">Member Function</a> | static functions and member methods | +| <a href="#Member">Member</a> | member values | +| <a href="#Operator">Operator</a> | operator overloading methods | +| <a href="#Related_Function">Related Function</a> | similar methods grouped together | # <a name="SkRect"></a> Struct SkRect <a href="#SkRect">SkRect</a> holds four <a href="undocumented#SkScalar">SkScalar</a> coordinates describing the upper and @@ -25,31 +25,23 @@ its top, it is considered empty. <a href="#SkRect">SkRect</a> can be constructed from int values to avoid compiler warnings that integer input cannot convert to <a href="undocumented#SkScalar">SkScalar</a> without loss of precision. -## <a name="Related_Functions"></a> Related Functions +## <a name="Related_Function"></a> Related Function | 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 | -| <a href="#Intersection">Intersection</a> | set to shared bounds | -| <a href="#Join">Join</a> | set to union of bounds | -| <a href="#Properties">Properties</a> | side values, center, validity | | <a href="#Rounding">Rounding</a> | adjust to integer bounds | -| <a href="#Set">Set</a> | replaces all values | -| <a href="#Sorting">Sorting</a> | orders sides | -## <a name="Member_Functions"></a> Member Functions +## <a name="Member_Function"></a> Member 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) | -| <a href="#SkRect_MakeFromIRect">MakeFromIRect</a> | deprecated | | <a href="#SkRect_MakeIWH">MakeIWH</a> | constructs from int input returning (0, 0, width, height) | | <a href="#SkRect_MakeLTRB">MakeLTRB</a> | constructs from <a href="undocumented#SkScalar">SkScalar</a> left, top, right, bottom | -| <a href="#SkRect_MakeLargest">MakeLargest</a> | deprecated | | <a href="#SkRect_MakeSize">MakeSize</a> | constructs from <a href="undocumented#Size">Size</a> returning (0, 0, width, height) | | <a href="#SkRect_MakeWH">MakeWH</a> | constructs from <a href="undocumented#SkScalar">SkScalar</a> input returning (0, 0, width, height) | | <a href="#SkRect_MakeXYWH">MakeXYWH</a> | constructs from <a href="undocumented#SkScalar">SkScalar</a> input returning (x, y, width, height) | @@ -98,7 +90,7 @@ integer input cannot convert to <a href="undocumented#SkScalar">SkScalar</a> wit | <a href="#SkRect_x">x</a> | returns bounds left | | <a href="#SkRect_y">y</a> | returns bounds top | -## <a name="Members"></a> Members +## <a name="Member"></a> Member | name | description | | --- | --- | @@ -127,16 +119,14 @@ horizontal values when sorted. When equal to or less than <a href="#SkRect_fLeft May contain any value, including infinities and NaN. The larger of the vertical values when sorted. When equal to or less than <a href="#SkRect_fTop">fTop</a>, <a href="#Rect">Rect</a> is empty. -## <a name="Constructors"></a> Constructors +## <a name="Constructor"></a> Constructor | name | description | -| --- | --- | +| --- | --- | | <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) | -| <a href="#SkRect_MakeFromIRect">MakeFromIRect</a> | deprecated | | <a href="#SkRect_MakeIWH">MakeIWH</a> | constructs from int input returning (0, 0, width, height) | | <a href="#SkRect_MakeLTRB">MakeLTRB</a> | constructs from <a href="undocumented#SkScalar">SkScalar</a> left, top, right, bottom | -| <a href="#SkRect_MakeLargest">MakeLargest</a> | deprecated | | <a href="#SkRect_MakeSize">MakeSize</a> | constructs from <a href="undocumented#Size">Size</a> returning (0, 0, width, height) | | <a href="#SkRect_MakeWH">MakeWH</a> | constructs from <a href="undocumented#SkScalar">SkScalar</a> input returning (0, 0, width, height) | | <a href="#SkRect_MakeXYWH">MakeXYWH</a> | constructs from <a href="undocumented#SkScalar">SkScalar</a> input returning (x, y, width, height) | @@ -411,23 +401,6 @@ rect: -10, 35, 5, 60 isEmpty: false static SkRect SK_WARN_UNUSED_RESULT MakeFromIRect(const SkIRect& irect) </pre> -Deprecated. - -### Parameters - -<table> <tr> <td><a name="SkRect_MakeFromIRect_irect"> <code><strong>irect </strong></code> </a></td> <td> -integer rect</td> - </tr> -</table> - -### Return Value - -<a href="#SkRect_MakeFromIRect_irect">irect</a> as <a href="#SkRect">SkRect</a> - -### See Also - -<a href="#SkRect_Make">Make</a><sup><a href="#SkRect_Make_2">[2]</a></sup> - --- <a name="SkRect_Make"></a> @@ -500,13 +473,17 @@ integer unsorted bounds</td> --- -## <a name="Properties"></a> Properties +## <a name="Property"></a> Property | name | description | -| --- | --- | +| --- | --- | +| <a href="#SkRect_asScalars">asScalars</a> | returns pointer to members as array | | <a href="#SkRect_bottom">bottom</a> | returns larger bounds in y, if sorted | | <a href="#SkRect_centerX">centerX</a> | returns midpoint in x | | <a href="#SkRect_centerY">centerY</a> | returns midpoint in y | +| <a href="#SkRect_dump_2">dump</a> | sends text representation to standard output using floats | +| | dump | +| <a href="#SkRect_dumpHex">dumpHex</a> | sends text representation to standard output using hexadecimal | | <a href="#SkRect_height">height</a> | returns span in y | | <a href="#SkRect_isEmpty">isEmpty</a> | returns true if width or height are zero or negative | | <a href="#SkRect_isFinite">isFinite</a> | returns true if no member is infinite or NaN | @@ -955,10 +932,10 @@ left: 2e+38 right: 3e+38 centerX: inf safe mid x: 2.5e+38 --- -## <a name="Operators"></a> Operators +## <a name="Operator"></a> Operator | name | description | -| --- | --- | +| --- | --- | | <a href="#SkRect_notequal_operator">operator!=(const SkRect& a, const SkRect& b)</a> | returns true if members are unequal | | <a href="#SkRect_equal_operator">operator==(const SkRect& a, const SkRect& b)</a> | returns true if members are equal | @@ -1056,7 +1033,7 @@ test with NaN is not equal to itself ## <a name="As_Points"></a> As Points | name | description | -| --- | --- | +| --- | --- | | <a href="#SkRect_setBounds">setBounds</a> | sets to upper and lower limits of <a href="SkPoint_Reference#Point">Point</a> array | | <a href="#SkRect_setBoundsCheck">setBoundsCheck</a> | sets to upper and lower limits of <a href="SkPoint_Reference#Point">Point</a> array | | <a href="#SkRect_toQuad">toQuad</a> | returns four corners as <a href="SkPoint_Reference#Point">Point</a> | @@ -1193,14 +1170,8 @@ added: nan, 8 count: 4 rect: 0, 0, 0, 0 success: false ## <a name="Set"></a> Set | name | description | -| --- | --- | -| <a href="#SkRect_iset">iset</a> | sets to int input (left, top, right, bottom) | -| <a href="#SkRect_isetWH">isetWH</a> | sets to int input (0, 0, width, height) | +| --- | --- | | <a href="#SkRect_set">set</a> | sets to <a href="undocumented#SkScalar">SkScalar</a> input (left, top, right, bottom) and others | -| | void <a href="#SkRect_set">set(const SkIRect& src)</a> | -| | void <a href="#SkRect_set_2">set(SkScalar left, SkScalar top, SkScalar right, SkScalar bottom)</a> | -| | void <a href="#SkRect_set_3">set(const SkPoint pts[], int count)</a> | -| | void <a href="#SkRect_set_4">set(const SkPoint& p0, const SkPoint& p1)</a> | | <a href="#SkRect_setEmpty">setEmpty</a> | sets to (0, 0, 0, 0) | | <a href="#SkRect_setLTRB">setLTRB</a> | sets to <a href="undocumented#SkScalar">SkScalar</a> input (left, top, right, bottom) | | <a href="#SkRect_setWH">setWH</a> | sets to <a href="undocumented#SkScalar">SkScalar</a> input (0, 0, width, height) | @@ -1514,7 +1485,7 @@ rect: -15, 0, 0, 25 isEmpty: false ## <a name="From_Integers"></a> From Integers | name | description | -| --- | --- | +| --- | --- | | <a href="#SkRect_iset">iset</a> | sets to int input (left, top, right, bottom) | | <a href="#SkRect_isetWH">isetWH</a> | sets to int input (0, 0, width, height) | @@ -1604,14 +1575,9 @@ rect2: {0, 0, 1, 2} ## <a name="Inset_Outset_Offset"></a> Inset Outset Offset | name | description | -| --- | --- | +| --- | --- | | <a href="#SkRect_inset">inset</a> | moves the sides symmetrically about the center | -| <a href="#SkRect_makeInset">makeInset</a> | constructs from sides moved symmetrically about the center | -| <a href="#SkRect_makeOffset">makeOffset</a> | constructs from translated sides | -| <a href="#SkRect_makeOutset">makeOutset</a> | constructs from sides moved symmetrically about the center | | <a href="#SkRect_offset">offset</a> | translates sides without changing width and height | -| | void <a href="#SkRect_offset">offset(SkScalar dx, SkScalar dy)</a> | -| | void <a href="#SkRect_offset_2">offset(const SkPoint& delta)</a> | | <a href="#SkRect_offsetTo">offsetTo</a> | translates to (x, y) without changing width and height | | <a href="#SkRect_outset">outset</a> | moves the sides symmetrically about the center | @@ -1965,18 +1931,11 @@ The intersection is only meaningful if the resulting <a href="#Rect">Rect</a> is describes an area: <a href="#SkRect_fLeft">fLeft</a> is less than <a href="#SkRect_fRight">fRight</a>, and <a href="#SkRect_fTop">fTop</a> is less than <a href="#SkRect_fBottom">fBottom</a>. | name | description | -| --- | --- | +| --- | --- | | <a href="#SkRect_Intersects">Intersects</a> | returns true if areas overlap | | <a href="#SkRect_contains">contains</a> | returns true if points are equal or inside | -| | bool <a href="#SkRect_contains">contains(const SkRect& r)</a> const | -| | bool <a href="#SkRect_contains_2">contains(const SkIRect& r)</a> const | | <a href="#SkRect_intersect">intersect</a> | sets to shared area; returns true if not empty | -| | bool <a href="#SkRect_intersect_2">intersect(SkScalar left, SkScalar top, SkScalar right, SkScalar bottom)</a> | -| | bool <a href="#SkRect_intersect">intersect(const SkRect& r)</a> | -| | bool <a href="#SkRect_intersect_3">intersect(const SkRect& a, const SkRect& b)</a> | | <a href="#SkRect_intersects">intersects</a> | returns true if areas overlap | -| | bool <a href="#SkRect_intersects">intersects(SkScalar left, SkScalar top, SkScalar right, SkScalar bottom)</a> const | -| | bool <a href="#SkRect_intersects_2">intersects(const SkRect& r)</a> const | <a name="SkRect_contains"></a> ## contains @@ -2329,10 +2288,8 @@ intersection ## <a name="Join"></a> Join | name | description | -| --- | --- | +| --- | --- | | <a href="#SkRect_join">join</a> | sets to union of bounds | -| | void <a href="#SkRect_join">join(SkScalar left, SkScalar top, SkScalar right, SkScalar bottom)</a> | -| | void <a href="#SkRect_join_2">join(const SkRect& r)</a> | | <a href="#SkRect_joinNonEmptyArg">joinNonEmptyArg</a> | sets to union of bounds, asserting that argument is not empty | | <a href="#SkRect_joinPossiblyEmptyRect">joinPossiblyEmptyRect</a> | sets to union of bounds. Skips empty check for both | @@ -2498,15 +2455,10 @@ sorted: 10, 0, 55, 100 ## <a name="Rounding"></a> Rounding | name | description | -| --- | --- | +| --- | --- | | <a href="#SkRect_round_2">round</a> | sets members to nearest integer value | -| | void <a href="#SkRect_round">round(SkIRect* dst)</a> const | -| | <a href="SkIRect_Reference#SkIRect">SkIRect</a> <a href="#SkRect_round_2">round</a> const | | <a href="#SkRect_roundIn">roundIn</a> | sets members to nearest integer value towards opposite | | <a href="#SkRect_roundOut">roundOut</a> | sets members to nearest integer value away from opposite | -| | void <a href="#SkRect_roundOut">roundOut(SkIRect* dst)</a> const | -| | void <a href="#SkRect_roundOut_2">roundOut(SkRect* dst)</a> const | -| | <a href="SkIRect_Reference#SkIRect">SkIRect</a> <a href="#SkRect_roundOut_3">roundOut</a> const | <a name="SkRect_round"></a> ## round @@ -2712,8 +2664,7 @@ round: 30, 50, 41, 61 ## <a name="Sorting"></a> Sorting | name | description | -| --- | --- | -| <a href="#SkRect_makeSorted">makeSorted</a> | constructs, ordering sides from smaller to larger | +| --- | --- | | <a href="#SkRect_sort">sort</a> | orders sides from smaller to larger | <a name="SkRect_sort"></a> @@ -2924,12 +2875,5 @@ rect is equal to copy static SkRect SK_WARN_UNUSED_RESULT MakeLargest() </pre> -Returns constructed <a href="#SkRect">SkRect</a> setting left and top to most negative finite value, and -setting right and bottom to most positive finite value. - -### Return Value - -bounds (<a href="undocumented#SK_ScalarMin">SK ScalarMin</a>, <a href="undocumented#SK_ScalarMin">SK ScalarMin</a>, <a href="undocumented#SK_ScalarMax">SK ScalarMax</a>, <a href="undocumented#SK_ScalarMax">SK ScalarMax</a>) - --- diff --git a/site/user/api/SkSurface_Reference.md b/site/user/api/SkSurface_Reference.md index 1195fd886b..e5419b3367 100644 --- a/site/user/api/SkSurface_Reference.md +++ b/site/user/api/SkSurface_Reference.md @@ -5,13 +5,14 @@ SkSurface Reference ## <a name="Overview"></a> Overview -## <a name="Subtopics"></a> Subtopics +## <a name="Subtopic"></a> Subtopic | 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 | +| Constant | enum and enum class, const values | +| <a href="#Constructor">Constructor</a> | functions that construct <a href="SkSurface_Reference#SkSurface">SkSurface</a> | +| <a href="#Member_Function">Member Function</a> | static functions and member methods | +| <a href="#Related_Function">Related Function</a> | similar methods grouped together | # <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 @@ -21,23 +22,14 @@ 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="Constructors"></a> Constructors +## <a name="Related_Function"></a> Related 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 | -| <a href="#SkSurface_MakeNull">MakeNull</a> | creates <a href="#Surface">Surface</a> without backing pixels | -| <a href="#SkSurface_MakeRaster">MakeRaster</a> | creates <a href="#Surface">Surface</a> from <a href="SkImageInfo_Reference#SkImageInfo">SkImageInfo</a> | -| <a href="#SkSurface_MakeRasterDirect">MakeRasterDirect</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_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="#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 href="#Miscellaneous">Miscellaneous</a> | other functions | +| <a href="#Pixels">Pixels</a> | functions with pixel access | -## <a name="Member_Functions"></a> Member Functions +## <a name="Member_Function"></a> Member Function | name | description | | --- | --- | @@ -50,7 +42,7 @@ 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="#SkSurface_characterize">characterize</a> | sets <a href="#Characterization">Surface Characterization</a> for threaded pre-processing | +| <a href="#SkSurface_characterize">characterize</a> | sets <a href="#Characterization">Surface Characterization</a> for threaded GPU processing | | <a href="#SkSurface_draw">draw</a> | draws <a href="#Surface">Surface</a> contents to canvas | | <a href="#SkSurface_flush">flush</a> | resolve pending I/O | | <a href="#SkSurface_flushAndSignalSemaphores">flushAndSignalSemaphores</a> | resolve pending I/O, and signal | @@ -63,12 +55,33 @@ of the requested dimensions are zero, then nullptr will be returned. | <a href="#SkSurface_makeSurface">makeSurface</a> | creates a compatible <a href="#Surface">Surface</a> | | <a href="#SkSurface_notifyContentWillChange">notifyContentWillChange</a> | notifies that contents will be changed outside of Skia | | <a href="#SkSurface_peekPixels">peekPixels</a> | copies <a href="#Surface">Surface</a> parameters to <a href="SkPixmap_Reference#Pixmap">Pixmap</a> | -| <a href="#SkSurface_prepareForExternalIO">prepareForExternalIO</a> | to be deprecated | | <a href="#SkSurface_props">props</a> | returns <a href="#Properties">Surface Properties</a> | | <a href="#SkSurface_readPixels">readPixels</a> | copies <a href="SkRect_Reference#Rect">Rect</a> of pixels | | <a href="#SkSurface_wait">wait</a> | rause commands until signaled | | <a href="#SkSurface_width">width</a> | returns pixel column count | +## <a name="Constructor"></a> Constructor + +| name | description | +| --- | --- | +| <a href="#SkSurface_MakeFromBackendRenderTarget">MakeFromBackendRenderTarget</a> | creates <a href="#Surface">Surface</a> from GPU memory buffer | +| | <a href="#SkSurface_MakeFromBackendRenderTarget">MakeFromBackendRenderTarget</a> | +| <a href="#SkSurface_MakeFromBackendTexture">MakeFromBackendTexture</a> | creates <a href="#Surface">Surface</a> from GPU-backed texture | +| | <a href="#SkSurface_MakeFromBackendTexture">MakeFromBackendTexture</a> | +| <a href="#SkSurface_MakeFromBackendTextureAsRenderTarget">MakeFromBackendTextureAsRenderTarget</a> | creates <a href="#Surface">Surface</a> from GPU-backed texture | +| | <a href="#SkSurface_MakeFromBackendTextureAsRenderTarget">MakeFromBackendTextureAsRenderTarget</a> | +| <a href="#SkSurface_MakeNull">MakeNull</a> | creates <a href="#Surface">Surface</a> without backing pixels | +| <a href="#SkSurface_MakeRaster">MakeRaster</a> | creates <a href="#Surface">Surface</a> from <a href="SkImageInfo_Reference#SkImageInfo">SkImageInfo</a> | +| | <a href="#SkSurface_MakeRaster">MakeRaster</a> | +| <a href="#SkSurface_MakeRasterDirect">MakeRasterDirect</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_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="#SkSurface_MakeRenderTarget">MakeRenderTarget</a> | +| | <a href="#SkSurface_MakeRenderTarget">MakeRenderTarget</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="SkSurface_MakeRasterDirect"></a> ## MakeRasterDirect @@ -87,7 +100,7 @@ info contains <a href="SkImageInfo_Reference#Color_Type">Color Type</a> and <a h <a href="#SkSurface_MakeRasterDirect_rowBytes">rowBytes</a> is large enough to contain info width <a href="#SkSurface_MakeRasterDirect_pixels">pixels</a> of <a href="SkImageInfo_Reference#Color_Type">Color Type</a>. <a href="undocumented#Pixel">Pixel</a> buffer size should be info height times computed <a href="#SkSurface_MakeRasterDirect_rowBytes">rowBytes</a>. -Pixels are not initialized. +<a href="#Pixels">Pixels</a> are not initialized. To access <a href="#SkSurface_MakeRasterDirect_pixels">pixels</a> after drawing, call <a href="#SkSurface_flush">flush</a> or <a href="#SkSurface_peekPixels">peekPixels</a>. ### Parameters @@ -150,7 +163,7 @@ info contains <a href="SkImageInfo_Reference#Color_Type">Color Type</a> and <a h <a href="#SkSurface_MakeRasterDirectReleaseProc_rowBytes">rowBytes</a> is large enough to contain info width <a href="#SkSurface_MakeRasterDirectReleaseProc_pixels">pixels</a> of <a href="SkImageInfo_Reference#Color_Type">Color Type</a>. <a href="undocumented#Pixel">Pixel</a> buffer size should be info height times computed <a href="#SkSurface_MakeRasterDirectReleaseProc_rowBytes">rowBytes</a>. -Pixels are not initialized. +<a href="#Pixels">Pixels</a> are not initialized. To access <a href="#SkSurface_MakeRasterDirectReleaseProc_pixels">pixels</a> after drawing, call <a href="#SkSurface_flush">flush</a> or <a href="#SkSurface_peekPixels">peekPixels</a>. ### Parameters @@ -802,9 +815,9 @@ static sk_sp<SkSurface> MakeRenderTarget(GrContext* context, SkBudgeted bu bool shouldCreateWithMips = false) </pre> -Returns offscreen <a href="#Surface">Surface</a> on GPU indicated by <a href="#SkSurface_MakeRenderTarget_context">context</a>. Allocates memory for +Returns <a href="#Surface">Surface</a> on GPU indicated by <a href="#SkSurface_MakeRenderTarget_context">context</a>. Allocates memory for pixels, based on the width, height, and <a href="SkImageInfo_Reference#Color_Type">Color Type</a> in ImageInfo. <a href="#SkSurface_MakeRenderTarget_budgeted">budgeted</a> -selects whether allocation for offscreen pixels is tracked by <a href="#SkSurface_MakeRenderTarget_context">context</a>. <a href="#SkSurface_MakeRenderTarget_imageInfo">imageInfo</a> +selects whether allocation for pixels is tracked by <a href="#SkSurface_MakeRenderTarget_context">context</a>. <a href="#SkSurface_MakeRenderTarget_imageInfo">imageInfo</a> describes the pixel format in <a href="SkImageInfo_Reference#Color_Type">Color Type</a>, and transparency in <a href="SkImageInfo_Reference#Alpha_Type">Alpha Type</a>, and color matching in <a href="undocumented#Color_Space">Color Space</a>. @@ -815,7 +828,7 @@ maximum supported count. <a href="#SkSurface_MakeRenderTarget_surfaceOrigin">surfaceOrigin</a> pins either the top-left or the bottom-left corner to the origin. -<a href="#SkSurface_MakeRenderTarget_shouldCreateWithMips">shouldCreateWithMips</a> hints that <a href="SkImage_Reference#Image">Image</a> returned by <a href="#SkSurface_makeImageSnapshot">makeImageSnapshot</a> is <a href="undocumented#Mip_Map">Mip Map</a>. +<a href="#SkSurface_MakeRenderTarget_shouldCreateWithMips">shouldCreateWithMips</a> hints that <a href="SkImage_Reference#Image">Image</a> returned by <a href="#SkSurface_makeImageSnapshot">makeImageSnapshot</a> is Mip_Map. If SK_SUPPORT_GPU is defined as zero, has no effect and returns nullptr. @@ -836,7 +849,7 @@ one of: <a href="undocumented#GrSurfaceOrigin">kBottomLeft GrSurfaceOrigin</a>, LCD striping orientation and setting for device independent fonts; may be nullptr</td> </tr> <tr> <td><a name="SkSurface_MakeRenderTarget_shouldCreateWithMips"> <code><strong>shouldCreateWithMips </strong></code> </a></td> <td> -hint that <a href="#Surface">Surface</a> will host <a href="undocumented#Mip_Map">Mip Map</a> images</td> +hint that <a href="#Surface">Surface</a> will host Mip_Map images</td> </tr> </table> @@ -862,9 +875,9 @@ static sk_sp<SkSurface> MakeRenderTarget(GrContext* context, SkBudgeted bu const SkSurfaceProps* props) </pre> -Returns offscreen <a href="#Surface">Surface</a> on GPU indicated by <a href="#SkSurface_MakeRenderTarget_2_context">context</a>. Allocates memory for +Returns <a href="#Surface">Surface</a> on GPU indicated by <a href="#SkSurface_MakeRenderTarget_2_context">context</a>. Allocates memory for pixels, based on the width, height, and <a href="SkImageInfo_Reference#Color_Type">Color Type</a> in ImageInfo. <a href="#SkSurface_MakeRenderTarget_2_budgeted">budgeted</a> -selects whether allocation for offscreen pixels is tracked by <a href="#SkSurface_MakeRenderTarget_2_context">context</a>. <a href="#SkSurface_MakeRenderTarget_2_imageInfo">imageInfo</a> +selects whether allocation for pixels is tracked by <a href="#SkSurface_MakeRenderTarget_2_context">context</a>. <a href="#SkSurface_MakeRenderTarget_2_imageInfo">imageInfo</a> describes the pixel format in <a href="SkImageInfo_Reference#Color_Type">Color Type</a>, and transparency in <a href="SkImageInfo_Reference#Alpha_Type">Alpha Type</a>, and color matching in <a href="undocumented#Color_Space">Color Space</a>. @@ -899,7 +912,7 @@ fonts; may be nullptr</td> ### Example <div><fiddle-embed name="640321e8ecfb3f9329f3bc6e1f02485f" gpu="true" cpu="true"><div>LCD text takes advantage of raster striping to improve resolution. Only one of -the four combinations is correct, depending on whether the monitor's LCD is +the four combinations is correct, depending on whether monitor LCD striping is horizontal or vertical, and whether the order of the stripes is red blue green or red green blue.</div></fiddle-embed></div> @@ -916,9 +929,9 @@ static sk_sp<SkSurface> MakeRenderTarget(GrContext* context, SkBudgeted bu const SkImageInfo& imageInfo) </pre> -Returns offscreen <a href="#Surface">Surface</a> on GPU indicated by <a href="#SkSurface_MakeRenderTarget_3_context">context</a>. Allocates memory for +Returns <a href="#Surface">Surface</a> on GPU indicated by <a href="#SkSurface_MakeRenderTarget_3_context">context</a>. Allocates memory for pixels, based on the width, height, and <a href="SkImageInfo_Reference#Color_Type">Color Type</a> in ImageInfo. <a href="#SkSurface_MakeRenderTarget_3_budgeted">budgeted</a> -selects whether allocation for offscreen pixels is tracked by <a href="#SkSurface_MakeRenderTarget_3_context">context</a>. <a href="#SkSurface_MakeRenderTarget_3_imageInfo">imageInfo</a> +selects whether allocation for pixels is tracked by <a href="#SkSurface_MakeRenderTarget_3_context">context</a>. <a href="#SkSurface_MakeRenderTarget_3_imageInfo">imageInfo</a> describes the pixel format in <a href="SkImageInfo_Reference#Color_Type">Color Type</a>, and transparency in <a href="SkImageInfo_Reference#Alpha_Type">Alpha Type</a>, and color matching in <a href="undocumented#Color_Space">Color Space</a>. @@ -992,6 +1005,18 @@ surf->makeImageSnapshot() == nullptr --- +## <a name="Property"></a> Property + +| name | description | +| --- | --- | +| <a href="#SkSurface_generationID">generationID</a> | returns unique ID | +| <a href="#SkSurface_getCanvas">getCanvas</a> | returns <a href="SkCanvas_Reference#Canvas">Canvas</a> that draws into <a href="#Surface">Surface</a> | +| <a href="#SkSurface_getRenderTargetHandle">getRenderTargetHandle</a> | returns the GPU reference to render target | +| <a href="#SkSurface_getTextureHandle">getTextureHandle</a> | returns the GPU reference to texture | +| <a href="#SkSurface_height">height</a> | returns pixel row count | +| <a href="#SkSurface_props">props</a> | returns <a href="#Properties">Surface Properties</a> | +| <a href="#SkSurface_width">width</a> | returns pixel column count | + <a name="SkSurface_width"></a> ## width @@ -1116,6 +1141,12 @@ enum <a href="#SkSurface_ContentChangeMode">ContentChangeMode</a> { +## <a name="Miscellaneous"></a> Miscellaneous + +| name | description | +| --- | --- | +| <a href="#SkSurface_notifyContentWillChange">notifyContentWillChange</a> | notifies that contents will be changed outside of Skia | + <a name="SkSurface_notifyContentWillChange"></a> ## notifyContentWillChange @@ -1174,16 +1205,13 @@ static const <a href="#SkSurface_BackendHandleAccess">BackendHandleAccess</a> <a <td><a name="SkSurface_kDiscardWrite_BackendHandleAccess"> <code><strong>SkSurface::kDiscardWrite_BackendHandleAccess </strong></code> </a></td><td>2</td><td>Caller must overwrite the entire back-end object.</td> </tr> <tr> - <td><a name="SkSurface_kFlushRead_TextureHandleAccess"> <code><strong>SkSurface::kFlushRead_TextureHandleAccess </strong></code> </a></td><td>0</td><td>Deprecated. -</td> + <td><a name="SkSurface_kFlushRead_TextureHandleAccess"> <code><strong>SkSurface::kFlushRead_TextureHandleAccess </strong></code> </a></td><td>0</td><td></td> </tr> <tr> - <td><a name="SkSurface_kFlushWrite_TextureHandleAccess"> <code><strong>SkSurface::kFlushWrite_TextureHandleAccess </strong></code> </a></td><td>1</td><td>Deprecated. -</td> + <td><a name="SkSurface_kFlushWrite_TextureHandleAccess"> <code><strong>SkSurface::kFlushWrite_TextureHandleAccess </strong></code> </a></td><td>1</td><td></td> </tr> <tr> - <td><a name="SkSurface_kDiscardWrite_TextureHandleAccess"> <code><strong>SkSurface::kDiscardWrite_TextureHandleAccess </strong></code> </a></td><td>2</td><td>Deprecated. -</td> + <td><a name="SkSurface_kDiscardWrite_TextureHandleAccess"> <code><strong>SkSurface::kDiscardWrite_TextureHandleAccess </strong></code> </a></td><td>2</td><td></td> </tr> </table> @@ -1360,6 +1388,17 @@ are not captured. <a href="SkImage_Reference#Image">Image</a> allocation is acco --- +## <a name="Pixels"></a> Pixels + +| name | description | +| --- | --- | +| <a href="#SkSurface_draw">draw</a> | draws <a href="#Surface">Surface</a> contents to canvas | +| | draw | +| <a href="#SkSurface_peekPixels">peekPixels</a> | copies <a href="#Surface">Surface</a> parameters to <a href="SkPixmap_Reference#Pixmap">Pixmap</a> | +| <a href="#SkSurface_readPixels">readPixels</a> | copies <a href="SkRect_Reference#Rect">Rect</a> of pixels | +| | <a href="#SkSurface_readPixels">readPixels</a> | +| | <a href="#SkSurface_readPixels">readPixels</a> | + <a name="SkSurface_draw"></a> ## draw @@ -1444,7 +1483,7 @@ Destination <a href="SkRect_Reference#Rect">Rect</a> corners are (0, 0) and (<a Copies each readable pixel intersecting both rectangles, without scaling, converting to <a href="#SkSurface_readPixels_dst">dst</a>.colorType() and <a href="#SkSurface_readPixels_dst">dst</a>.alphaType() if required. -Pixels are readable when <a href="#Surface">Surface</a> is raster, or backed by a GPU. +<a href="#Pixels">Pixels</a> are readable when <a href="#Surface">Surface</a> is raster, or backed by a GPU. The destination pixel storage must be allocated by the caller. @@ -1500,7 +1539,7 @@ Destination <a href="SkRect_Reference#Rect">Rect</a> corners are (0, 0) and (<a Copies each readable pixel intersecting both rectangles, without scaling, converting to <a href="#SkSurface_readPixels_2_dstInfo">dstInfo</a>.colorType() and <a href="#SkSurface_readPixels_2_dstInfo">dstInfo</a>.alphaType() if required. -Pixels are readable when <a href="#Surface">Surface</a> is raster, or backed by a GPU. +<a href="#Pixels">Pixels</a> are readable when <a href="#Surface">Surface</a> is raster, or backed by a GPU. The destination pixel storage must be allocated by the caller. @@ -1562,7 +1601,7 @@ Destination <a href="SkRect_Reference#Rect">Rect</a> corners are (0, 0) and (bit Copies each readable pixel intersecting both rectangles, without scaling, converting to bitmap.colorType() and bitmap.alphaType() if required. -Pixels are readable when <a href="#Surface">Surface</a> is raster, or backed by a GPU. +<a href="#Pixels">Pixels</a> are readable when <a href="#Surface">Surface</a> is raster, or backed by a GPU. The destination pixel storage must be allocated by the caller. @@ -1644,10 +1683,19 @@ surf.props(): kRGB_H_SkPixelGeometry void prepareForExternalIO() </pre> -To be deprecated. +soon --- +## <a name="Utility"></a> Utility + +| name | description | +| --- | --- | +| <a href="#SkSurface_characterize">characterize</a> | sets <a href="#Characterization">Surface Characterization</a> for threaded GPU processing | +| <a href="#SkSurface_flush">flush</a> | resolve pending I/O | +| <a href="#SkSurface_flushAndSignalSemaphores">flushAndSignalSemaphores</a> | resolve pending I/O, and signal | +| <a href="#SkSurface_wait">wait</a> | rause commands until signaled | + <a name="SkSurface_flush"></a> ## flush @@ -1761,7 +1809,7 @@ bool characterize(SkSurfaceCharacterization* characterization) const </pre> Initializes <a href="#Characterization">Surface Characterization</a> that can be used to perform GPU back-end -pre-processing in a separate thread. Typically this is used to divide drawing +processing in a separate thread. Typically this is used to divide drawing into multiple tiles. DeferredDisplayListRecorder records the drawing commands for each tile. diff --git a/site/user/api/catalog.htm b/site/user/api/catalog.htm index 9157d0da4c..86f5e579ef 100644 --- a/site/user/api/catalog.htm +++ b/site/user/api/catalog.htm @@ -2464,13 +2464,6 @@ "name": "SkPixmap::reset()", "stdout": "width: 25 height: 35 color: kRGBA_8888_SkColorType alpha: kOpaque_SkAlphaType\\nwidth: 0 height: 0 color: kUnknown_SkColorType alpha: kUnknown_SkAlphaType\\n" }, - "SkPixmap_reset_3": { - "code": "void draw(SkCanvas* canvas) {\n const int width = 2;\n const int height = 2;\n uint8_t bytes[] = { 0, 1, 2, 3, 4, 5, 6, 7 };\n SkMask mask;\n mask.fFormat = SkMask::kA8_Format;\n mask.fBounds = {0, 0, width, height};\n mask.fImage = bytes;\n mask.fRowBytes = (width + 7) >> 3;\n SkPixmap pixmap;\n bool success = pixmap.reset(mask);\n SkDebugf(\"success: %s width: %d height: %d\\n\", success ? \"true \" : \"false\",\n pixmap.width(), pixmap.height()); \n mask.fFormat = SkMask::kBW_Format;\n success = pixmap.reset(mask);\n SkDebugf(\"success: %s width: %d height: %d\\n\", success ? \"true \" : \"false\",\n pixmap.width(), pixmap.height());\n}", - "hash": "379761a97bd7a116638a34eb3e80bf0d", - "file": "SkPixmap_Reference", - "name": "SkPixmap::reset_3", - "stdout": "success: true width: 2 height: 2\\nsuccess: false width: 0 height: 0\\n" - }, "SkPixmap_rowBytes": { "code": "void draw(SkCanvas* canvas) {\n SkPixmap badPixmap = {SkImageInfo::MakeA8(4, 4), nullptr, 2};\n SkPixmap okPixmap = {SkImageInfo::MakeA8(4, 4), nullptr, 8};\n for (auto& pixmap : { badPixmap, okPixmap } ) {\n SkDebugf(\"rowBytes: %d minRowBytes: %d\\n\", pixmap.rowBytes(), \n pixmap.info().minRowBytes());\n }\n}", "hash": "da5e1f7f49891d3805a5a6103a000eff", @@ -3637,14 +3630,6 @@ "file": "SkBitmap_Reference", "name": "SkBitmap::getBounds_2" }, - "SkBitmap_installMaskPixels": { - "code": "void draw(SkCanvas* canvas) {\n uint8_t storage[][5] = {{ 0xCA, 0xDA, 0xCA, 0xC9, 0xA3 },\n { 0xAC, 0xA8, 0x89, 0x47, 0x87 },\n { 0x4B, 0x25, 0x25, 0x25, 0x46 },\n { 0x90, 0x81, 0x25, 0x41, 0x33 },\n { 0x75, 0x55, 0x44, 0x20, 0x00 }};\n SkMask mask;\n mask.fImage = storage[0];\n mask.fBounds = SkIRect::MakeWH(5, 5);\n mask.fRowBytes = 5;\n mask.fFormat = SkMask::kA8_Format;\n SkBitmap bitmap;\n bitmap.installMaskPixels(mask);\n canvas->scale(10, 10);\n canvas->drawBitmap(bitmap, 0, 0);\n storage[2][2] = 0xFF;\n bitmap.installMaskPixels(mask);\n canvas->drawBitmap(bitmap, 10, 0);\n}", - "width": 256, - "height": 64, - "hash": "b0456fc063ca467ccecf2105160a3d1d", - "file": "SkBitmap_Reference", - "name": "SkBitmap::installMaskPixels" -}, "SkBitmap_installPixels_2": { "code": "void draw(SkCanvas* canvas) {\n SkRandom random;\n SkBitmap bitmap;\n const int width = 8;\n const int height = 8;\n uint32_t pixels[width * height];\n for (unsigned x = 0; x < width * height; ++x) {\n pixels[x] = random.nextU();\n }\n SkImageInfo info = SkImageInfo::MakeN32(width, height, kUnpremul_SkAlphaType);\n if (bitmap.installPixels(info, pixels, info.minRowBytes())) {\n canvas->scale(32, 32);\n canvas->drawBitmap(bitmap, 0, 0);\n }\n}\n", "width": 256, @@ -4965,22 +4950,6 @@ "file": "SkImageInfo_Reference", "name": "SkImageInfo::width()" }, - "SkImage_DeferredTextureImageUsageParams": { - "code": "void draw(SkCanvas* canvas) {\n // incomplete\n}", - "width": 256, - "height": 256, - "hash": "882e8e0103048009a25cfc20400492f7", - "file": "SkImage_Reference", - "name": "SkImage::DeferredTextureImageUsageParams" -}, - "SkImage_DeferredTextureImageUsageParams_DeferredTextureImageUsageParams": { - "code": "void draw(SkCanvas* canvas) {\n // incomplete\n}", - "width": 256, - "height": 256, - "hash": "882e8e0103048009a25cfc20400492f7", - "file": "SkImage_Reference", - "name": "SkImage::DeferredTextureImageUsageParams::DeferredTextureImageUsageParams" -}, "SkImage_LegacyBitmapMode": { "code": "void draw(SkCanvas* canvas) {\n // incomplete\n}", "width": 256, @@ -5029,14 +4998,6 @@ "file": "SkImage_Reference", "name": "SkImage::MakeFromBitmap" }, - "SkImage_MakeFromDeferredTextureImageData": { - "code": "void draw(SkCanvas* canvas) {\n // incomplete\n}", - "width": 256, - "height": 256, - "hash": "882e8e0103048009a25cfc20400492f7", - "file": "SkImage_Reference", - "name": "SkImage::MakeFromDeferredTextureImageData" -}, "SkImage_MakeFromEncoded": { "code": "void draw(SkCanvas* canvas) {\n int x = 0;\n for (int quality : { 100, 50, 10, 1} ) {\n sk_sp<SkData> encodedData = image->encodeToData(SkEncodedImageFormat::kJPEG, quality);\n sk_sp<SkImage> image = SkImage::MakeFromEncoded(encodedData);\n canvas->drawImage(image, x, 0);\n x += 64;\n }\n}", "width": 256, @@ -5141,14 +5102,6 @@ "file": "SkImage_Reference", "name": "SkImage::encodeToData_2" }, - "SkImage_getDeferredTextureImageData": { - "code": "void draw(SkCanvas* canvas) {\n GrContext* context = canvas->getGrContext();\n if (!context) {\n return;\n }\n sk_sp<GrContextThreadSafeProxy> proxy(context->threadSafeProxy());\n auto params = SkImage::DeferredTextureImageUsageParams(SkMatrix::MakeScale(2, 2),\n kNone_SkFilterQuality, 0);\n SkColorSpace* colorSpace = canvas->imageInfo().colorSpace();\n size_t requiredMemoryInBytes = image->getDeferredTextureImageData(\n *proxy, ¶ms, 1, nullptr, colorSpace);\n std::vector<uint8_t> memory;\n memory.resize(requiredMemoryInBytes);\n image->getDeferredTextureImageData(*proxy, ¶ms, 1, memory.data(), colorSpace);\n sk_sp<SkImage> uploadedEncodedImage = SkImage::MakeFromDeferredTextureImageData(\n context, memory.data(), SkBudgeted::kNo);\n canvas->scale(2, 2);\n canvas->drawImage(uploadedEncodedImage, 10, 10);\n}", - "width": 256, - "height": 256, - "hash": "31d224ac4d22ba60221c565f9a12ad50", - "file": "SkImage_Reference", - "name": "SkImage::getDeferredTextureImageData" -}, "SkImage_getTextureHandle": { "code": "void draw(SkCanvas* canvas) {\n GrContext* context = canvas->getGrContext();\n if (!context) {\n return;\n }\n SkPaint paint;\n paint.setAntiAlias(true);\n SkString str;\n int y = -10;\n for (auto origin : { kTopLeft_GrSurfaceOrigin, kBottomLeft_GrSurfaceOrigin } ) {\n sk_sp<SkImage> srcImage(SkImage::MakeFromTexture(context,\n backEndTexture, origin, kPremul_SkAlphaType, nullptr));\n GrSurfaceOrigin readBackOrigin;\n GrBackendObject readBackHandle = srcImage->getTextureHandle(false, &readBackOrigin);\n str.printf(\"readBackHandle: 0x%x\", readBackHandle);\n canvas->drawString(str, 5, y += 30, paint);\n canvas->drawImage(srcImage, 80, y += 10);\n str.printf(\"origin: k%s_GrSurfaceOrigin\", readBackOrigin ? \"BottomLeft\" : \"TopLeft\");\n canvas->drawString(str, 5, y += srcImage->height() + 10, paint);\n }\n}", "width": 256, diff --git a/site/user/api/usingBookmaker.md b/site/user/api/usingBookmaker.md index d516c1d030..bd76f85f47 100644 --- a/site/user/api/usingBookmaker.md +++ b/site/user/api/usingBookmaker.md @@ -20,12 +20,15 @@ documentation to be deprecated as well. <pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> # void someMethodThatIsNowDeprecated() - #Deprecated -## +##</pre> -## -</pre> +Use + +<pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> +## soon</pre> + +if the change is soon to be deprecated. To regenerate the documentation, follow the <a href="#Installing">Installing</a> and <a href="#Regenerate">Regenerate</a> steps below. |