diff options
| author |  Cary Clark <caryclark@skia.org> | 2018-04-02 08:32:23 -0400 |
|---|---|---|
| committer |  Skia Commit-Bot <skia-commit-bot@chromium.org> | 2018-04-02 12:38:05 +0000 |
| commit | 5ab52f6a38052c2316e8daae6bd51c928d487f3c (patch) | |
| tree | 984fca16eaed5d0ffa13fb02f81b7d6b02e5a9f1 | |
| parent | c6a19f1d044e4e23d3f0a608aa91da55376512bf (diff) | |
fix a couple of minor surface doc changes
Newly added MakeRenderTarget doesn't have
an example yet, so just mark it as such;
and remove the doxygen style comments.
MakeFormBackendRenderTarget was missing
TBR=robertphillips@google.com
Docs-Preview: https://skia.org/?cl=117629
NOTRY=true
Bug: skia:6898
Change-Id: Icf6fb7195503b54c96cbf3a5785c2c4b3c0f9d8d
Reviewed-on: https://skia-review.googlesource.com/117629
Commit-Queue: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
| -rw-r--r-- | docs/SkSurface_Reference.bmh | 10 | ||||
| -rw-r--r-- | site/user/api/SkSurface_Reference.md | 7 |
2 files changed, 7 insertions, 10 deletions
diff --git a/docs/SkSurface_Reference.bmh b/docs/SkSurface_Reference.bmh index e37ac57250..b65d7387e7 100644 --- a/docs/SkSurface_Reference.bmh +++ b/docs/SkSurface_Reference.bmh @@ -412,6 +412,8 @@ If SK_SUPPORT_GPU is defined as zero, has no effect and returns nullptr. SkColorType colorType, sk_sp<SkColorSpace> colorSpace, const SkSurfaceProps* surfaceProps) +#In Constructor +#Line # creates Surface from GPU render target ## Wraps a GPU-backed buffer into Surface. Caller must ensure backendRenderTarget is valid for the lifetime of returned Surface. @@ -718,11 +720,6 @@ Surface bottom-left corner is pinned to the origin. Returns SkSurface on GPU indicated by context that is compatible with the provided characterization. budgeted selects whether allocation for pixels is tracked by context. - @param context GPU context - @param characterization description of the desired SkSurface - @param budgeted one of: SkBudgeted::kNo, SkBudgeted::kYes - @return SkSurface if all parameters are valid; otherwise, nullptr - #Param context GPU_Context ## #Param characterization description of the desired SkSurface ## #Param budgeted one of: SkBudgeted::kNo, SkBudgeted::kYes @@ -730,6 +727,9 @@ characterization. budgeted selects whether allocation for pixels is tracked by c #Return Surface if all parameters are valid; otherwise, nullptr ## +#NoExample +## + #SeeAlso MakeFromBackendRenderTarget MakeFromBackendTextureAsRenderTarget #Method ## diff --git a/site/user/api/SkSurface_Reference.md b/site/user/api/SkSurface_Reference.md index 065d8eb957..b6933c8aa7 100644 --- a/site/user/api/SkSurface_Reference.md +++ b/site/user/api/SkSurface_Reference.md @@ -35,6 +35,7 @@ of the requested dimensions are zero, then nullptr will be returned. | name | description | | --- | --- | +| <a href="#SkSurface_MakeFromBackendRenderTarget">MakeFromBackendRenderTarget</a> | creates <a href="#Surface">Surface</a> from GPU render target | | <a href="#SkSurface_MakeFromBackendTexture">MakeFromBackendTexture</a> | creates <a href="#Surface">Surface</a> from GPU texture | | <a href="#SkSurface_MakeFromBackendTextureAsRenderTarget">MakeFromBackendTextureAsRenderTarget</a> | creates <a href="#Surface">Surface</a> from GPU back-end render target | | <a href="#SkSurface_MakeNull">MakeNull</a> | creates <a href="#Surface">Surface</a> without backing pixels | @@ -66,6 +67,7 @@ of the requested dimensions are zero, then nullptr will be returned. | name | description | | --- | --- | +| <a href="#SkSurface_MakeFromBackendRenderTarget">MakeFromBackendRenderTarget</a> | creates <a href="#Surface">Surface</a> from GPU render target | | <a href="#SkSurface_MakeFromBackendTexture">MakeFromBackendTexture</a> | creates <a href="#Surface">Surface</a> from GPU texture | | <a href="#SkSurface_MakeFromBackendTextureAsRenderTarget">MakeFromBackendTextureAsRenderTarget</a> | creates <a href="#Surface">Surface</a> from GPU back-end render target | | <a href="#SkSurface_MakeNull">MakeNull</a> | creates <a href="#Surface">Surface</a> without backing pixels | @@ -733,11 +735,6 @@ static sk_sp<SkSurface> MakeRenderTarget(GrContext* context, Returns <a href="#SkSurface">SkSurface</a> on GPU indicated by <a href="#SkSurface_MakeRenderTarget_4_context">context</a> that is compatible with the provided <a href="#SkSurface_MakeRenderTarget_4_characterization">characterization</a>. <a href="#SkSurface_MakeRenderTarget_4_budgeted">budgeted</a> selects whether allocation for pixels is tracked by <a href="#SkSurface_MakeRenderTarget_4_context">context</a>. -@param <a href="#SkSurface_MakeRenderTarget_4_context">context</a> GPU <a href="#SkSurface_MakeRenderTarget_4_context">context</a> -@param <a href="#SkSurface_MakeRenderTarget_4_characterization">characterization</a> description of the desired <a href="#SkSurface">SkSurface</a> -@param <a href="#SkSurface_MakeRenderTarget_4_budgeted">budgeted</a> one of: <a href="undocumented#SkBudgeted_kNo">SkBudgeted::kNo</a>, <a href="undocumented#SkBudgeted_kYes">SkBudgeted::kYes</a> -@return <a href="#SkSurface">SkSurface</a> if all parameters are valid; otherwise, nullptr - ### Parameters <table> <tr> <td><a name="SkSurface_MakeRenderTarget_4_context"> <code><strong>context </strong></code> </a></td> <td> |