diff options
author | Cary Clark <caryclark@skia.org> | 2018-04-24 14:25:33 -0400 |
---|---|---|
committer | Skia Commit-Bot <skia-commit-bot@chromium.org> | 2018-04-24 18:32:46 +0000 |
commit | 75acf9f5830cd4f3a45c8221ddde94d7967bfa50 (patch) | |
tree | ef954cb9c8fc88c39e1f99a7dc2302f5b7d8894d /site/user | |
parent | acd456a6203c72d756a3876507951b75dfac2dfb (diff) |
update md files
The generated web files have fallen
slightly behind the bookmaker masters,
so bring them up to date.
TBR=caryclark@google.com
No-Try: true
Docs-Preview: https://skia.org/?cl=123460
Bug: skia:6898
Change-Id: Ia630c923ed8784960e85b4ae6edb661c9113d31b
Reviewed-on: https://skia-review.googlesource.com/123460
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
Diffstat (limited to 'site/user')
-rw-r--r-- | site/user/api/SkImage_Reference.md | 10 | ||||
-rw-r--r-- | site/user/api/SkPaint_Reference.md | 4 | ||||
-rw-r--r-- | site/user/api/SkSurface_Reference.md | 48 | ||||
-rw-r--r-- | site/user/api/catalog.htm | 8 |
4 files changed, 62 insertions, 8 deletions
diff --git a/site/user/api/SkImage_Reference.md b/site/user/api/SkImage_Reference.md index 1dd2c6e358..ecd59f5bbf 100644 --- a/site/user/api/SkImage_Reference.md +++ b/site/user/api/SkImage_Reference.md @@ -535,7 +535,8 @@ created <a href="#Image">Image</a>, or nullptr <pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> static sk_sp<SkImage> MakeCrossContextFromEncoded(GrContext* context, sk_sp<SkData> data, - bool buildMips, SkColorSpace* dstColorSpace) + bool buildMips, SkColorSpace* dstColorSpace, + bool limitToMaxTextureSize = false) </pre> Creates <a href="#Image">Image</a> from encoded <a href="#SkImage_MakeCrossContextFromEncoded_data">data</a>. <a href="#Image">Image</a> is uploaded to GPU back-end using <a href="#SkImage_MakeCrossContextFromEncoded_context">context</a>. @@ -566,6 +567,8 @@ moving resources between contexts. 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> <tr> <td><a name="SkImage_MakeCrossContextFromEncoded_limitToMaxTextureSize"> <code><strong>limitToMaxTextureSize </strong></code> </a></td> <td> +downscale image to GPU maximum texture size, if necessary</td> </tr> </table> @@ -588,7 +591,8 @@ created <a href="#Image">Image</a>, or nullptr <pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> static sk_sp<SkImage> MakeCrossContextFromPixmap(GrContext* context, const SkPixmap& pixmap, - bool buildMips, SkColorSpace* dstColorSpace) + bool buildMips, SkColorSpace* dstColorSpace, + bool limitToMaxTextureSize = false) </pre> Creates <a href="#Image">Image</a> from <a href="#SkImage_MakeCrossContextFromPixmap_pixmap">pixmap</a>. <a href="#Image">Image</a> is uploaded to GPU back-end using <a href="#SkImage_MakeCrossContextFromPixmap_context">context</a>. @@ -619,6 +623,8 @@ Recognized GPU formats vary by platform and GPU back-end. 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> <tr> <td><a name="SkImage_MakeCrossContextFromPixmap_limitToMaxTextureSize"> <code><strong>limitToMaxTextureSize </strong></code> </a></td> <td> +downscale image to GPU maximum texture size, if necessary</td> </tr> </table> diff --git a/site/user/api/SkPaint_Reference.md b/site/user/api/SkPaint_Reference.md index a30e073b27..03fec2bf37 100644 --- a/site/user/api/SkPaint_Reference.md +++ b/site/user/api/SkPaint_Reference.md @@ -760,7 +760,6 @@ paint1 == paint2 <a href="#SkPaint_kEmbeddedBitmapText_Flag">kEmbeddedBitmapText Flag</a> = 0x400, <a href="#SkPaint_kAutoHinting_Flag">kAutoHinting Flag</a> = 0x800, <a href="#SkPaint_kVerticalText_Flag">kVerticalText Flag</a> = 0x1000, - <a href="#SkPaint_kGenA8FromLCD_Flag">kGenA8FromLCD Flag</a> = 0x2000, <a href="#SkPaint_kAllFlags">kAllFlags</a> = 0xFFFF, }; @@ -807,9 +806,6 @@ multiple settings at once. <td><a name="SkPaint_kVerticalText_Flag"> <code><strong>SkPaint::kVerticalText_Flag </strong></code> </a></td><td>0x1000</td><td>mask for setting <a href="#Vertical_Text">Vertical Text</a></td> </tr> <tr> - <td><a name="SkPaint_kGenA8FromLCD_Flag"> <code><strong>SkPaint::kGenA8FromLCD_Flag </strong></code> </a></td><td>0x2000</td><td>not intended for public use</td> - </tr> - <tr> <td><a name="SkPaint_kAllFlags"> <code><strong>SkPaint::kAllFlags </strong></code> </a></td><td>0xFFFF</td><td>mask of all <a href="#Flags">Flags</a>, including private flags and flags reserved for future use</td> </tr> <a href="#Flags">Flags</a> default to all flags clear, disabling the associated feature. diff --git a/site/user/api/SkSurface_Reference.md b/site/user/api/SkSurface_Reference.md index a9c6a916d9..cf9493f8a4 100644 --- a/site/user/api/SkSurface_Reference.md +++ b/site/user/api/SkSurface_Reference.md @@ -52,6 +52,7 @@ of the requested dimensions are zero, then nullptr will be returned. | <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 | | <a href="#SkSurface_height">height</a> | returns pixel row count | | <a href="#SkSurface_makeImageSnapshot">makeImageSnapshot</a> | creates <a href="SkImage_Reference#Image">Image</a> capturing <a href="#Surface">Surface</a> contents | @@ -807,6 +808,7 @@ surf->makeImageSnapshot() == nullptr | <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 | | <a href="#SkSurface_height">height</a> | returns pixel row count | | <a href="#SkSurface_props">props</a> | returns <a href="undocumented#Surface_Properties">Surface Properties</a> | @@ -1023,7 +1025,7 @@ one of: <a href="#SkSurface_kDiscard_ContentChangeMode">kDiscard ContentChangeMo ### See Also -<a href="#SkSurface_getTextureHandle">getTextureHandle</a> +<a href="#SkSurface_getTextureHandle">getTextureHandle</a> <a href="#SkSurface_getRenderTargetHandle">getRenderTargetHandle</a> @@ -1058,7 +1060,49 @@ GPU texture reference ### See Also -<a href="undocumented#GrBackendObject">GrBackendObject</a> <a href="#SkSurface_BackendHandleAccess">BackendHandleAccess</a> +<a href="#SkSurface_getRenderTargetHandle">getRenderTargetHandle</a> <a href="undocumented#GrBackendObject">GrBackendObject</a> <a href="#SkSurface_BackendHandleAccess">BackendHandleAccess</a> + +--- + +<a name="SkSurface_getRenderTargetHandle"></a> +## getRenderTargetHandle + +<pre style="padding: 1em 1em 1em 1em;width: 62.5em; background-color: #f0f0f0"> +bool getRenderTargetHandle(GrBackendObject* backendObject, BackendHandleAccess backendHandleAccess) +</pre> + +Returns true and stores the GPU back-end reference of the render target used +by <a href="#Surface">Surface</a> in <a href="#SkSurface_getRenderTargetHandle_backendObject">backendObject</a>. + +Return false if <a href="#Surface">Surface</a> is not backed by a GPU render target, and leaves +<a href="#SkSurface_getRenderTargetHandle_backendObject">backendObject</a> unchanged. + +The returned render target handle is only valid until the next draw into <a href="#Surface">Surface</a>, +or when <a href="#Surface">Surface</a> is deleted. + +In OpenGL this returns the frame buffer object ID. + +### Parameters + +<table> <tr> <td><a name="SkSurface_getRenderTargetHandle_backendObject"> <code><strong>backendObject </strong></code> </a></td> <td> +GPU intermediate memory buffer</td> + </tr> <tr> <td><a name="SkSurface_getRenderTargetHandle_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 + +true if <a href="#Surface">Surface</a> is backed by GPU texture + +### Example + +<div><fiddle-embed name="dbc6c0e01a177ba03c87c00c32a43148" gpu="true"></fiddle-embed></div> + +### See Also + +<a href="#SkSurface_getTextureHandle">getTextureHandle</a> <a href="undocumented#GrBackendObject">GrBackendObject</a> <a href="#SkSurface_BackendHandleAccess">BackendHandleAccess</a> --- diff --git a/site/user/api/catalog.htm b/site/user/api/catalog.htm index e81a37df5e..c768b74d2a 100644 --- a/site/user/api/catalog.htm +++ b/site/user/api/catalog.htm @@ -7347,6 +7347,14 @@ "file": "SkSurface_Reference", "name": "SkSurface::getCanvas" }, + "SkSurface_getRenderTargetHandle": { + "code": "void draw(SkCanvas* canvas) {\n SkPaint paint;\n paint.setTextSize(32);\n GrContext* context = canvas->getGrContext();\n if (!context) {\n canvas->drawString(\"GPU only!\", 20, 40, paint);\n return;\n }\n sk_sp<SkSurface> gpuSurface = SkSurface::MakeRenderTarget(\n context, SkBudgeted::kYes, SkImageInfo::MakeN32Premul(10, 10));\n GrBackendObject backendObject;\n if (gpuSurface->getRenderTargetHandle(&backendObject, \n SkSurface::kFlushRead_BackendHandleAccess)) {\n SkString str;\n str.printf(\"backendObject=%ld\", backendObject);\n paint.setTextSize(16);\n canvas->drawString(str, 20, 40, paint);\n }\n}", + "width": 256, + "height": 64, + "hash": "dbc6c0e01a177ba03c87c00c32a43148", + "file": "SkSurface_Reference", + "name": "SkSurface::getRenderTargetHandle" +}, "SkSurface_getTextureHandle": { "code": "void draw(SkCanvas* canvas) {\n SkPaint paint;\n paint.setTextSize(32);\n GrContext* context = canvas->getGrContext();\n if (!context) {\n canvas->drawString(\"GPU only!\", 20, 40, paint);\n return;\n }\n sk_sp<SkSurface> gpuSurface = SkSurface::MakeRenderTarget(\n context, SkBudgeted::kYes, SkImageInfo::MakeN32Premul(10, 10));\n GrBackendObject backendObject = gpuSurface->getTextureHandle(\n SkSurface::kFlushRead_BackendHandleAccess);\n if (backendObject) {\n SkString str;\n str.printf(\"backendObject=%08lx\", backendObject);\n paint.setTextSize(16);\n canvas->drawString(str, 20, 40, paint);\n }\n}", "width": 256, |