aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/SkSurface_Reference.bmh
diff options
context:
space:
mode:
authorGravatar Cary Clark <caryclark@skia.org>2018-02-01 09:37:32 -0500
committerGravatar Skia Commit-Bot <skia-commit-bot@chromium.org>2018-02-01 15:09:17 +0000
commit08895c48144cedaf81006803afe4a5a2becfdb92 (patch)
tree395b9eece35410bc75115e16a2c6b86e6bf35de8 /docs/SkSurface_Reference.bmh
parent4dab72f60664b50f66cdd1b26a59bfa873e899f7 (diff)
auto table generation
Replace manually entered summary tables with ones that are populated and sorted by bookmaker. This introduces a slight regression for anonymous enums but fixes a lot of bugs and omissions. The format is #Topic somethingTopical #Populate ## where somethingTopical is one of Subtopics, Constructors, Constants, Classes_and_Structs, Members, Member_Functions, and Related_Functions. Fix the bad formatting in SkCanvas reference. The #Error tag was was corrupting the markdown table. Remove the tag and replace it with #NoExample. Next up: revise self-check to know about populated topics. TBR=caryclark@google.com Docs-Preview: https://skia.org/?cl=102080 Bug: skia:6898 Change-Id: Idef5d1c14c740c18a81d6a5106182788dd2a09e1 Reviewed-on: https://skia-review.googlesource.com/102080 Commit-Queue: Cary Clark <caryclark@skia.org> Reviewed-by: Cary Clark <caryclark@skia.org>
Diffstat (limited to 'docs/SkSurface_Reference.bmh')
-rw-r--r--docs/SkSurface_Reference.bmh75
1 files changed, 10 insertions, 65 deletions
diff --git a/docs/SkSurface_Reference.bmh b/docs/SkSurface_Reference.bmh
index cd8e4bcbad..d8123e0983 100644
--- a/docs/SkSurface_Reference.bmh
+++ b/docs/SkSurface_Reference.bmh
@@ -1,6 +1,12 @@
#Topic Surface
#Alias Surface_Reference
+#Subtopic Overview
+ #Subtopic Subtopics
+ #Populate
+ ##
+##
+
#Class SkSurface
SkSurface is responsible for managing the pixels that a canvas draws into. The pixels can be
@@ -10,74 +16,13 @@ surface->getCanvas() to use that canvas (but don't delete it, it is owned by the
SkSurface 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.
-#Topic Overview
-
-#Subtopic Subtopics
-#ToDo manually add subtopics ##
-#Table
-#Legend
-# topics # description ##
-#Legend ##
-# Constructors # functions that construct SkIPoint16 ##
-# Member_Functions # static functions and member methods ##
-#Table ##
-##
-
#Subtopic Constructors
-#Table
-#Legend
-# name # description ##
-#Legend ##
-# MakeFromBackendRenderTarget # creates Surface from GPU memory buffer ##
-# MakeFromBackendTexture # creates Surface from GPU-backed texture ##
-# MakeFromBackendTextureAsRenderTarget # creates Surface from GPU-backed texture ##
-# MakeNull # creates Surface without backing pixels ##
-# MakeRaster # creates Surface from SkImageInfo ##
-# MakeRasterDirect # creates Surface from SkImageInfo and Pixel_Storage ##
-# MakeRasterDirectReleaseProc # creates Surface from SkImageInfo and Pixel_Storage ##
-# MakeRasterN32Premul # creates Surface from width, height matching output ##
-# MakeRenderTarget # creates Surface pointing to new GPU memory buffer ##
-# SkCanvas::makeSurface # creates Surface matching Canvas Image_Info, Surface_Properties ##
-# makeSurface # creates a compatible Surface ##
-#Table ##
-#Subtopic ##
+#Populate
+##
#Subtopic Member_Functions
-#Table
-#Legend
-# description # function ##
-#Legend ##
-# MakeFromBackendRenderTarget # creates Surface from GPU memory buffer ##
-# MakeFromBackendTexture # creates Surface from GPU-backed texture ##
-# MakeFromBackendTextureAsRenderTarget # creates Surface from GPU-backed texture ##
-# MakeNull # creates Surface without backing pixels ##
-# MakeRaster # creates Surface from SkImageInfo ##
-# MakeRasterDirect # creates Surface from SkImageInfo and Pixel_Storage ##
-# MakeRasterDirectReleaseProc # creates Surface from SkImageInfo and Pixel_Storage ##
-# MakeRasterN32Premul # creates Surface from width, height matching output ##
-# MakeRenderTarget # creates Surface pointing to new GPU memory buffer ##
-# characterize() # sets Surface_Characterization for threaded pre-processing ##
-# draw() # draws Surface contents to canvas ##
-# flush() # resolve pending I/O ##
-# flushAndSignalSemaphores # resolve pending I/O, and signal ##
-# generationID # returns unique ID ##
-# getCanvas # returns Canvas that draws into Surface ##
-# getRenderTargetHandle # returns the GPU reference to render target ##
-# getTextureHandle # returns the GPU reference to texture ##
-# height() # returns pixel row count ##
-# makeImageSnapshot # creates Image capturing Surface contents ##
-# makeSurface # creates a compatible Surface ##
-# notifyContentWillChange # notifies that contents will be changed outside of Skia ##
-# peekPixels # copies Surface parameters to Pixmap ##
-# prepareForExternalIO # to be deprecated ##
-# props() # returns Surface_Properties ##
-# readPixels # copies Rect of pixels ##
-# wait() # rause commands until signaled ##
-# width() # returns pixel column count ##
-#Table ##
-#Subtopic ##
-
-#Topic ##
+#Populate
+##
# ------------------------------------------------------------------------------