diff options
Diffstat (limited to 'site/user/api/SkSurface_Reference.md')
| -rw-r--r-- | site/user/api/SkSurface_Reference.md | 29 |
1 files changed, 15 insertions, 14 deletions
diff --git a/site/user/api/SkSurface_Reference.md b/site/user/api/SkSurface_Reference.md index f8b141a20b..1195fd886b 100644 --- a/site/user/api/SkSurface_Reference.md +++ b/site/user/api/SkSurface_Reference.md @@ -3,6 +3,16 @@ SkSurface Reference # <a name="Surface"></a> Surface +## <a name="Overview"></a> Overview + +## <a name="Subtopics"></a> Subtopics + +| name | description | +| --- | --- | +| Constants | enum and enum class, const values | +| <a href="#Constructors">Constructors</a> | functions that construct <a href="SkSurface_Reference#SkSurface">SkSurface</a> | +| <a href="#Member_Functions">Member Functions</a> | static functions and member methods | + # <a name="SkSurface"></a> Class SkSurface <a href="#SkSurface">SkSurface</a> is responsible for managing the pixels that a canvas draws into. The pixels can be allocated either in CPU memory (a raster surface) or on the GPU (a <a href="undocumented#GrRenderTarget">GrRenderTarget</a> surface). @@ -11,19 +21,10 @@ surface-><a href="#SkSurface_getCanvas">getCanvas</a> to use that canvas (but do <a href="#SkSurface">SkSurface</a> always has non-zero dimensions. If there is a request for a new surface, and either of the requested dimensions are zero, then nullptr will be returned. -# <a name="Overview"></a> Overview - -## <a name="Subtopics"></a> Subtopics - -| topics | description | -| --- | --- | -| <a href="#Overview_Constructors">Constructors</a> | functions that construct <a href="SkIPoint16_Reference#SkIPoint16">SkIPoint16</a> | -| <a href="#Overview_Member_Functions">Member Functions</a> | static functions and member methods | - ## <a name="Constructors"></a> Constructors | name | description | -| --- | --- | +| --- | --- | | <a href="#SkSurface_MakeFromBackendRenderTarget">MakeFromBackendRenderTarget</a> | creates <a href="#Surface">Surface</a> from GPU memory buffer | | <a href="#SkSurface_MakeFromBackendTexture">MakeFromBackendTexture</a> | creates <a href="#Surface">Surface</a> from GPU-backed texture | | <a href="#SkSurface_MakeFromBackendTextureAsRenderTarget">MakeFromBackendTextureAsRenderTarget</a> | creates <a href="#Surface">Surface</a> from GPU-backed texture | @@ -33,13 +34,13 @@ of the requested dimensions are zero, then nullptr will be returned. | <a href="#SkSurface_MakeRasterDirectReleaseProc">MakeRasterDirectReleaseProc</a> | creates <a href="#Surface">Surface</a> from <a href="SkImageInfo_Reference#SkImageInfo">SkImageInfo</a> and <a href="#Storage">Pixel Storage</a> | | <a href="#SkSurface_MakeRasterN32Premul">MakeRasterN32Premul</a> | creates <a href="#Surface">Surface</a> from width, height matching output | | <a href="#SkSurface_MakeRenderTarget">MakeRenderTarget</a> | creates <a href="#Surface">Surface</a> pointing to new GPU memory buffer | -| <a href="#SkCanvas_makeSurface">SkCanvas::makeSurface</a> | creates <a href="#Surface">Surface</a> matching <a href="SkCanvas_Reference#Canvas">Canvas</a> <a href="SkImageInfo_Reference#Image_Info">Image Info</a>, <a href="#Properties">Surface Properties</a> | +| <a href="#SkSurface_makeImageSnapshot">makeImageSnapshot</a> | creates <a href="SkImage_Reference#Image">Image</a> capturing <a href="#Surface">Surface</a> contents | | <a href="#SkSurface_makeSurface">makeSurface</a> | creates a compatible <a href="#Surface">Surface</a> | ## <a name="Member_Functions"></a> Member Functions -| description | function | -| --- | --- | +| name | description | +| --- | --- | | <a href="#SkSurface_MakeFromBackendRenderTarget">MakeFromBackendRenderTarget</a> | creates <a href="#Surface">Surface</a> from GPU memory buffer | | <a href="#SkSurface_MakeFromBackendTexture">MakeFromBackendTexture</a> | creates <a href="#Surface">Surface</a> from GPU-backed texture | | <a href="#SkSurface_MakeFromBackendTextureAsRenderTarget">MakeFromBackendTextureAsRenderTarget</a> | creates <a href="#Surface">Surface</a> from GPU-backed texture | @@ -309,7 +310,7 @@ Allocates raster <a href="#Surface">Surface</a>. <a href="SkCanvas_Reference#Can Allocates and zeroes pixel memory. <a href="undocumented#Pixel">Pixel</a> memory size is height times width times four. <a href="undocumented#Pixel">Pixel</a> memory is deleted when <a href="#Surface">Surface</a> is deleted. -Internally, sets <a href="SkImageInfo_Reference#Image_Info">Image Info</a> to width, height, <a href="SkImageInfo_Reference#Native_Color_Type">Native Color Type</a>, and +Internally, sets <a href="SkImageInfo_Reference#Image_Info">Image Info</a> to width, height, <a href="SkImageInfo_Reference#Color_Type">Native Color Type</a>, and <a href="SkImageInfo_Reference#SkAlphaType">kPremul SkAlphaType</a>. <a href="#Surface">Surface</a> is returned if width and height are greater than zero. |