diff options
author | Update Docs <update-docs@skia.org> | 2018-04-06 06:23:24 +0000 |
---|---|---|
committer | Skia Commit-Bot <skia-commit-bot@chromium.org> | 2018-04-06 06:55:01 +0000 |
commit | 485dc868fff73073a40509186e4e33fbcfb0edd2 (patch) | |
tree | 4eba2d5219287f4edaff974ebfba3ffb1c97f4b3 /site | |
parent | 7768fa17b7956cfb8707af3ffc3ab01cfabf0efe (diff) |
Update markdown files
Automatic commit by the Housekeeper-Nightly-Bookmaker bot.
TBR=update-docs@skia.org
NO_MERGE_BUILDS
Change-Id: I58601f414a25877a85d9aa3c5726ec385ba892ff
Reviewed-on: https://skia-review.googlesource.com/119070
Commit-Queue: Update Docs <update-docs@skia.org>
Reviewed-by: Update Docs <update-docs@skia.org>
Diffstat (limited to 'site')
-rw-r--r-- | site/user/api/SkBitmap_Reference.md | 3 | ||||
-rw-r--r-- | site/user/api/SkPaint_Reference.md | 3 | ||||
-rw-r--r-- | site/user/api/SkSurface_Reference.md | 67 | ||||
-rw-r--r-- | site/user/api/undocumented.md | 13 |
4 files changed, 82 insertions, 4 deletions
diff --git a/site/user/api/SkBitmap_Reference.md b/site/user/api/SkBitmap_Reference.md index c827bdffb9..9c9f7ecf8d 100644 --- a/site/user/api/SkBitmap_Reference.md +++ b/site/user/api/SkBitmap_Reference.md @@ -3643,8 +3643,7 @@ void toString(SkString* str) const; </pre> Creates string representation of <a href="#Bitmap">Bitmap</a>. The representation is read by -internal debugging tools. The interface and implementation may be -suppressed by defining SK_IGNORE_TO_STRING. +internal debugging tools. ### Parameters diff --git a/site/user/api/SkPaint_Reference.md b/site/user/api/SkPaint_Reference.md index cfe356d25c..b5983555e7 100644 --- a/site/user/api/SkPaint_Reference.md +++ b/site/user/api/SkPaint_Reference.md @@ -5149,8 +5149,7 @@ void toString(SkString* str) const </pre> Creates string representation of <a href="#Paint">Paint</a>. The representation is read by -internal debugging tools. The interface and implementation may be -suppressed by defining SK_IGNORE_TO_STRING. +internal debugging tools. ### Parameters diff --git a/site/user/api/SkSurface_Reference.md b/site/user/api/SkSurface_Reference.md index 9cd4ab534c..2b312c25cc 100644 --- a/site/user/api/SkSurface_Reference.md +++ b/site/user/api/SkSurface_Reference.md @@ -49,6 +49,8 @@ of the requested dimensions are zero, then nullptr will be returned. | <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_generationID">generationID</a> | returns unique ID | +| <a href="#SkSurface_getBackendRenderTarget">getBackendRenderTarget</a> | returns the GPU reference to render target | +| <a href="#SkSurface_getBackendTexture">getBackendTexture</a> | returns the GPU reference to texture | | <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 | @@ -803,6 +805,8 @@ surf->makeImageSnapshot() == nullptr | name | description | | --- | --- | | <a href="#SkSurface_generationID">generationID</a> | returns unique ID | +| <a href="#SkSurface_getBackendRenderTarget">getBackendRenderTarget</a> | returns the GPU reference to render target | +| <a href="#SkSurface_getBackendTexture">getBackendTexture</a> | returns the GPU reference to texture | | <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 | @@ -1102,6 +1106,69 @@ true if <a href="#Surface">Surface</a> is backed by GPU texture --- +<a name="SkSurface_getBackendTexture"></a> +## getBackendTexture + +<pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> +GrBackendTexture getBackendTexture(BackendHandleAccess backendHandleAccess) +</pre> + +Retrieves the backend texture. If <a href="#Surface">Surface</a> has no backend texture, an invalid +object is returned. Call <a href="undocumented#GrBackendTexture_isValid">GrBackendTexture::isValid</a> to determine if the result +is valid. + +The returned <a href="undocumented#GrBackendTexture">GrBackendTexture</a> should be discarded if the <a href="#Surface">Surface</a> is drawn to or deleted. + +### Parameters + +<table> <tr> <td><a name="SkSurface_getBackendTexture_backendHandleAccess"> <code><strong>backendHandleAccess </strong></code> </a></td> <td> +one of: <a href="#SkSurface_kFlushRead_BackendHandleAccess">kFlushRead BackendHandleAccess</a>, +<a href="#SkSurface_kFlushWrite_BackendHandleAccess">kFlushWrite BackendHandleAccess</a>, <a href="#SkSurface_kDiscardWrite_BackendHandleAccess">kDiscardWrite BackendHandleAccess</a></td> + </tr> +</table> + +### Return Value + +GPU texture reference; invalid on failure + +### See Also + +<a href="undocumented#GrBackendTexture">GrBackendTexture</a> <a href="#SkSurface_BackendHandleAccess">BackendHandleAccess</a> <a href="#SkSurface_getBackendRenderTarget">getBackendRenderTarget</a> + +--- + +<a name="SkSurface_getBackendRenderTarget"></a> +## getBackendRenderTarget + +<pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> +GrBackendRenderTarget getBackendRenderTarget(BackendHandleAccess backendHandleAccess) +</pre> + +Retrieves the backend render target. If <a href="#Surface">Surface</a> has no backend render target, an invalid +object is returned. Call <a href="undocumented#GrBackendRenderTarget_isValid">GrBackendRenderTarget::isValid</a> to determine if the result +is valid. + +The returned <a href="undocumented#GrBackendRenderTarget">GrBackendRenderTarget</a> should be discarded if the <a href="#Surface">Surface</a> is drawn to +or deleted. + +### Parameters + +<table> <tr> <td><a name="SkSurface_getBackendRenderTarget_backendHandleAccess"> <code><strong>backendHandleAccess </strong></code> </a></td> <td> +one of: <a href="#SkSurface_kFlushRead_BackendHandleAccess">kFlushRead BackendHandleAccess</a>, +<a href="#SkSurface_kFlushWrite_BackendHandleAccess">kFlushWrite BackendHandleAccess</a>, <a href="#SkSurface_kDiscardWrite_BackendHandleAccess">kDiscardWrite BackendHandleAccess</a></td> + </tr> +</table> + +### Return Value + +GPU render target reference; invalid on failure + +### See Also + +<a href="undocumented#GrBackendRenderTarget">GrBackendRenderTarget</a> <a href="#SkSurface_BackendHandleAccess">BackendHandleAccess</a> <a href="#SkSurface_getBackendTexture">getBackendTexture</a> + +--- + <a name="SkSurface_getCanvas"></a> ## getCanvas diff --git a/site/user/api/undocumented.md b/site/user/api/undocumented.md index 8f6d13fc3f..4f1da9b830 100644 --- a/site/user/api/undocumented.md +++ b/site/user/api/undocumented.md @@ -795,6 +795,19 @@ static std::unique_ptr<SkCanvas> MakeCanvas(std::unique_ptr<SkRasterHan # <a name="SkRegion"></a> Class SkRegion +# <a name="RenderTarget"></a> RenderTarget + +# <a name="GrBackendRenderTarget"></a> Class GrBackendRenderTarget + +<a name="GrBackendRenderTarget_isValid"></a> +## isValid + +<pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> +bool isValid() const +</pre> + +--- + # <a name="Render_Target"></a> Render Target # <a name="GrRenderTarget"></a> Class GrRenderTarget |