diff options
| author |  Cary Clark <caryclark@skia.org> | 2018-01-22 07:55:48 -0500 |
|---|---|---|
| committer |  Skia Commit-Bot <skia-commit-bot@chromium.org> | 2018-01-22 14:04:18 +0000 |
| commit | 5081eede67601e5c5c0fc343b787490603e058cc (patch) | |
| tree | 607f095f636eca498e62e14e3c6d760f477052d4 /docs | |
| parent | 8a67c4c2aa4debca84a68fbc25f048ce55118916 (diff) | |
self check and corrections
Add self-checking code that looks to see that overview is populated
and alphabetized. Eventually, this will self-check to see if
methods are collected into subtopics and have reciprocal 'see also'
data.
Standardize phrases so that they don't start with a capital or end
with a period.
Self-check is a work in progress, so it is not yet run by the
bookmaker bots. The self-check should run cleanly, however. To run
it:
./out/skia/bookmaker -b docs -k
The expected output is doc stats. Self-check errors such as missing
methods in the overview would be reported here if there are any.
TBR=caryclark@google.com
Docs-Preview: https://skia.org/?cl=93621
Bug: skia:6898
Change-Id: I8f1f817a7b083b13138ee33d1aa090445e9304c6
Reviewed-on: https://skia-review.googlesource.com/93621
Reviewed-by: Cary Clark <caryclark@skia.org>
Commit-Queue: Cary Clark <caryclark@skia.org>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/SkAutoCanvasRestore_Reference.bmh | 122 | ||||
| -rw-r--r-- | docs/SkBitmap_Reference.bmh | 158 | ||||
| -rw-r--r-- | docs/SkCanvas_Reference.bmh | 295 | ||||
| -rw-r--r-- | docs/SkIPoint16_Reference.bmh | 33 | ||||
| -rw-r--r-- | docs/SkIPoint_Reference.bmh | 50 | ||||
| -rw-r--r-- | docs/SkIRect_Reference.bmh | 119 | ||||
| -rw-r--r-- | docs/SkImage_Reference.bmh | 36 | ||||
| -rw-r--r-- | docs/SkMatrix_Reference.bmh | 14 | ||||
| -rw-r--r-- | docs/SkPaint_Reference.bmh | 344 | ||||
| -rw-r--r-- | docs/SkPath_Reference.bmh | 250 | ||||
| -rw-r--r-- | docs/SkPixmap_Reference.bmh | 95 | ||||
| -rw-r--r-- | docs/SkPoint_Reference.bmh | 15 | ||||
| -rw-r--r-- | docs/SkRect_Reference.bmh | 135 | ||||
| -rw-r--r-- | docs/SkSurface_Reference.bmh | 75 | ||||
| -rw-r--r-- | docs/status.json | 1 |
15 files changed, 987 insertions, 755 deletions
diff --git a/docs/SkAutoCanvasRestore_Reference.bmh b/docs/SkAutoCanvasRestore_Reference.bmh new file mode 100644 index 0000000000..a01aa793c7 --- /dev/null +++ b/docs/SkAutoCanvasRestore_Reference.bmh @@ -0,0 +1,122 @@ +#Topic Automatic_Canvas_Restore + +#Class SkAutoCanvasRestore + +Stack helper class calls SkCanvas::restoreToCount() when SkAutoCanvasRestore +goes out of scope. Use this to guarantee that the canvas is restored to a known +state. + +#Topic Overview + +#Subtopic Subtopics +#ToDo manually add subtopics ## +#Table +#Legend +# name # description ## +#Legend ## +# Constructors # functions that construct SkAutoCanvasRestore ## +# Member_Functions # static functions and member methods ## +#Table ## +#Subtopic ## + +#Subtopic Constructors +#Table +#Legend +# name # description ## +#Legend ## +# SkAutoCanvasRestore(SkCanvas* canvas, bool doSave) # Preserves Canvas save count. ## +# ~SkAutoCanvasRestore() # Restores Canvas to saved state. ## +#Table ## +#Subtopic ## + +#Subtopic Member_Functions +#Table +#Legend +# name # description ## +#Legend ## +# restore() # Restores Canvas to saved state. ## +#Table ## +#Subtopic ## + +#Topic Overview ## + +#Method SkAutoCanvasRestore(SkCanvas* canvas, bool doSave) + +Preserves Canvas save count. Optionally saves Canvas_Clip and Canvas_Matrix. + +#Param canvas Canvas to guard ## +#Param doSave call SkCanvas::save() ## + +#Return utility to restore Canvas state on destructor ## + +#Example +#Height 128 + SkPaint p; + p.setAntiAlias(true); + p.setTextSize(64); + for (SkScalar sx : { -1, 1 } ) { + for (SkScalar sy : { -1, 1 } ) { + SkAutoCanvasRestore autoRestore(canvas, true); + SkMatrix m = SkMatrix::MakeAll(sx, 1, 96, 0, sy, 64, 0, 0, 1); + canvas->concat(m); + canvas->drawString("R", 0, 0, p); + } + } +## + +#SeeAlso SkCanvas::save SkCanvas::restore + +## + +#Method ~SkAutoCanvasRestore() + +Restores Canvas to saved state. Destructor is called when container goes out of +scope. + +#NoExample +## + +#SeeAlso SkCanvas::save SkCanvas::restore + +## + +#Method void restore() + +Restores Canvas to saved state immediately. Subsequent calls and +~SkAutoCanvasRestore have no effect. + +#Example +for (bool callRestore : { false, true } ) { + for (bool saveCanvas : {false, true} ) { + SkAutoCanvasRestore autoRestore(canvas, saveCanvas); + if (!saveCanvas) { + canvas->save(); + } + SkDebugf("saveCanvas: %s before restore: %d\n", + saveCanvas ? "true" : "false", canvas->getSaveCount()); + if (callRestore) autoRestore.restore(); + SkDebugf("saveCanvas: %s after restore: %d\n", + saveCanvas ? "true" : "false", canvas->getSaveCount()); + } +} +SkDebugf("final count: %d\n", canvas->getSaveCount()); +#StdOut +saveCanvas: false before restore: 2 +saveCanvas: false after restore: 2 +saveCanvas: true before restore: 2 +saveCanvas: true after restore: 2 +saveCanvas: false before restore: 2 +saveCanvas: false after restore: 1 +saveCanvas: true before restore: 2 +saveCanvas: true after restore: 1 +final count: 1 +## +## + +#SeeAlso SkCanvas::save SkCanvas::restore + +## + +#Class SkAutoCanvasRestore ## + +#Topic Automatic_Canvas_Restore ## diff --git a/docs/SkBitmap_Reference.bmh b/docs/SkBitmap_Reference.bmh index e9755bf89f..5aae6272a5 100644 --- a/docs/SkBitmap_Reference.bmh +++ b/docs/SkBitmap_Reference.bmh @@ -38,15 +38,19 @@ is useful to position one or more Bitmaps within a shared pixel array. #ToDo manually add subtopics ## #Table #Legend -# topics # description ## +# name # description ## #Legend ## +# Classes_and_Structs # embedded struct and class members ## +# Constructors # functions that construct SkPath ## +# Member_Functions # static functions and member methods ## +# Operators # operator overloading methods ## #Table ## ## -#Subtopic Structs +#Subtopic Classes_and_Structs #Table #Legend -# description # struct ## +# name # description ## #Legend ## # Allocator # ## # HeapAllocator # ## @@ -56,95 +60,95 @@ is useful to position one or more Bitmaps within a shared pixel array. #Subtopic Constructors #Table #Legend -# description # function ## +# name # description ## #Legend ## -# SkBitmap() # Constructs with default values. ## -# SkBitmap(SkBitmap&& src) # Takes ownership of pixels. ## -# SkBitmap(const SkBitmap& src) # Shares ownership of pixels. ## -# ~SkBitmap() # Releases ownership of pixels. ## +# SkBitmap() # constructs with default values ## +# SkBitmap(SkBitmap&& src) # takes ownership of pixels ## +# SkBitmap(const SkBitmap& src) # shares ownership of pixels ## +# ~SkBitmap() # releases ownership of pixels ## #Table ## #Subtopic ## #Subtopic Operators #Table #Legend -# description # function ## +# name # description ## #Legend ## -# SkBitmap& operator=(SkBitmap&& src) # Takes ownership of pixels. ## -# SkBitmap& operator=(const SkBitmap& src) # Shares ownership of pixels. ## +# SkBitmap& operator=(SkBitmap&& src) # takes ownership of pixels ## +# SkBitmap& operator=(const SkBitmap& src) # shares ownership of pixels ## #Table ## #Subtopic ## #Subtopic Member_Functions #Table #Legend -# description # function ## +# name # description ## #Legend ## -# ComputeIsOpaque # Returns true if all pixels are opaque. ## -# allocN32Pixels # Allocates compatible Color_ARGB pixels, or aborts. ## -# allocPixels # Allocates pixels from Image_Info, or aborts. ## -# allocPixelsFlags # Allocates pixels from Image_Info with options, or aborts. ## -# alphaType # Returns Image_Info Alpha_Type. ## -# bounds() # Returns width() and height() as Rectangle. ## -# bytesPerPixel # Returns number of bytes in pixel based on Color_Type. ## -# colorSpace # Returns Image_Info Color_Space. ## -# colorType # Returns Image_Info Color_Type. ## -# computeByteSize # Returns size required for pixels. ## -# dimensions() # Returns width() and height(). ## -# drawsNothing # Returns true if no width(), no height(), or no Pixel_Ref. ## -# empty() # Returns true if Image_Info has zero width() or height(). ## -# erase() # Writes Color to rectangle of pixels. ## -# eraseARGB # Writes Color to pixels. ## -# eraseArea # Deprecated ## -# eraseColor # Writes Color to pixels. ## -# eraseRGB # Deprecated ## -# extractAlpha # Creates Bitmap containing Alpha of pixels. ## -# extractSubset # Creates Bitmap, sharing pixels if possible. ## -# getAddr # Returns readable pixel address as void pointer. ## -# getAddr16 # Returns readable pixel address as 16-bit pointer. ## -# getAddr32 # Returns readable pixel address as 32-bit pointer. ## -# getAddr8 # Returns readable pixel address as 8-bit pointer. ## -# getBounds # Returns width() and height() as Rectangle. ## -# getColor # Returns one pixel as Unpremultiplied Color. ## -# getGenerationID # Returns unique ID. ## -# getPixels # Returns address of pixels. ## -# getSubset # Returns bounds offset by origin. ## -# hasHardwareMipMap # Returns Mip_Map support present; Android only. ## -# height() # Returns pixel row count. ## -# info() # Returns Image_Info. ## -# installMaskPixels # Creates Pixel_Ref from Mask. ## -# installPixels # Creates Pixel_Ref, with optional release function. ## -# isImmutable # Returns true if pixels will not change. ## -# isNull # Returns true if Pixel_Ref is nullptr. ## -# isOpaque # Returns true if Image_Info describes opaque pixels. ## -# isVolatile # Returns true if pixels should not be cached. ## -# notifyPixelsChanged # Marks pixels as changed, altering the unique ID. ## -# peekPixels # Returns Pixmap if possible. ## -# pixelRef # Returns Pixel_Ref, or nullptr. ## -# pixelRefOrigin # Returns offset within Pixel_Ref. ## -# pixmap() # Returns Pixmap. ## -# readPixels # Copies and converts pixels. ## -# readyToDraw # Returns true if address of pixels is not nullptr. ## -# refColorSpace # Returns Image_Info Color_Space. ## -# reset() # Sets to default values, releases pixel ownership. ## -# rowBytes # Returns interval between rows in bytes. ## -# rowBytesAsPixels # Returns interval between rows in pixels. ## -# setAlphaType # Sets Alpha_Type of shared pixels. ## -# setHasHardwareMipMap # Sets Mip_Map support present; Android only. ## -# setImmutable # Marks that pixels will not change. ## -# setInfo # Sets height, width, Color_Type, and so on, releasing pixels. ## -# setIsVolatile # Marks if pixels should not be cached. ## -# setPixelRef # Sets Pixel_Ref and offset. ## -# setPixels # Sets Pixel_Ref without an offset. ## -# shiftPerPixel # Returns bit shift from pixels to bytes. ## -# swap() # Exchanges Bitmap pair. ## -# toString # Converts Bitmap to machine readable form. ## -# tryAllocN32Pixels # Allocates compatible Color_ARGB pixels if possible. ## -# tryAllocPixels # Allocates pixels from Image_Info if possible. ## -# tryAllocPixelsFlags # Allocates pixels from Image_Info with options if possible. ## -# validate() # Asserts if Bitmap is invalid (debug only). ## -# width() # Returns pixel column count. ## -# writePixels # Copies and converts pixels. ## +# ComputeIsOpaque # returns true if all pixels are opaque ## +# allocN32Pixels # allocates compatible Color_ARGB pixels, or aborts ## +# allocPixels # allocates pixels from Image_Info, or aborts ## +# allocPixelsFlags # allocates pixels from Image_Info with options, or aborts ## +# alphaType # returns Image_Info Alpha_Type ## +# bounds() # returns width() and height() as Rectangle ## +# bytesPerPixel # returns number of bytes in pixel based on Color_Type ## +# colorSpace # returns Image_Info Color_Space ## +# colorType # returns Image_Info Color_Type ## +# computeByteSize # returns size required for pixels ## +# dimensions() # returns width() and height() ## +# drawsNothing # returns true if no width(), no height(), or no Pixel_Ref ## +# empty() # returns true if Image_Info has zero width() or height() ## +# erase() # writes Color to rectangle of pixels ## +# eraseARGB # writes Color to pixels ## +# eraseArea # deprecated ## +# eraseColor # writes Color to pixels ## +# eraseRGB # deprecated ## +# extractAlpha # creates Bitmap containing Alpha of pixels ## +# extractSubset # creates Bitmap, sharing pixels if possible ## +# getAddr # returns readable pixel address as void pointer ## +# getAddr16 # returns readable pixel address as 16-bit pointer ## +# getAddr32 # returns readable pixel address as 32-bit pointer ## +# getAddr8 # returns readable pixel address as 8-bit pointer ## +# getBounds # returns width() and height() as Rectangle ## +# getColor # returns one pixel as Unpremultiplied Color ## +# getGenerationID # returns unique ID ## +# getPixels # returns address of pixels ## +# getSubset # returns bounds offset by origin ## +# hasHardwareMipMap # returns Mip_Map support present; Android only ## +# height() # returns pixel row count ## +# info() # returns Image_Info ## +# installMaskPixels # creates Pixel_Ref from Mask ## +# installPixels # creates Pixel_Ref, with optional release function ## +# isImmutable # returns true if pixels will not change ## +# isNull # returns true if Pixel_Ref is nullptr ## +# isOpaque # returns true if Image_Info describes opaque pixels ## +# isVolatile # returns true if pixels should not be cached ## +# notifyPixelsChanged # marks pixels as changed, altering the unique ID ## +# peekPixels # returns Pixmap if possible ## +# pixelRef # returns Pixel_Ref, or nullptr ## +# pixelRefOrigin # returns offset within Pixel_Ref ## +# pixmap() # returns Pixmap ## +# readPixels # copies and converts pixels ## +# readyToDraw # returns true if address of pixels is not nullptr ## +# refColorSpace # returns Image_Info Color_Space ## +# reset() # sets to default values, releases pixel ownership ## +# rowBytes # returns interval between rows in bytes ## +# rowBytesAsPixels # returns interval between rows in pixels ## +# setAlphaType # sets Alpha_Type of shared pixels ## +# setHasHardwareMipMap # sets Mip_Map support present; Android only ## +# setImmutable # marks that pixels will not change ## +# setInfo # sets height, width, Color_Type, and so on, releasing pixels ## +# setIsVolatile # marks if pixels should not be cached ## +# setPixelRef # sets Pixel_Ref and offset ## +# setPixels # sets Pixel_Ref without an offset ## +# shiftPerPixel # returns bit shift from pixels to bytes ## +# swap() # exchanges Bitmap pair ## +# toString # converts Bitmap to machine readable form ## +# tryAllocN32Pixels # allocates compatible Color_ARGB pixels if possible ## +# tryAllocPixels # allocates pixels from Image_Info if possible ## +# tryAllocPixelsFlags # allocates pixels from Image_Info with options if possible ## +# validate() # asserts if Bitmap is invalid (debug only) ## +# width() # returns pixel column count ## +# writePixels # copies and converts pixels ## #Table ## #Subtopic ## diff --git a/docs/SkCanvas_Reference.bmh b/docs/SkCanvas_Reference.bmh index 24e1e0a41b..4463ea6b3a 100644 --- a/docs/SkCanvas_Reference.bmh +++ b/docs/SkCanvas_Reference.bmh @@ -29,31 +29,35 @@ This approach may be deprecated in the future. #Subtopic Subtopics #Table #Legend -# topics # description ## +# name # description ## #Legend ## -#ToDo generate a TOC here ## +# Classes_and_Structs # embedded struct and class members ## +# Constants # enum and enum class, const values ## +# Constructors # functions that construct SkPath ## +# Member_Functions # static functions and member methods ## +# Operators # operator overloading methods ## #Table ## #Subtopic ## #Subtopic Constants #Table #Legend -# constants # description ## +# name # description ## #Legend ## -# Lattice::Flags # Controls Lattice transparency. ## -# PointMode # Sets drawPoints options. ## -# SaveLayerFlags # Sets SaveLayerRec options. ## -# SrcRectConstraint # Sets drawImageRect options. ## +# Lattice::Flags # controls Lattice transparency ## +# PointMode # sets drawPoints options ## +# SaveLayerFlags # sets SaveLayerRec options ## +# SrcRectConstraint # sets drawImageRect options ## #Table ## #Subtopic ## -#Subtopic Structs +#Subtopic Classes_and_Structs #Table #Legend -# struct # description ## +# name # description ## #Legend ## -# Lattice # Divides Bitmap, Image into a rectangular grid. ## -# SaveLayerRec # Contains state to create Layer. ## +# Lattice # divides Bitmap, Image into a rectangular grid ## +# SaveLayerRec # contains state to create Layer ## #Table ## #Subtopic ## @@ -64,103 +68,105 @@ when no Surface is required, and some helpers implicitly create Raster_Surface. #Table #Legend -# # description ## +# name # description ## #Legend ## -# SkCanvas() # No Surface, no dimensions. ## -# SkCanvas(int width, int height, const SkSurfaceProps* props = nullptr) # No Surface, set dimensions, Surface_Properties. ## -# SkCanvas(SkBaseDevice* device) # Existing Device. (SkBaseDevice is private.) ## -# SkCanvas(const SkBitmap& bitmap) # Uses existing Bitmap. ## -# SkCanvas(const SkBitmap& bitmap, const SkSurfaceProps& props) # Uses existing Bitmap and Surface_Properties. ## -# MakeRasterDirect # Creates from SkImageInfo and Pixel_Storage. ## -# MakeRasterDirectN32 # Creates from image data and Pixel_Storage. ## +# MakeRasterDirect # creates from SkImageInfo and Pixel_Storage ## +# MakeRasterDirectN32 # creates from image data and Pixel_Storage ## +# SkCanvas() # creates with no Surface, no dimensions ## +# SkCanvas(SkBaseDevice* device) # to be deprecated ## +# SkCanvas(const SkBitmap& bitmap) # uses existing Bitmap ## +# SkCanvas(const SkBitmap& bitmap, ColorBehavior behavior) # Android framework only ## +# SkCanvas(const SkBitmap& bitmap, const SkSurfaceProps& props) # uses existing Bitmap and Surface_Properties ## +# SkCanvas(int width, int height, const SkSurfaceProps* props = nullptr) # no Surface, set dimensions, Surface_Properties ## +# ~SkCanvas() # draws saved Layers, frees resources ## #Table ## #Subtopic ## #Subtopic Member_Functions #Table #Legend -# function # description ## +# name # description ## #Legend ## -# accessTopLayerPixels # Returns writable pixel access if available. ## -# accessTopRasterHandle # Returns context that tracks Clip and Matrix. ## -# clear() # Fills Clip with Color. ## -# clipPath # Combines Clip with Path. ## -# clipRRect # Combines Clip with Round_Rect. ## -# clipRect # Combines Clip with Rect. ## -# clipRegion # Combines Clip with Region. ## -# concat() # Multiplies Matrix by Matrix. ## -# discard() # Makes Canvas contents undefined. ## -# drawAnnotation # Associates a Rect with a key-value pair.## -# drawArc # Draws Arc using Clip, Matrix, and Paint.## -# drawAtlas # Draws sprites using Clip, Matrix, and Paint.## -# drawBitmap # Draws Bitmap at (x, y) position. ## -# drawBitmapLattice # Draws proportionally stretched Bitmap. ## -# drawBitmapNine # Draws Nine_Patch Bitmap. ## -# drawBitmapRect # Draws Bitmap, source Rect to destination Rect. ## -# drawCircle # Draws Circle using Clip, Matrix, and Paint. ## -# drawColor # Fills Clip with Color and Blend_Mode. ## -# drawDRRect # Draws double Round_Rect stroked or filled. ## -# drawDrawable # Draws Drawable, encapsulated drawing commands. ## -# drawIRect # Draws IRect using Clip, Matrix, and Paint. ## -# drawImage # Draws Image at (x, y) position. ## -# drawImageLattice # Draws proportionally stretched Image. ## -# drawImageNine # Draws Nine_Patch Image. ## -# drawImageRect # Draws Image, source Rect to destination Rect. ## -# drawLine # Draws line segment between two points.## -# drawOval # Draws Oval using Clip, Matrix, and Paint. ## -# drawPaint # Fills Clip with Paint. ## -# drawPatch # Draws Coons_Patch. ## -# drawPath # Draws Path using Clip, Matrix, and Paint. ## -# drawPicture # Draws Picture using Clip and Matrix. ## -# drawPoint # Draws point at (x, y) position. ## -# drawPoints # Draws array as points, lines, polygon. ## -# drawPosText # Draws text at array of (x, y) positions. ## -# drawPosTextH # Draws text at x positions with common baseline. ## -# drawRRect # Draws Round_Rect using Clip, Matrix, and Paint. ## -# drawRect # Draws Rect using Clip, Matrix, and Paint. ## -# drawRegion # Draws Region using Clip, Matrix, and Paint. ## -# drawRoundRect # Draws Round_Rect using Clip, Matrix, and Paint. ## -# drawText # Draws text at (x, y), using font advance. ## -# drawTextBlob # Draws text with arrays of positions and Paint. ## -# drawTextOnPath # Draws text following Path contour. ## -# drawTextOnPathHV # Draws text following Path with offsets. ## -# drawTextRSXform # Draws text with array of RSXform. ## -# drawString # Draws null terminated string at (x, y) using font advance. ## -# drawVertices # Draws Vertices, a triangle mesh. ## -# flush() # Triggers execution of all pending draw operations. ## -# getBaseLayerSize # Gets size of base Layer in global coordinates. ## -# getDeviceClipBounds # Returns IRect bounds of Clip. ## -# getDrawFilter # Legacy; to be deprecated. ## -# getGrContext # Returns GPU_Context of the GPU_Surface. ## -# getLocalClipBounds # Returns Clip bounds in source coordinates. ## -# getMetaData # Associates additional data with the canvas. ## -# getProps # Copies Surface_Properties if available. ## -# getSaveCount # Returns depth of stack containing Clip and Matrix. ## -# getTotalMatrix # Returns Matrix. ## -# imageInfo # Returns Image_Info for Canvas. ## -# isClipEmpty # Returns if Clip is empty. ## -# isClipRect # Returns if Clip is Rect and not empty. ## -# MakeRasterDirect # Creates Canvas from SkImageInfo and pixel data. ## -# MakeRasterDirectN32 # Creates Canvas from image specifications and pixel data. ## -# makeSurface # Creates Surface matching SkImageInfo and SkSurfaceProps. ## -# peekPixels # Returns if Canvas has direct access to its pixels. ## -# quickReject # Returns if Rect is outside Clip. ## -# readPixels # Copies and converts rectangle of pixels from Canvas. ## -# resetMatrix # Resets Matrix to identity. ## -# restore() # Restores changes to Clip and Matrix, pops save stack. ## -# restoreToCount # Restores changes to Clip and Matrix to given depth. ## -# rotate() # Rotates Matrix. ## -# save() # Saves Clip and Matrix on stack. ## -# saveLayer # Saves Clip and Matrix on stack; creates Layer. ## -# saveLayerAlpha # Saves Clip and Matrix on stack; creates Layer; sets opacity. ## -# saveLayerPreserveLCDTextRequests # Saves Clip and Matrix on stack; creates Layer for LCD text. ## -# scale() # Scales Matrix. ## -# setAllowSimplifyClip # Experimental. ## -# setDrawFilter # Legacy; to be deprecated. ## -# setMatrix # Sets Matrix. ## -# skew() # Skews Matrix. # -# translate() # Translates Matrix. ## -# writePixels # Copies and converts rectangle of pixels to Canvas. ## +# MakeRasterDirect # creates Canvas from SkImageInfo and pixel data ## +# MakeRasterDirectN32 # creates Canvas from image specifications and pixel data ## +# accessTopLayerPixels # returns writable pixel access if available ## +# accessTopRasterHandle # returns context that tracks Clip and Matrix ## +# clear() # fills Clip with Color ## +# clipPath # combines Clip with Path ## +# clipRRect # combines Clip with Round_Rect ## +# clipRect # combines Clip with Rect ## +# clipRegion # combines Clip with Region ## +# concat() # multiplies Matrix by Matrix ## +# discard() # makes Canvas contents undefined ## +# drawAnnotation # associates a Rect with a key-value pair ## +# drawArc # draws Arc using Clip, Matrix, and Paint ## +# drawAtlas # draws sprites using Clip, Matrix, and Paint ## +# drawBitmap # draws Bitmap at (x, y) position ## +# drawBitmapLattice # draws proportionally stretched Bitmap ## +# drawBitmapNine # draws Nine_Patch Bitmap ## +# drawBitmapRect # draws Bitmap, source Rect to destination Rect ## +# drawCircle # draws Circle using Clip, Matrix, and Paint ## +# drawColor # fills Clip with Color and Blend_Mode ## +# drawDRRect # draws double Round_Rect stroked or filled ## +# drawDrawable # draws Drawable, encapsulated drawing commands ## +# drawIRect # draws IRect using Clip, Matrix, and Paint ## +# drawImage # draws Image at (x, y) position ## +# drawImageLattice # draws proportionally stretched Image ## +# drawImageNine # draws Nine_Patch Image ## +# drawImageRect # draws Image, source Rect to destination Rect ## +# drawLine # draws line segment between two points ## +# drawOval # draws Oval using Clip, Matrix, and Paint ## +# drawPaint # fills Clip with Paint ## +# drawPatch # draws Coons_Patch ## +# drawPath # draws Path using Clip, Matrix, and Paint ## +# drawPicture # draws Picture using Clip and Matrix ## +# drawPoint # draws point at (x, y) position ## +# drawPoints # draws array as points, lines, polygon ## +# drawPosText # draws text at array of (x, y) positions ## +# drawPosTextH # draws text at x positions with common baseline ## +# drawRRect # draws Round_Rect using Clip, Matrix, and Paint ## +# drawRect # draws Rect using Clip, Matrix, and Paint ## +# drawRegion # draws Region using Clip, Matrix, and Paint ## +# drawRoundRect # draws Round_Rect using Clip, Matrix, and Paint ## +# drawString # draws null terminated string at (x, y) using font advance ## +# drawText # draws text at (x, y), using font advance ## +# drawTextBlob # draws text with arrays of positions and Paint ## +# drawTextOnPath # draws text following Path contour ## +# drawTextOnPathHV # draws text following Path with offsets ## +# drawTextRSXform # draws text with array of RSXform ## +# drawVertices # draws Vertices, a triangle mesh ## +# flush() # triggers execution of all pending draw operations ## +# getBaseLayerSize # returns size of base Layer in global coordinates ## +# getDeviceClipBounds # returns IRect bounds of Clip ## +# getDrawFilter # legacy; to be deprecated ## +# getGrContext # returns GPU_Context of the GPU_Surface ## +# getLocalClipBounds # returns Clip bounds in source coordinates ## +# getMetaData # associates additional data with the canvas ## +# getProps # copies Surface_Properties if available ## +# getSaveCount # returns depth of stack containing Clip and Matrix ## +# getTotalMatrix # returns Matrix ## +# imageInfo # returns Image_Info for Canvas ## +# isClipEmpty # returns if Clip is empty ## +# isClipRect # returns if Clip is Rect and not empty ## +# makeSurface # creates Surface matching SkImageInfo and SkSurfaceProps ## +# peekPixels # returns if Canvas has direct access to its pixels ## +# quickReject # returns if Rect is outside Clip ## +# readPixels # copies and converts rectangle of pixels from Canvas ## +# resetMatrix # resets Matrix to identity ## +# restore() # restores changes to Clip and Matrix, pops save stack ## +# restoreToCount # restores changes to Clip and Matrix to given depth ## +# rotate() # rotates Matrix ## +# save() # saves Clip and Matrix on stack ## +# saveLayer # saves Clip and Matrix on stack; creates Layer ## +# saveLayerAlpha # saves Clip and Matrix on stack; creates Layer; sets opacity ## +# saveLayerPreserveLCDTextRequests # saves Clip and Matrix on stack; creates Layer for LCD text ## +# scale() # scales Matrix ## +# setAllowSimplifyClip # experimental ## +# setDrawFilter # legacy; to be deprecated ## +# setMatrix # sets Matrix ## +# skew() # skews Matrix. # +# translate() # translates Matrix ## +# writePixels # copies and converts rectangle of pixels to Canvas ## #Table ## #Subtopic ## @@ -584,8 +590,8 @@ The actual output depends on the installed fonts. #Method virtual ~SkCanvas() -Draw saved Layers, if any. -Free up resources used by Canvas. +Draws saved Layers, if any. +Frees up resources used by Canvas. #Example #Description @@ -6165,89 +6171,4 @@ Returns false if the clip is empty, or if it is not Rect. #Class SkCanvas ## -#Class SkAutoCanvasRestore - -Stack helper class calls SkCanvas::restoreToCount() when SkAutoCanvasRestore -goes out of scope. Use this to guarantee that the canvas is restored to a known -state. - -#Method SkAutoCanvasRestore(SkCanvas* canvas, bool doSave) - -Preserves Canvas save count. Optionally saves Canvas Clip and Matrix. - -#Param canvas Canvas to guard ## -#Param doSave call SkCanvas::save() ## - -#Return utility to restore Canvas state on destructor ## - -#Example -#Height 128 - SkPaint p; - p.setAntiAlias(true); - p.setTextSize(64); - for (SkScalar sx : { -1, 1 } ) { - for (SkScalar sy : { -1, 1 } ) { - SkAutoCanvasRestore autoRestore(canvas, true); - SkMatrix m = SkMatrix::MakeAll(sx, 1, 96, 0, sy, 64, 0, 0, 1); - canvas->concat(m); - canvas->drawString("R", 0, 0, p); - } - } -## - -#SeeAlso SkCanvas::save SkCanvas::restore - -## - -#Method ~SkAutoCanvasRestore() - -Restores Canvas to saved state. Destructor is called when container goes out of -scope. - -#NoExample -## - -#SeeAlso SkCanvas::save SkCanvas::restore - -## - -#Method void restore() - -Restores Canvas to saved state immediately. Subsequent calls and -~SkAutoCanvasRestore have no effect. - -#Example -for (bool callRestore : { false, true } ) { - for (bool saveCanvas : {false, true} ) { - SkAutoCanvasRestore autoRestore(canvas, saveCanvas); - if (!saveCanvas) { - canvas->save(); - } - SkDebugf("saveCanvas: %s before restore: %d\n", - saveCanvas ? "true" : "false", canvas->getSaveCount()); - if (callRestore) autoRestore.restore(); - SkDebugf("saveCanvas: %s after restore: %d\n", - saveCanvas ? "true" : "false", canvas->getSaveCount()); - } -} -SkDebugf("final count: %d\n", canvas->getSaveCount()); -#StdOut -saveCanvas: false before restore: 2 -saveCanvas: false after restore: 2 -saveCanvas: true before restore: 2 -saveCanvas: true after restore: 2 -saveCanvas: false before restore: 2 -saveCanvas: false after restore: 1 -saveCanvas: true before restore: 2 -saveCanvas: true after restore: 1 -final count: 1 -## -## - -#SeeAlso SkCanvas::save SkCanvas::restore - -## - -#Class SkAutoCanvasRestore ## - #Topic Canvas ## diff --git a/docs/SkIPoint16_Reference.bmh b/docs/SkIPoint16_Reference.bmh index b5c3cfee99..4f3d53b28b 100644 --- a/docs/SkIPoint16_Reference.bmh +++ b/docs/SkIPoint16_Reference.bmh @@ -3,7 +3,7 @@ #Struct SkIPoint16 -SkIPoint holds two 16 bit integer coordinates +SkIPoint holds two 16 bit integer coordinates. #Topic Overview @@ -11,31 +11,42 @@ SkIPoint holds two 16 bit integer coordinates #ToDo manually add subtopics ## #Table #Legend -# topics # description ## +# name # description ## #Legend ## +# Constructors # functions that construct SkIPoint16 ## +# Member_Functions # static functions and member methods ## #Table ## -## +#Subtopic ## + +#Subtopic Constructors +#Table +#Legend +# name # description ## +#Legend ## +# Make # constructs from integer inputs ## +#Table ## +#Subtopic ## #Subtopic Member_Functions #Table #Legend -# description # function ## +# name # description ## #Legend ## -# Make # Constructs from integer inputs. ## -# set() # Sets to integer input. ## -# x() # Returns fX. ## -# y() # Returns fY. ## +# Make # constructs from integer inputs ## +# set() # sets to integer input ## +# x() # returns fX ## +# y() # returns fY ## #Table ## #Subtopic ## -#Topic ## +#Topic Overview ## #Member int16_t fX -x-axis value used by IPoint16. +x-axis value used by IPoint16 ## #Member int16_t fY -y-axis value used by IPoint16. +y-axis value used by IPoint16 ## # ------------------------------------------------------------------------------ diff --git a/docs/SkIPoint_Reference.bmh b/docs/SkIPoint_Reference.bmh index ed37167a12..3a431dee10 100644 --- a/docs/SkIPoint_Reference.bmh +++ b/docs/SkIPoint_Reference.bmh @@ -4,7 +4,7 @@ #Struct SkIPoint -SkIPoint holds two 32 bit integer coordinates +SkIPoint holds two 32 bit integer coordinates. #Topic Overview @@ -12,41 +12,53 @@ SkIPoint holds two 32 bit integer coordinates #ToDo manually add subtopics ## #Table #Legend -# topics # description ## +# name # description ## #Legend ## +# Constructors # functions that construct SkIPoint16 ## +# Member_Functions # static functions and member methods ## +# Operators # operator overloading methods ## #Table ## -## +#Subtopic ## + +#Subtopic Constructors +#Table +#Legend +# name # description ## +#Legend ## +# Make # constructs from integer inputs ## +#Table ## +#Subtopic ## #Subtopic Operators #Table #Legend -# description # function ## +# name # description ## #Legend ## -# SkIPoint operator-()_const # Reverses sign of IPoint. ## -# SkIPoint operator+(const SkIPoint& a, const SkIVector& b) # Returns IPoint offset by IVector. ## -# SkIVector operator-(const SkIPoint& a, const SkIPoint& b) # Returns IVector between IPoints. ## -# bool operator!=(const SkIPoint& a, const SkIPoint& b) # Returns true if IPoints are unequal. ## -# bool operator==(const SkIPoint& a, const SkIPoint& b) # Returns true if IPoints are equal. ## -# void operator+=(const SkIVector& v) # Adds IVector to IPoint. ## -# void operator-=(const SkIVector& v) # Subtracts IVector from IPoint. ## +# SkIPoint operator+(const SkIPoint& a, const SkIVector& b) # returns IPoint offset by IVector ## +# SkIPoint operator-()_const # reverses sign of IPoint ## +# SkIVector operator-(const SkIPoint& a, const SkIPoint& b) # returns IVector between IPoints ## +# bool operator!=(const SkIPoint& a, const SkIPoint& b) # returns true if IPoints are unequal ## +# bool operator==(const SkIPoint& a, const SkIPoint& b) # returns true if IPoints are equal ## +# void operator+=(const SkIVector& v) # adds IVector to IPoint ## +# void operator-=(const SkIVector& v) # subtracts IVector from IPoint ## #Table ## #Subtopic ## #Subtopic Member_Functions #Table #Legend -# description # function ## +# name # description ## #Legend ## -# Make # Constructs from integer inputs. ## -# equals() # Returns true if members are equal. ## -# isZero # Returns true if both members equal zero. ## -# set() # Sets to integer input. ## -# x() # Returns fX. ## -# y() # Returns fY. ## +# Make # constructs from integer inputs ## +# equals() # returns true if members are equal ## +# isZero # returns true if both members equal zero ## +# set() # sets to integer input ## +# x() # returns fX ## +# y() # returns fY ## #Table ## #Subtopic ## -#Topic ## +#Topic Overview ## #Member int32_t fX x-axis value used by IPoint. diff --git a/docs/SkIRect_Reference.bmh b/docs/SkIRect_Reference.bmh index 708ac56551..eb0a3c06b0 100644 --- a/docs/SkIRect_Reference.bmh +++ b/docs/SkIRect_Reference.bmh @@ -12,72 +12,93 @@ its top, it is considered empty. #Topic Overview #Subtopic Subtopics -#ToDo manually add subtopics ## #Table #Legend -# topics # description ## +# name # description ## #Legend ## +# Constructors # list of functions that construct SkPath ## +# Member_Functions # list of static functions and member methods ## +# Operators # operator overloading methods ## #Table ## ## +#Subtopic Constructors +#Table +#Legend +# name # description ## +#Legend ## +# MakeEmpty # returns bounds of (0, 0, 0, 0) ## +# MakeLTRB # constructs from int left, top, right, bottom ## +# MakeLargest # deprecated ## +# MakeSize # constructs from ISize returning (0, 0, width, height) ## +# MakeWH # constructs from int input returning (0, 0, width, height) ## +# MakeXYWH # constructs from int input returning (x, y, width, height) ## +# makeInset # constructs from sides moved symmetrically about the center ## +# makeOffset # constructs from translated sides ## +# makeOutset # constructs from sides moved symmetrically about the center ## +# makeSorted # constructs, ordering sides from smaller to larger ## +#Table ## +#Subtopic ## + #Subtopic Operators #Table #Legend -# description # function ## +# name # description ## #Legend ## -# bool operator!=(const SkIRect& a, const SkIRect& b) # Returns true if members are unequal. ## -# bool operator==(const SkIRect& a, const SkIRect& b) # Returns true if members are equal. ## +# bool operator!=(const SkIRect& a, const SkIRect& b) # returns true if members are unequal ## +# bool operator==(const SkIRect& a, const SkIRect& b) # returns true if members are equal ## #Table ## #Subtopic ## #Subtopic Member_Functions #Table #Legend -# description # function ## +# name # description ## #Legend ## -# EmptyIRect # Returns immutable bounds of (0, 0, 0, 0). ## -# Intersects # Returns true if areas overlap. ## -# IntersectsNoEmptyCheck # Returns true if areas overlap. Skips empty check. ## -# MakeEmpty # Returns bounds of (0, 0, 0, 0). ## -# MakeLTRB # Constructs from int left, top, right, bottom. ## -# MakeSize # Constructs from ISize returning (0, 0, width, height). ## -# MakeWH # Constructs from int input returning (0, 0, width, height). ## -# MakeXYWH # Constructs from int input returning (x, y, width, height). ## -# bottom() # Returns larger bounds in y, if sorted. ## -# centerX # Returns midpoint in x. ## -# centerY # Returns midpoint in y. ## -# contains() # Returns true if points are equal or inside. ## -# containsNoEmptyCheck # Returns true if points are equal or inside. Skips empty check. ## -# height() # Returns span in y. ## -# height64() # Returns span in y as int64_t. ## -# inset() # Moves the sides symmetrically about the center. ## -# intersect # Sets to shared area; returns true if not empty. ## -# intersectNoEmptyCheck # Sets to shared area; returns true if not empty. Skips empty check. ## -# is16Bit # Returns true if members fit in 16-bit word. ## -# isEmpty # Returns true if width or height are zero or negative or they exceed int32_t. ## -# isEmpty64 # Returns true if width or height are zero or negative. ## -# join() # Sets to union of bounds. ## -# left() # Returns smaller bounds in x, if sorted. ## -# makeInset # Constructs from sides moved symmetrically about the center. ## -# makeOffset # Constructs from translated sides. ## -# makeOutset # Constructs from sides moved symmetrically about the center. ## -# makeSorted # Constructs, ordering sides from smaller to larger. ## -# offset() # Translates sides without changing width and height. ## -# offsetTo # Translates to (x, y) without changing width and height. ## -# outset() # Moves the sides symmetrically about the center. ## -# quickReject # Returns true if rectangles do not intersect. ## -# right() # Returns larger bounds in x, if sorted. ## -# set() # Sets to (left, top, right, bottom). ## -# setEmpty # Sets to (0, 0, 0, 0). ## -# setLTRB # Sets to SkScalar input (left, top, right, bottom). ## -# setXYWH # Sets to (x, y, width, height). ## -# size() # Returns ISize (width, height). ## -# sort() # Orders sides from smaller to larger. ## -# top() # Returns smaller bounds in y, if sorted. ## -# width() # Returns span in x. ## -# width64() # Returns span in y as int64_t. ## -# x() # Returns bounds left. ## -# y() # Returns bounds top. ## +# EmptyIRect # returns immutable bounds of (0, 0, 0, 0) ## +# Intersects # returns true if areas overlap ## +# IntersectsNoEmptyCheck # returns true if areas overlap skips empty check ## +# MakeEmpty # returns bounds of (0, 0, 0, 0) ## +# MakeLTRB # constructs from int left, top, right, bottom ## +# MakeLargest # deprecated ## +# MakeSize # constructs from ISize returning (0, 0, width, height) ## +# MakeWH # constructs from int input returning (0, 0, width, height) ## +# MakeXYWH # constructs from int input returning (x, y, width, height) ## +# bottom() # returns larger bounds in y, if sorted ## +# centerX # returns midpoint in x ## +# centerY # returns midpoint in y ## +# contains() # returns true if points are equal or inside ## +# containsNoEmptyCheck # returns true if points are equal or inside skips empty check ## +# height() # returns span in y ## +# height64 # returns span in y as int64_t ## +# inset() # moves the sides symmetrically about the center ## +# intersect # sets to shared area; returns true if not empty ## +# intersectNoEmptyCheck # sets to shared area; returns true if not empty skips empty check ## +# is16Bit # returns true if members fit in 16-bit word ## +# isEmpty # returns true if width or height are zero or negative or they exceed int32_t ## +# isEmpty64 # returns true if width or height are zero or negative ## +# join() # sets to union of bounds ## +# left() # returns smaller bounds in x, if sorted ## +# makeInset # constructs from sides moved symmetrically about the center ## +# makeOffset # constructs from translated sides ## +# makeOutset # constructs from sides moved symmetrically about the center ## +# makeSorted # constructs, ordering sides from smaller to larger ## +# offset() # translates sides without changing width and height ## +# offsetTo # translates to (x, y) without changing width and height ## +# outset() # moves the sides symmetrically about the center ## +# quickReject # returns true if rectangles do not intersect ## +# right() # returns larger bounds in x, if sorted ## +# set() # sets to (left, top, right, bottom) ## +# setEmpty # sets to (0, 0, 0, 0) ## +# setLTRB # sets to SkScalar input (left, top, right, bottom) ## +# setXYWH # sets to (x, y, width, height) ## +# size() # returns ISize (width, height) ## +# sort() # orders sides from smaller to larger ## +# top() # returns smaller bounds in y, if sorted ## +# width() # returns span in x ## +# width64 # returns span in y as int64_t ## +# x() # returns bounds left ## +# y() # returns bounds top ## #Table ## #Subtopic ## diff --git a/docs/SkImage_Reference.bmh b/docs/SkImage_Reference.bmh index ffcd6fe60a..a0e29c2ff5 100644 --- a/docs/SkImage_Reference.bmh +++ b/docs/SkImage_Reference.bmh @@ -49,6 +49,37 @@ drawing. #Table ## ## +#Subtopic Constructors +#Table +#Legend +# name # description ## +#Legend ## +# MakeBackendTextureFromSkImage # Creates GPU_Texture from Image. ## +# MakeCrossContextFromEncoded # Creates Image from encoded data, and uploads to GPU. ## +# MakeCrossContextFromPixmap # Creates Image from Pixmap, and uploads to GPU. ## +# MakeFromAHardwareBuffer # Creates Image from Android hardware buffer. ## +# MakeFromAdoptedTexture # Creates Image from GPU_Texture, managed internally. ## +# MakeFromBitmap # Creates Image from Bitmap, sharing or copying pixels. ## +# MakeFromDeferredTextureImageData # To be deprecated. ## +# MakeFromEncoded # Creates Image from encoded data. ## +# MakeFromGenerator # Creates Image from a stream of data. ## +# MakeFromNV12TexturesCopy # Creates Image from YUV_ColorSpace data in two planes. ## +# MakeFromPicture # Creates Image from Picture. ## +# MakeFromRaster # Creates Image from Pixmap, with release. ## +# MakeFromTexture # Creates Image from GPU_Texture, managed externally. ## +# MakeFromYUVTexturesCopy # Creates Image from YUV_ColorSpace data in three planes. ## +# MakeRasterCopy # Creates Image from Pixmap and copied pixels. ## +# MakeRasterData # Creates Image from Image_Info and shared pixels. ## +# SkSurface::makeImageSnapshot # Creates Image capturing Surface contents. ## +# makeColorSpace # Creates Image matching Color_Space if possible. ## +# makeNonTextureImage # Creates Image without dependency on GPU_Texture. ## +# makeRasterImage # Creates Image compatible with Raster_Surface if possible. ## +# makeSubset # Creates Image containing part of original. ## +# makeTextureImage # Creates Image matching Color_Space if possible. ## +# makeWithFilter # Creates filtered, clipped Image. ## +#Table ## +#Subtopic ## + #Subtopic Member_Functions #Table #Legend @@ -56,10 +87,11 @@ drawing. #Legend ## # MakeBackendTextureFromSkImage # Creates GPU_Texture from Image. ## # MakeCrossContextFromEncoded # Creates Image from encoded data, and uploads to GPU. ## +# MakeCrossContextFromPixmap # Creates Image from Pixmap, and uploads to GPU. ## # MakeFromAHardwareBuffer # Creates Image from Android hardware buffer. ## # MakeFromAdoptedTexture # Creates Image from GPU_Texture, managed internally. ## # MakeFromBitmap # Creates Image from Bitmap, sharing or copying pixels. ## -# MakeFromDeferredTextureImageData # ## +# MakeFromDeferredTextureImageData # To be deprecated. ## # MakeFromEncoded # Creates Image from encoded data. ## # MakeFromGenerator # Creates Image from a stream of data. ## # MakeFromNV12TexturesCopy # Creates Image from YUV_ColorSpace data in two planes. ## @@ -75,7 +107,7 @@ drawing. # colorSpace # Returns Color_Space. ## # dimensions() # Returns width() and height(). ## # encodeToData # Returns encoded Image as SkData. ## -# getDeferredTextureImageData # ## +# getDeferredTextureImageData # To be deprecated. ## # getTexture # Deprecated. ## # getTextureHandle # Returns GPU reference to Image as texture. ## # height() # Returns pixel row count. ## diff --git a/docs/SkMatrix_Reference.bmh b/docs/SkMatrix_Reference.bmh index cd49206454..d348acb441 100644 --- a/docs/SkMatrix_Reference.bmh +++ b/docs/SkMatrix_Reference.bmh @@ -27,6 +27,18 @@ improve performance. Matrix is not thread safe unless getType is called first. #Table ## ## +#Subtopic Constructors +#Table +#Legend +# name # description ## +#Legend ## +# MakeAll # Constructs all nine values. ## +# MakeRectToRect # Constructs from source Rect to destination Rect. ## +# MakeScale # Constructs from scale in x and y. ## +# MakeTrans # Constructs from translate in x and y. ## +#Table ## +#Subtopic ## + #Subtopic Operators #Table #Legend @@ -34,8 +46,8 @@ improve performance. Matrix is not thread safe unless getType is called first. #Legend ## # operator!=(const SkMatrix& a, const SkMatrix& b) # Returns true if members are unequal. ## # operator==(const SkMatrix& a, const SkMatrix& b) # Returns true if members are equal. ## -# operator[](int index)_const # Returns Matrix value. ## # operator[](int index) # Returns writable reference to Matrix value. ## +# operator[](int index)_const # Returns Matrix value. ## #Table ## #Subtopic ## diff --git a/docs/SkPaint_Reference.bmh b/docs/SkPaint_Reference.bmh index 31031e76fa..801df43109 100644 --- a/docs/SkPaint_Reference.bmh +++ b/docs/SkPaint_Reference.bmh @@ -32,208 +32,220 @@ Shader attached to Paint. #Topic Overview #Subtopic Subtopics -#ToDo not all methods are in topics ## -#ToDo subtopics are not in topics ## #Table #Legend -# topics # description ## +# name # description ## #Legend ## -# Initializers # Constructors and initialization. ## -# Destructor # Paint termination. ## -# Management # Paint copying, moving, comparing. ## -# Hinting # Glyph outline adjustment. ## -# Flags # Attributes represented by single bits. ## -# Anti-alias # Approximating coverage with transparency. ## -# Dither # Distributing color error. ## -# Device_Text # Increase precision of glyph position. ## -# Font_Embedded_Bitmaps # Custom sized bitmap Glyphs. ## -# Automatic_Hinting # Always adjust glyph paths. ## -# Vertical_Text # Orient text from top to bottom. ## -# Fake_Bold # Approximate font styles. ## -# Full_Hinting_Spacing # Glyph spacing affected by hinting. ## -# Filter_Quality_Methods # Get and set Filter_Quality. ## -# Color_Methods # Get and set Color. ## -# Style # Geometry filling, stroking. ## -# Stroke_Width # Thickness perpendicular to geometry. ## -# Miter_Limit # Maximum length of stroked corners. ## -# Stroke_Cap # Decorations at ends of open strokes. ## -# Stroke_Join # Decoration at corners of strokes. ## -# Fill_Path # Make Path from Path_Effect, stroking. ## -# Shader_Methods # Get and set Shader. ## -# Color_Filter_Methods # Get and set Color_Filter. ## -# Blend_Mode_Methods # Get and set Blend_Mode. ## -# Path_Effect_Methods # Get and set Path_Effect. ## -# Mask_Filter_Methods # Get and set Mask_Filter. ## -# Typeface_Methods # Get and set Typeface. ## -# Image_Filter_Methods # Get and set Image_Filter. ## -# Draw_Looper_Methods # Get and set Draw_Looper. ## -# Text_Align # Text placement relative to position. ## -# Text_Size # Overall height in points. ## -# Text_Scale_X # Text horizontal scale. ## -# Text_Skew_X # Text horizontal slant. ## -# Text_Encoding # Text encoded as characters or Glyphs. ## -# Font_Metrics # Common glyph dimensions. ## -# Measure_Text # Width, height, bounds of text. ## -# Text_Path # Geometry of Glyphs. ## -# Text_Intercepts # Advanced underline, strike through. ## -# Fast_Bounds # Approximate area required by Paint. ## +# Classes_and_Structs # embedded struct and class members ## +# Constants # enum and enum class, const values ## +# Constructors # list of functions that construct SkPath ## +# Member_Functions # list of static functions and member methods ## +# Operators # operator overloading methods ## +# Related_Functions # similar methods grouped together ## +#Table ## +#Subtopic ## + +#Subtopic Related_Functions +#Table +#Legend +# name # description ## +#Legend ## +# Anti-alias # approximating coverage with transparency ## +# Automatic_Hinting # always adjust glyph paths ## +# Blend_Mode_Methods # get and set Blend_Mode ## +# Color_Filter_Methods # get and set Color_Filter ## +# Color_Methods # get and set Color ## +# Destructor # paint termination ## +# Device_Text # increase precision of glyph position ## +# Dither # distributing color error ## +# Draw_Looper_Methods # get and set Draw_Looper ## +# Fake_Bold # approximate font styles ## +# Fast_Bounds # approximate area required by Paint ## +# Fill_Path # make Path from Path_Effect, stroking ## +# Filter_Quality_Methods # get and set Filter_Quality ## +# Flags # attributes represented by single bits ## +# Font_Embedded_Bitmaps # custom sized bitmap Glyphs ## +# Font_Metrics # common glyph dimensions ## +# Full_Hinting_Spacing # glyph spacing affected by hinting ## +# Hinting # glyph outline adjustment ## +# Image_Filter_Methods # get and set Image_Filter ## +# Initializers # constructors and initialization ## +# Management # paint copying, moving, comparing ## +# Mask_Filter_Methods # get and set Mask_Filter ## +# Measure_Text # width, height, bounds of text ## +# Miter_Limit # maximum length of stroked corners ## +# Path_Effect_Methods # get and set Path_Effect ## +# Shader_Methods # get and set Shader ## +# Stroke_Cap # decorations at ends of open strokes ## +# Stroke_Join # decoration at corners of strokes ## +# Stroke_Width # thickness perpendicular to geometry ## +# Style # geometry filling, stroking ## +# Text_Align # text placement relative to position ## +# Text_Encoding # text encoded as characters or Glyphs ## +# Text_Intercepts # advanced underline, strike through ## +# Text_Path # geometry of Glyphs ## +# Text_Scale_X # text horizontal scale ## +# Text_Size # overall height in points ## +# Text_Skew_X # text horizontal slant ## +# Typeface_Methods # get and set Typeface ## +# Vertical_Text # orient text from top to bottom ## #Table ## #Subtopic ## #Subtopic Constants #Table #Legend -# constants # description ## +# name # description ## #Legend ## -# Align # Glyph locations relative to text position. ## -# Cap # Start and end geometry on stroked shapes. ## -# Flags # Values described by bits and masks. ## -# FontMetrics::FontMetricsFlags # Valid Font_Metrics. ## -# Hinting # Level of glyph outline adjustment. ## -# Join # Corner geometry on stroked shapes. ## -# Style # Stroke, fill, or both. ## -# TextEncoding # Character or glyph encoded size. ## +# Align # glyph locations relative to text position ## +# Cap # start and end geometry on stroked shapes ## +# Flags # values described by bits and masks ## +# FontMetrics::FontMetricsFlags # valid Font_Metrics ## +# Hinting # level of glyph outline adjustment ## +# Join # corner geometry on stroked shapes ## +# Style # stroke, fill, or both ## +# TextEncoding # character or glyph encoded size ## #Table ## #Subtopic ## -#Subtopic Structs +#Subtopic Classes_and_Structs #Table #Legend -# struct # description ## +# name # description ## #Legend ## -# FontMetrics # Typeface values. ## +# FontMetrics # typeface values ## #Table ## #Subtopic ## #Subtopic Constructors #Table #Legend -# # description ## +# name # description ## #Legend ## -# SkPaint() # Constructs with default values. ## -# SkPaint(const SkPaint& paint) # Makes a shallow copy. ## -# SkPaint(SkPaint&& paint) # Moves paint without copying it. ## -# ~SkPaint() # Decreases Reference_Count of owned objects. ## +# SkPaint() # constructs with default values ## +# SkPaint(SkPaint&& paint) # moves paint without copying it ## +# SkPaint(const SkPaint& paint) # makes a shallow copy ## +# ~SkPaint() # decreases Reference_Count of owned objects ## #Table ## #Subtopic ## #Subtopic Operators #Table #Legend -# operator # description ## +# name # description ## #Legend ## -# operator=(const SkPaint& paint) # Makes a shallow copy. ## -# operator=(SkPaint&& paint) # Moves paint without copying it. ## -# operator==(const SkPaint& a, const SkPaint& b) # Compares paints for equality. ## -# operator!=(const SkPaint& a, const SkPaint& b) # Compares paints for inequality. ## +# operator!=(const SkPaint& a, const SkPaint& b) # compares paints for inequality ## +# operator=(SkPaint&& paint) # moves paint without copying it ## +# operator=(const SkPaint& paint) # makes a shallow copy ## +# operator==(const SkPaint& a, const SkPaint& b) # compares paints for equality ## #Table ## #Subtopic ## #Subtopic Member_Functions #Table #Legend -# function # description ## +# name # description ## #Legend ## -# breakText # Returns text that fits in a width. ## -# canComputeFastBounds # Returns true if settings allow for fast bounds computation. ## -# computeFastBounds # Returns fill bounds for quick reject tests. ## -# computeFastStrokeBounds # Returns stroke bounds for quick reject tests. ## -# containsText # Returns if all text corresponds to Glyphs. ## -# countText # Returns number of Glyphs in text. ## -# doComputeFastBounds # Returns bounds for quick reject tests. ## -# flatten() # Serializes into a buffer. ## -# getAlpha # Returns Color_Alpha, color opacity. ## -# getBlendMode # Returns Blend_Mode, how colors combine with Device. ## -# getColor # Returns Color_Alpha and Color_RGB, one drawing color. ## -# getColorFilter # Returns Color_Filter, how colors are altered. ## -# getDrawLooper # Returns Draw_Looper, multiple layers. ## -# getFillPath # Returns fill path equivalent to stroke. ## -# getFilterQuality # Returns Filter_Quality, image filtering level. ## -# getFlags # Returns Flags stored in a bit field. ## -# getFontBounds # Returns union all glyph bounds. ## -# getFontMetrics # Returns Typeface metrics scaled by text size. ## -# getFontSpacing # Returns recommended spacing between lines. ## -# getHash # Returns a shallow hash for equality checks. ## -# getHinting # Returns Hinting, glyph outline adjustment level. ## -# getImageFilter # Returns Image_Filter, alter pixels; blur. ## -# getMaskFilter # Returns Mask_Filter, alterations to Mask_Alpha. ## -# getPathEffect # Returns Path_Effect, modifications to path geometry; dashing. ## -# getPosTextPath # Returns Path equivalent to positioned text. ## -# getPosTextIntercepts # Returns where lines intersect positioned text; underlines. ## -# getPosTextHIntercepts # Returns where lines intersect horizontally positioned text; underlines. ## -# getShader # Returns Shader, multiple drawing colors; gradients. ## -# getStrokeCap # Returns Cap, the area drawn at path ends. ## -# getStrokeJoin # Returns Join, geometry on path corners. ## -# getStrokeMiter # Returns Miter_Limit, angles with sharp corners. ## -# getStrokeWidth # Returns thickness of the stroke. ## -# getStyle # Returns Style: stroke, fill, or both. ## -# getTextAlign # Returns Align: left, center, or right. ## -# getTextBlobIntercepts # Returns where lines intersect Text_Blob; underlines. ## -# getTextEncoding # Returns character or glyph encoded size. b ## -# getTextIntercepts # Returns where lines intersect text; underlines. ## -# getTextPath # Returns Path equivalent to text. ## -# getTextScaleX # Returns the text horizontal scale; condensed text. ## -# getTextSkewX # Returns the text horizontal skew; oblique text. ## -# getTextSize # Returns text size in points. ## -# getTextWidths # Returns advance and bounds for each glyph in text. ## -# getTypeface # Returns Typeface, font description. ## -# glyphsToUnichars # Converts Glyphs into text. ## -# isAntiAlias # Returns true if Anti-alias is set. ## -# isAutohinted # Returns true if Glyphs are always hinted. ## -# isDevKernText # Returns true if Full_Hinting_Spacing is set. ## -# isDither # Returns true if Dither is set. ## -# isEmbeddedBitmapText # Returns true if Font_Embedded_Bitmaps is set. ## -# isFakeBoldText # Returns true if Fake_Bold is set. ## -# isLCDRenderText # Returns true if LCD_Text is set. ## -# isSrcOver # Returns true if Blend_Mode is SkBlendMode::kSrcOver. ## -# isSubpixelText # Returns true if Subpixel_Text is set. ## -# isVerticalText # Returns true if Vertical_Text is set. ## -# measureText # Returns advance width and bounds of text. ## -# nothingToDraw # Returns true if Paint prevents all drawing. ## -# refColorFilter # References Color_Filter, how colors are altered. ## -# refDrawLooper # References Draw_Looper, multiple layers. ## -# refImageFilter # References Image_Filter, alter pixels; blur. ## -# refMaskFilter # References Mask_Filter, alterations to Mask_Alpha. ## -# refPathEffect # References Path_Effect, modifications to path geometry; dashing. ## -# refShader # References Shader, multiple drawing colors; gradients. ## -# refTypeface # References Typeface, font description. ## -# reset() # Sets to default values. ## -# setAlpha # Sets Color_Alpha, color opacity. ## -# setAntiAlias # Sets or clears Anti-alias. ## -# setARGB # Sets color by component. ## -# setAutohinted # Sets Glyphs to always be hinted. ## -# setBlendMode # Sets Blend_Mode, how colors combine with destination. ## -# setColor # Sets Color_Alpha and Color_RGB, one drawing color. ## -# setColorFilter # Sets Color_Filter, alters color. ## -# setDevKernText # Sets or clears Full_Hinting_Spacing. ## -# setDither # Sets or clears Dither. ## -# setDrawLooper # Sets Draw_Looper, multiple layers. ## -# setEmbeddedBitmapText # Sets or clears Font_Embedded_Bitmaps. ## -# setFakeBoldText # Sets or clears Fake_Bold. ## -# setFilterQuality # Sets Filter_Quality, the image filtering level. ## -# setFlags # Sets multiple Flags in a bit field. ## -# setHinting # Sets Hinting, glyph outline adjustment level. ## -# setLCDRenderText # Sets or clears LCD_Text. ## -# setMaskFilter # Sets Mask_Filter, alterations to Mask_Alpha. ## -# setPathEffect # Sets Path_Effect, modifications to path geometry; dashing. ## -# setImageFilter # Sets Image_Filter, alter pixels; blur. ## -# setShader # Sets Shader, multiple drawing colors; gradients. ## -# setStrokeCap # Sets Cap, the area drawn at path ends. ## -# setStrokeJoin # Sets Join, geometry on path corners. ## -# setStrokeMiter # Sets Miter_Limit, angles with sharp corners. ## -# setStrokeWidth # Sets thickness of the stroke. ## -# setStyle # Sets Style: stroke, fill, or both. ## -# setSubpixelText # Sets or clears Subpixel_Text. ## -# setTextAlign # Sets Align: left, center, or right. ## -# setTextEncoding # Sets character or glyph encoded size. ## -# setTextScaleX # Sets the text horizontal scale; condensed text. ## -# setTextSkewX # Sets the text horizontal skew; oblique text. ## -# setTextSize # Sets text size in points. ## -# setTypeface # Sets Typeface, font description. ## -# setVerticalText # Sets or clears Vertical_Text. ## -# textToGlyphs # Converts text into glyph indices. ## -# toString # Converts Paint to machine readable form. ## -# unflatten() # Populates from a serialized stream. ## +# breakText # returns text that fits in a width ## +# canComputeFastBounds # returns true if settings allow for fast bounds computation ## +# computeFastBounds # returns fill bounds for quick reject tests ## +# computeFastStrokeBounds # returns stroke bounds for quick reject tests ## +# containsText # returns if all text corresponds to Glyphs ## +# countText # returns number of Glyphs in text ## +# doComputeFastBounds # returns bounds for quick reject tests ## +# flatten() # serializes into a buffer ## +# getAlpha # returns Color_Alpha, color opacity ## +# getBlendMode # returns Blend_Mode, how colors combine with Device ## +# getColor # returns Color_Alpha and Color_RGB, one drawing color ## +# getColorFilter # returns Color_Filter, how colors are altered ## +# getDrawLooper # returns Draw_Looper, multiple layers ## +# getFillPath # returns fill path equivalent to stroke ## +# getFilterQuality # returns Filter_Quality, image filtering level ## +# getFlags # returns Flags stored in a bit field ## +# getFontBounds # returns union all glyph bounds ## +# getFontMetrics # returns Typeface metrics scaled by text size ## +# getFontSpacing # returns recommended spacing between lines ## +# getHash # returns a shallow hash for equality checks ## +# getHinting # returns Hinting, glyph outline adjustment level ## +# getImageFilter # returns Image_Filter, alter pixels; blur ## +# getMaskFilter # returns Mask_Filter, alterations to Mask_Alpha ## +# getPathEffect # returns Path_Effect, modifications to path geometry; dashing ## +# getPosTextHIntercepts # returns where lines intersect horizontally positioned text; underlines ## +# getPosTextIntercepts # returns where lines intersect positioned text; underlines ## +# getPosTextPath # returns Path equivalent to positioned text ## +# getShader # returns Shader, multiple drawing colors; gradients ## +# getStrokeCap # returns Cap, the area drawn at path ends ## +# getStrokeJoin # returns Join, geometry on path corners ## +# getStrokeMiter # returns Miter_Limit, angles with sharp corners ## +# getStrokeWidth # returns thickness of the stroke ## +# getStyle # returns Style: stroke, fill, or both ## +# getTextAlign # returns Align: left, center, or right ## +# getTextBlobIntercepts # returns where lines intersect Text_Blob; underlines ## +# getTextEncoding # returns character or glyph encoded size ## +# getTextIntercepts # returns where lines intersect text; underlines ## +# getTextPath # returns Path equivalent to text ## +# getTextScaleX # returns the text horizontal scale; condensed text ## +# getTextSize # returns text size in points ## +# getTextSkewX # returns the text horizontal skew; oblique text ## +# getTextWidths # returns advance and bounds for each glyph in text ## +# getTypeface # returns Typeface, font description ## +# glyphsToUnichars # converts Glyphs into text ## +# isAntiAlias # returns true if Anti-alias is set ## +# isAutohinted # returns true if Glyphs are always hinted ## +# isDevKernText # returns true if Full_Hinting_Spacing is set ## +# isDither # returns true if Dither is set ## +# isEmbeddedBitmapText # returns true if Font_Embedded_Bitmaps is set ## +# isFakeBoldText # returns true if Fake_Bold is set ## +# isLCDRenderText # returns true if LCD_Text is set ## +# isSrcOver # returns true if Blend_Mode is SkBlendMode::kSrcOver ## +# isSubpixelText # returns true if Subpixel_Text is set ## +# isVerticalText # returns true if Vertical_Text is set ## +# measureText # returns advance width and bounds of text ## +# nothingToDraw # returns true if Paint prevents all drawing ## +# refColorFilter # references Color_Filter, how colors are altered ## +# refDrawLooper # references Draw_Looper, multiple layers ## +# refImageFilter # references Image_Filter, alter pixels; blur ## +# refMaskFilter # references Mask_Filter, alterations to Mask_Alpha ## +# refPathEffect # references Path_Effect, modifications to path geometry; dashing ## +# refShader # references Shader, multiple drawing colors; gradients ## +# refTypeface # references Typeface, font description ## +# reset() # sets to default values ## +# setARGB # sets color by component ## +# setAlpha # sets Color_Alpha, color opacity ## +# setAntiAlias # sets or clears Anti-alias ## +# setAutohinted # sets Glyphs to always be hinted ## +# setBlendMode # sets Blend_Mode, how colors combine with destination ## +# setColor # sets Color_Alpha and Color_RGB, one drawing color ## +# setColorFilter # sets Color_Filter, alters color ## +# setDevKernText # sets or clears Full_Hinting_Spacing ## +# setDither # sets or clears Dither ## +# setDrawLooper # sets Draw_Looper, multiple layers ## +# setEmbeddedBitmapText # sets or clears Font_Embedded_Bitmaps ## +# setFakeBoldText # sets or clears Fake_Bold ## +# setFilterQuality # sets Filter_Quality, the image filtering level ## +# setFlags # sets multiple Flags in a bit field ## +# setHinting # sets Hinting, glyph outline adjustment level ## +# setImageFilter # sets Image_Filter, alter pixels; blur ## +# setLCDRenderText # sets or clears LCD_Text ## +# setMaskFilter # sets Mask_Filter, alterations to Mask_Alpha ## +# setPathEffect # sets Path_Effect, modifications to path geometry; dashing ## +# setShader # sets Shader, multiple drawing colors; gradients ## +# setStrokeCap # sets Cap, the area drawn at path ends ## +# setStrokeJoin # sets Join, geometry on path corners ## +# setStrokeMiter # sets Miter_Limit, angles with sharp corners ## +# setStrokeWidth # sets thickness of the stroke ## +# setStyle # sets Style: stroke, fill, or both ## +# setSubpixelText # sets or clears Subpixel_Text ## +# setTextAlign # sets Align: left, center, or right ## +# setTextEncoding # sets character or glyph encoded size ## +# setTextScaleX # sets the text horizontal scale; condensed text ## +# setTextSize # sets text size in points ## +# setTextSkewX # sets the text horizontal skew; oblique text ## +# setTypeface # sets Typeface, font description ## +# setVerticalText # sets or clears Vertical_Text ## +# textToGlyphs # converts text into glyph indices ## +# toString # converts Paint to machine readable form ## +# unflatten() # populates from a serialized stream ## #Table ## #Subtopic ## @@ -582,7 +594,7 @@ by the client. #Param buffer serialized data describing Paint content ## -#Return false if the buffer contained invalid data for initializing the paint. ## +#Return false if the buffer contains invalid data ## # why is unflatten() public? #Bug 6172 ## diff --git a/docs/SkPath_Reference.bmh b/docs/SkPath_Reference.bmh index 7f77b8b914..17232fd528 100644 --- a/docs/SkPath_Reference.bmh +++ b/docs/SkPath_Reference.bmh @@ -75,25 +75,6 @@ Path contents are never shared. Copying Path by value effectively creates a new Path independent of the original. Internally, the copy does not duplicate its contents until it is edited, to reduce memory use and improve performance. -#Subtopic Subtopics -#ToDo not all methods are in topics ## -#ToDo subtopics are not in topics ## -#Table -#Legend -# topics # description ## -#Legend ## -#Table ## -# Contour # A loop of lines and curves. ## -# Convexity # Whether Path contains simple loop. ## -# Last_Point # Final Point in Contour. ## -# Point_Array # All Points in Path. ## -# Verb # How Points and Contours are defined. ## -# Verb_Array # All Verbs in Path. ## -# Verb # How Points and Contours are defined. ## -# Conic_Weight # Strength of control Point in Conic. ## -#Subtopic ## - - #Subtopic Contour #Alias Contours Contour contains one or more Verbs, and as many Points as @@ -203,134 +184,171 @@ SkPath::updateBoundsCache to make Path thread safe. #Topic Overview +#Subtopic Subtopics +#Table +#Legend +# name # description ## +#Legend ## +# Classes_and_Structs # embedded struct and class members ## +# Constants # enum and enum class, const values ## +# Constructors # functions that construct SkPath ## +# Member_Functions # static functions and member methods ## +# Operators # operator overloading methods ## +# Related_Functions # similar methods grouped together ## +#Table ## +#Subtopic ## + + +#Subtopic Related_Functions +#Table +#Legend +# name # description ## +#Legend ## +# Conic # conic section defined by three points and a weight ## +# Conic_Weight # strength of control Point in Conic ## +# Contour # loop of lines and curves ## +# Convexity # if Path is concave or convex ## +# Cubic_Bezier # third order curve defined by four points ## +# Direction # Path contour orientation ## +# Fill_Type # Path fill rule, normal and inverted ## +# Last_Point # final Point in Contour ## +# Point_Array # end points and control points for lines and curves ## +# Quadratic_Bezier # parabolic section defined by three points ## +# Verb_Array # line and curve type for points ## +# Verbs # Path line and curve type ## +# Zero_Length_Contour # consideration when contour has no length ## +#Table ## +#Subtopic ## + #Subtopic Constants #Table #Legend -# constants # description ## +# name # description ## #Legend ## -# AddPathMode # Sets addPath options. ## -# ArcSize # Used by arcTo(SkScalar rx, SkScalar ry, SkScalar xAxisRotate, ArcSize largeArc, Direction sweep, SkScalar x, SkScalar y).## -# Convexity # Returns if Path is convex or concave. ## -# Direction # Sets Contour clockwise or counterclockwise. ## -# FillType # Sets winding rule and inverse fill. ## -# SegmentMask # Returns Verb types in Path. ## -# Verb # Controls how Path Points are interpreted. ## +# AddPathMode # sets addPath options ## +# ArcSize # used by arcTo variation ## +# Convexity # returns if Path is convex or concave ## +# Direction # sets Contour clockwise or counterclockwise ## +# FillType # sets winding rule and inverse fill ## +# SegmentMask # returns Verb types in Path ## +# Verb # controls how Path Points are interpreted ## #Table ## #Subtopic ## #Subtopic Classes_and_Structs #Table #Legend -# class or struct # description ## +# name # description ## #Legend ## -# Iter # Iterates through lines and curves, skipping degenerates. ## -# RawIter # Iterates through lines and curves, including degenerates. ## +# Iter # iterates through lines and curves, skipping degenerates ## +# RawIter # iterates through lines and curves, including degenerates ## #Table ## #Subtopic ## #Subtopic Constructors #Table #Legend -# # description ## +# name # description ## #Legend ## -# SkPath() # Constructs with default values. ## -# SkPath(const SkPath& path) # Makes a shallow copy. ## -# ~SkPath() # Decreases Reference_Count of owned objects. ## +# SkPath() # constructs with default values ## +# SkPath(const SkPath& path) # makes a shallow copy ## +# ~SkPath() # decreases Reference_Count of owned objects ## #Table ## #Subtopic ## #Subtopic Operators #Table #Legend -# operator # description ## +# name # description ## #Legend ## -# operator=(const SkPath& path) # Makes a shallow copy. ## -# operator==(const SkPath& a, const SkPath& b) # Compares paths for equality. ## -# operator!=(const SkPath& a, const SkPath& b) # Compares paths for inequality. ## +# operator!=(const SkPath& a, const SkPath& b) # compares paths for inequality ## +# operator=(const SkPath& path) # makes a shallow copy ## +# operator==(const SkPath& a, const SkPath& b) # compares paths for equality ## #Table ## #Subtopic ## #Subtopic Member_Functions #Table #Legend -# function # description ## +# name # description ## #Legend ## -# ConvertConicToQuads # Approximates Conic with Quad array. ## -# ConvertToNonInverseFillType # Returns Fill_Type representing inside geometry. ## -# IsCubicDegenerate # Returns if Cubic is very small. ## -# IsInverseFillType # Returns if Fill_Type represents outside geometry. ## -# IsLineDegenerate # Returns if Line is very small. ## -# IsQuadDegenerate # Returns if Quad is very small. ## -# addArc # Adds one Contour containing Arc. ## -# addCircle # Adds one Contour containing Circle. ## -# addOval # Adds one Contour containing Oval. ## -# addPath # Adds contents of Path. ## -# addPoly # Adds one Contour containing connected lines. ## -# addRRect # Adds one Contour containing Round_Rect. ## -# addRect # Adds one Contour containing Rect. ## -# addRoundRect # Adds one Contour containing Round_Rect with common corner radii. ## -# arcTo # Appends Arc. ## -# close() # Makes last Contour a loop. ## -# computeTightBounds # Returns extent of geometry. ## -# conicTo # Appends Conic. ## -# conservativelyContainsRect # Returns true if Rect may be inside. ## -# contains() # Returns if Point is in fill area. ## -# countPoints # Returns Point_Array length. ## -# countVerbs # Returns Verb_Array length. ## -# cubicTo # Appends Cubic. ## -# dump() # Sends text representation using floats to standard output. ## -# dumpHex # Sends text representation using hexadecimal to standard output. ## -# getBounds # Returns maximum and minimum of Point_Array. ## -# getConvexity # Returns geometry convexity, computing if necessary. ## -# getConvexityOrUnknown # Returns geometry convexity if known. ## -# getFillType # Returns Fill_Type: winding, even-odd, inverse. ## -# getGenerationID # Returns unique ID. ## -# getLastPt # Returns Last_Point. ## -# getPoint # Returns entry from Point_Array. ## -# getPoints # Returns Point_Array. ## -# getSegmentMasks # Returns types in Verb_Array. ## -# getVerbs # Returns Verb_Array. ## -# incReserve # Hint to reserve space for additional data. ## -# interpolate() # Interpolates between Path pair. ## -# isConvex # Returns if geometry is convex. ## -# isEmpty # Returns if verb count is zero. ## -# isFinite # Returns if all Point values are finite. ## -# isInterpolatable # Returns if pair contains equal counts of Verb_Array and Weights. ## -# isInverseFillType # Returns if Fill_Type fills outside geometry. ## -# isLastContourClosed # Returns if final Contour forms a loop. ## -# isLine # Returns if describes Line. ## -# isNestedFillRects # Returns if describes Rect pair, one inside the other. ## -# isOval # Returns if describes Oval. ## -# isRRect # Returns if describes Round_Rect. ## -# isRect # Returns if describes Rect. ## -# isValid # Returns if data is internally consistent. ## -# isVolatile # Returns if Device should not cache. ## -# lineTo # Appends Line. ## -# moveTo # Starts Contour. ## -# offset() # Translates Point_Array. ## -# quadTo # Appends Quad. ## -# rArcTo # Appends Arc relative to Last_Point. ## -# rConicTo # Appends Conic relative to Last_Point. ## -# rCubicTo # Appends Cubic relative to Last_Point. ## -# rLineTo # Appends Line relative to Last_Point. ## -# rMoveTo # Starts Contour relative to Last_Point. ## -# rQuadTo # Appends Quad relative to Last_Point. ## -# readFromMemory # Initializes from buffer. ## -# reset() # Removes Verb_Array, Point_Array, and Weights; frees memory. ## -# reverseAddPath # Adds contents of Path back to front. ## -# rewind() # Removes Verb_Array, Point_Array, and Weights; leaves memory allocated. ## -# serialize() # Copies data to buffer. ## -# setConvexity # Sets if geometry is convex to avoid future computation. ## -# setFillType # Sets Fill_Type: winding, even-odd, inverse. ## -# setIsConvex # Deprecated. ## -# setIsVolatile # Sets if Device should not cache. ## -# setLastPt # Replaces Last_Point. ## -# swap() # Exchanges Path pair. ## -# toggleInverseFillType # Toggles Fill_Type between inside and outside geometry. ## -# transform() # Applies Matrix to Point_Array and Weights. ## -# unique() # Returns if data has single owner. ## -# updateBoundsCache # Refreshes result of getBounds. ## -# writeToMemory # Copies data to buffer. ## +# ConvertConicToQuads # approximates Conic with Quad array ## +# ConvertToNonInverseFillType # returns Fill_Type representing inside geometry ## +# IsCubicDegenerate # returns if Cubic is very small ## +# IsInverseFillType # returns if Fill_Type represents outside geometry ## +# IsLineDegenerate # returns if Line is very small ## +# IsQuadDegenerate # returns if Quad is very small ## +# addArc # adds one Contour containing Arc ## +# addCircle # adds one Contour containing Circle ## +# addOval # adds one Contour containing Oval ## +# addPath # adds contents of Path ## +# addPoly # adds one Contour containing connected lines ## +# addRRect # adds one Contour containing Round_Rect ## +# addRect # adds one Contour containing Rect ## +# addRoundRect # adds one Contour containing Round_Rect with common corner radii ## +# arcTo # appends Arc ## +# close() # makes last Contour a loop ## +# computeTightBounds # returns extent of geometry ## +# conicTo # appends Conic ## +# conservativelyContainsRect # returns true if Rect may be inside ## +# contains() # returns if Point is in fill area ## +# countPoints # returns Point_Array length ## +# countVerbs # returns Verb_Array length ## +# cubicTo # appends Cubic ## +# dump() # sends text representation using floats to standard output ## +# dumpHex # sends text representation using hexadecimal to standard output ## +# getBounds # returns maximum and minimum of Point_Array ## +# getConvexity # returns geometry convexity, computing if necessary ## +# getConvexityOrUnknown # returns geometry convexity if known ## +# getFillType # returns Fill_Type: winding, even-odd, inverse ## +# getGenerationID # returns unique ID ## +# getLastPt # returns Last_Point ## +# getPoint # returns entry from Point_Array ## +# getPoints # returns Point_Array ## +# getSegmentMasks # returns types in Verb_Array ## +# getVerbs # returns Verb_Array ## +# incReserve # reserves space for additional data ## +# interpolate() # interpolates between Path pair ## +# isConvex # returns if geometry is convex ## +# isEmpty # returns if verb count is zero ## +# isFinite # returns if all Point values are finite ## +# isInterpolatable # returns if pair contains equal counts of Verb_Array and Weights ## +# isInverseFillType # returns if Fill_Type fills outside geometry ## +# isLastContourClosed # returns if final Contour forms a loop ## +# isLine # returns if describes Line ## +# isNestedFillRects # returns if describes Rect pair, one inside the other ## +# isOval # returns if describes Oval ## +# isRRect # returns if describes Round_Rect ## +# isRect # returns if describes Rect ## +# isValid # returns if data is internally consistent ## +# isVolatile # returns if Device should not cache ## +# lineTo # appends Line ## +# moveTo # starts Contour ## +# offset() # translates Point_Array ## +# pathRefIsValid # to be deprecated ## +# quadTo # appends Quad ## +# rArcTo # appends Arc relative to Last_Point ## +# rConicTo # appends Conic relative to Last_Point ## +# rCubicTo # appends Cubic relative to Last_Point ## +# rLineTo # appends Line relative to Last_Point ## +# rMoveTo # starts Contour relative to Last_Point ## +# rQuadTo # appends Quad relative to Last_Point ## +# readFromMemory # Initializes from buffer ## +# reset() # removes Verb_Array, Point_Array, and Weights; frees memory ## +# reverseAddPath # adds contents of Path back to front ## +# rewind() # removes Verb_Array, Point_Array, and Weights, keeping memory ## +# serialize() # copies data to buffer ## +# setConvexity # sets if geometry is convex to avoid future computation ## +# setFillType # sets Fill_Type: winding, even-odd, inverse ## +# setIsConvex # deprecated ## +# setIsVolatile # sets if Device should not cache ## +# setLastPt # replaces Last_Point ## +# swap() # exchanges Path pair ## +# toggleInverseFillType # toggles Fill_Type between inside and outside geometry ## +# transform() # applies Matrix to Point_Array and Weights ## +# unique() # returns if data has single owner ## +# updateBoundsCache # refreshes result of getBounds ## +# writeToMemory # copies data to buffer ## #Table ## #Subtopic Path_Member_Functions ## #Topic Overview ## @@ -3050,7 +3068,7 @@ constructions are converted to Conic data when added to Path. #List # <sup>1</sup> arcTo(const SkRect& oval, SkScalar startAngle, SkScalar sweepAngle, bool forceMoveTo) ## # <sup>2</sup> parameter sets force MoveTo ## -# <sup>3</sup> start angle must be multiple of 90 degrees. ## +# <sup>3</sup> start angle must be multiple of 90 degrees ## # <sup>4</sup> arcTo(SkScalar x1, SkScalar y1, SkScalar x2, SkScalar y2, SkScalar radius) ## # <sup>5</sup> arcTo(SkScalar rx, SkScalar ry, SkScalar xAxisRotate, ArcSize largeArc, Direction sweep, SkScalar x, SkScalar y) ## diff --git a/docs/SkPixmap_Reference.bmh b/docs/SkPixmap_Reference.bmh index c2b98663f6..74881545d0 100644 --- a/docs/SkPixmap_Reference.bmh +++ b/docs/SkPixmap_Reference.bmh @@ -19,14 +19,25 @@ to manage pixel memory; Pixel_Ref is safe across threads. #Subtopic Subtopics #Table #Legend -# topics # description ## +# name # description ## #Legend ## -# Image_Info_Access # Returns all or part of Image_Info. ## -# Initialization # Sets fields for use. ## -# Reader # Examine pixel value. ## -# Writer # Copy to pixel values. ## -# Readable_Address # Returns read only pixels. ## -# Writable_Address # Returns writable pixels. ## +# Constructors # list of functions that construct SkPath ## +# Member_Functions # list of static functions and member methods ## +# Related_Functions # similar methods grouped together ## +#Table ## +## + +#Subtopic Related_Functions +#Table +#Legend +# name # description ## +#Legend ## +# Image_Info_Access # returns all or part of Image_Info ## +# Initialization # sets fields for use ## +# Readable_Address # returns read only pixels ## +# Reader # examine pixel value ## +# Writable_Address # returns writable pixels ## +# Writer # copy to pixel values ## #Table ## #Subtopic ## @@ -35,48 +46,48 @@ to manage pixel memory; Pixel_Ref is safe across threads. #Legend # # description ## #Legend ## -# SkPixmap() # Constructs with default values. ## -# SkPixmap(const SkImageInfo& info, const void* addr, size_t rowBytes) # Constructs from Image_Info, pixels. ## +# SkPixmap() # constructs with default values ## +# SkPixmap(const SkImageInfo& info, const void* addr, size_t rowBytes) # constructs from Image_Info, pixels ## #Table ## #Subtopic ## #Subtopic Member_Functions #Table #Legend -# function # description ## +# name # description ## #Legend ## -# addr() # Returns readable pixel address as void pointer. ## -# addr16 # Returns readable pixel address as 16-bit pointer. ## -# addr32 # Returns readable pixel address as 32-bit pointer. ## -# addr64 # Returns readable pixel address as 64-bit pointer. ## -# addr8 # Returns readable pixel address as 8-bit pointer. ## -# addrF16 # Returns readable pixel component address as 16-bit pointer. ## -# alphaType # Returns Image_Info Alpha_Type. ## -# bounds() # Returns width and height as Rectangle. ## -# colorSpace # Returns Image_Info Color_Space. ## -# colorType # Returns Image_Info Color_Type. ## -# computeByteSize # Returns size required for pixels. ## -# computeIsOpaque # Returns true if all pixels are opaque. ## -# erase() # Writes Color to pixels. ## -# extractSubset # Sets pointer to portion of original. ## -# getColor # Returns one pixel as Unpremultiplied Color. ## -# height() # Returns pixel row count. ## -# info() # Returns Image_Info. ## -# isOpaque # Returns true if Image_Info describes opaque pixels. ## -# readPixels # Copies and converts pixels. ## -# reset() # Reuses existing Pixmap with replacement values. ## -# rowBytes # Returns interval between rows in bytes. ## -# rowBytesAsPixels # Returns interval between rows in pixels. ## -# scalePixels # Scales and converts pixels. ## -# setColorSpace # Sets Image_Info Color_Space. ## -# shiftPerPixel # Returns bit shift from pixels to bytes. ## -# width() # Returns pixel column count. ## -# writable_addr # Returns writable pixel address as void pointer. ## -# writable_addr16 # Returns writable pixel address as 16-bit pointer. ## -# writable_addr32 # Returns writable pixel address as 32-bit pointer. ## -# writable_addr64 # Returns writable pixel address as 64-bit pointer. ## -# writable_addr8 # Returns writable pixel address as 8-bit pointer. ## -# writable_addrF16 # Returns writable pixel component address as 16-bit pointer. ## +# addr() # returns readable pixel address as void pointer ## +# addr16 # returns readable pixel address as 16-bit pointer ## +# addr32 # returns readable pixel address as 32-bit pointer ## +# addr64 # returns readable pixel address as 64-bit pointer ## +# addr8 # returns readable pixel address as 8-bit pointer ## +# addrF16 # returns readable pixel component address as 16-bit pointer ## +# alphaType # returns Image_Info Alpha_Type ## +# bounds() # returns width and height as Rectangle ## +# colorSpace # returns Image_Info Color_Space ## +# colorType # returns Image_Info Color_Type ## +# computeByteSize # returns size required for pixels ## +# computeIsOpaque # returns true if all pixels are opaque ## +# erase() # writes Color to pixels ## +# extractSubset # sets pointer to portion of original ## +# getColor # returns one pixel as Unpremultiplied Color ## +# height() # returns pixel row count ## +# info() # returns Image_Info ## +# isOpaque # returns true if Image_Info describes opaque pixels ## +# readPixels # copies and converts pixels ## +# reset() # reuses existing Pixmap with replacement values ## +# rowBytes # returns interval between rows in bytes ## +# rowBytesAsPixels # returns interval between rows in pixels ## +# scalePixels # scales and converts pixels ## +# setColorSpace # sets Image_Info Color_Space ## +# shiftPerPixel # returns bit shift from pixels to bytes ## +# width() # returns pixel column count ## +# writable_addr # returns writable pixel address as void pointer ## +# writable_addr16 # returns writable pixel address as 16-bit pointer ## +# writable_addr32 # returns writable pixel address as 32-bit pointer ## +# writable_addr64 # returns writable pixel address as 64-bit pointer ## +# writable_addr8 # returns writable pixel address as 8-bit pointer ## +# writable_addrF16 # returns writable pixel component address as 16-bit pointer ## #Table ## #Subtopic ## diff --git a/docs/SkPoint_Reference.bmh b/docs/SkPoint_Reference.bmh index 6eeb1a5703..72c73e49a4 100644 --- a/docs/SkPoint_Reference.bmh +++ b/docs/SkPoint_Reference.bmh @@ -15,15 +15,24 @@ #Table ## ## +#Subtopic Constructors +#Table +#Legend +# name # description ## +#Legend ## +# Make # Constructs from SkScalar inputs. ## +#Table ## +#Subtopic ## + #Subtopic Operators #Table #Legend -# description # function ## +# name # description ## #Legend ## # SkPoint operator*(SkScalar scale)_const # Returns Point multiplied by scale. ## +# SkPoint operator+(const SkPoint& a, const SkVector& b) # Returns Point offset by Vector. ## # SkPoint operator-()_const # Reverses sign of Point. ## # SkPoint& operator*=(SkScalar scale) # Multiplies Point by scale factor. ## -# SkPoint operator+(const SkPoint& a, const SkVector& b) # Returns Point offset by Vector. ## # SkVector operator-(const SkPoint& a, const SkPoint& b) # Returns Vector between Points. ## # bool operator!=(const SkPoint& a, const SkPoint& b) # Returns true if Point are unequal. ## # bool operator==(const SkPoint& a, const SkPoint& b) # Returns true if Point are equal. ## @@ -35,7 +44,7 @@ #Subtopic Member_Functions #Table #Legend -# description # function ## +# name # description ## #Legend ## # CrossProduct # Returns cross product. ## # Distance # Returns straight-line distance between points. ## diff --git a/docs/SkRect_Reference.bmh b/docs/SkRect_Reference.bmh index 7aeb90eb52..0df650b668 100644 --- a/docs/SkRect_Reference.bmh +++ b/docs/SkRect_Reference.bmh @@ -22,16 +22,40 @@ integer input cannot convert to SkScalar without loss of precision. #Legend # topics # description ## #Legend ## +# Constructors # functions that construct SkPath ## +# Member_Functions # static functions and member methods ## +# Operators # operator overloading methods ## #Table ## ## +#Subtopic Constructors +#Table +#Legend +# name # description ## +#Legend ## +# Make # constructs from ISize returning (0, 0, width, height) ## +# MakeEmpty # constructs from bounds of (0, 0, 0, 0) ## +# MakeFromIRect # deprecated ## +# MakeIWH # constructs from int input returning (0, 0, width, height) ## +# MakeLTRB # constructs from SkScalar left, top, right, bottom ## +# MakeLargest # deprecated ## +# MakeSize # constructs from Size returning (0, 0, width, height) ## +# MakeWH # constructs from SkScalar input returning (0, 0, width, height) ## +# MakeXYWH # constructs from SkScalar input returning (x, y, width, height) ## +# makeInset # constructs from sides moved symmetrically about the center ## +# makeOffset # constructs from translated sides ## +# makeOutset # constructs from sides moved symmetrically about the center ## +# makeSorted # constructs, ordering sides from smaller to larger ## +#Table ## +#Subtopic ## + #Subtopic Operators #Table #Legend # description # function ## #Legend ## -# bool operator!=(const SkRect& a, const SkRect& b) # Returns true if members are unequal. ## -# bool operator==(const SkRect& a, const SkRect& b) # Returns true if members are equal. ## +# bool operator!=(const SkRect& a, const SkRect& b) # returns true if members are unequal ## +# bool operator==(const SkRect& a, const SkRect& b) # returns true if members are equal ## #Table ## #Subtopic ## @@ -40,59 +64,60 @@ integer input cannot convert to SkScalar without loss of precision. #Legend # description # function ## #Legend ## -# Intersects # Returns true if areas overlap. ## -# Make # Constructs from ISize returning (0, 0, width, height). ## -# MakeEmpty # Constructs from bounds of (0, 0, 0, 0). ## -# MakeFromIRect # Deprecated. ## -# MakeIWH # Constructs from int input returning (0, 0, width, height). ## -# MakeLTRB # Constructs from SkScalar left, top, right, bottom. ## -# MakeSize # Constructs from Size returning (0, 0, width, height). ## -# MakeWH # Constructs from SkScalar input returning (0, 0, width, height). ## -# MakeXYWH # Constructs from SkScalar input returning (x, y, width, height). ## -# asScalars # Returns pointer to members as array. ## -# bottom() # Returns larger bounds in y, if sorted. ## -# centerX # Returns midpoint in x. ## -# centerY # Returns midpoint in y. ## -# contains() # Returns true if points are equal or inside. ## -# dump() # Sends text representation using floats to standard output. ## -# dumpHex # Sends text representation using hexadecimal to standard output. ## -# height # Returns span in y. ## -# inset() # Moves the sides symmetrically about the center. ## -# intersect() # Sets to shared area; returns true if not empty. ## -# intersects() # Returns true if areas overlap. ## -# isEmpty # Returns true if width or height are zero or negative. ## -# isFinite # Returns true if no member is infinite or NaN. ## -# isSorted # Returns true if width or height are zero or positive. ## -# iset() # Sets to int input (left, top, right, bottom). ## -# isetWH # Sets to int input (0, 0, width, height). ## -# join() # Sets to union of bounds. ## -# joinNonEmptyArg # Sets to union of bounds, asserting that argument is not empty. ## -# joinPossiblyEmptyRect # Sets to union of bounds. Skips empty check for both. ## -# left() # Returns smaller bounds in x, if sorted. ## -# makeInset # Constructs from sides moved symmetrically about the center. ## -# makeOffset # Constructs from translated sides. ## -# makeOutset # Constructs from sides moved symmetrically about the center. ## -# makeSorted # Constructs, ordering sides from smaller to larger. ## -# offset() # Translates sides without changing width and height. ## -# offsetTo # Translates to (x, y) without changing width and height. ## -# outset() # Moves the sides symmetrically about the center. ## -# right() # Returns larger bounds in x, if sorted. ## -# round() # Sets members to nearest integer value. ## -# roundIn # Sets members to nearest integer value towards opposite. ## -# roundOut # Sets members to nearest integer value away from opposite. ## -# set() # Sets to SkScalar input (left, top, right, bottom) and others. ## -# setBounds # Sets to upper and lower limits of Point array. ## -# setBoundsCheck # Sets to upper and lower limits of Point array. ## -# setEmpty # Sets to (0, 0, 0, 0). ## -# setLTRB # Sets to SkScalar input (left, top, right, bottom). ## -# setWH # Sets to SkScalar input (0, 0, width, height). ## -# setXYWH # Sets to SkScalar input (x, y, width, height). ## -# sort() # Orders sides from smaller to larger. ## -# toQuad # Returns four corners as Point. ## -# top() # Returns smaller bounds in y, if sorted. ## -# width() # Returns span in x. ## -# x() # Returns bounds left. ## -# y() # Returns bounds top. ## +# Intersects # returns true if areas overlap ## +# Make # constructs from ISize returning (0, 0, width, height) ## +# MakeEmpty # constructs from bounds of (0, 0, 0, 0) ## +# MakeFromIRect # deprecated ## +# MakeIWH # constructs from int input returning (0, 0, width, height) ## +# MakeLTRB # constructs from SkScalar left, top, right, bottom ## +# MakeLargest # deprecated ## +# MakeSize # constructs from Size returning (0, 0, width, height) ## +# MakeWH # constructs from SkScalar input returning (0, 0, width, height) ## +# MakeXYWH # constructs from SkScalar input returning (x, y, width, height) ## +# asScalars # returns pointer to members as array ## +# bottom() # returns larger bounds in y, if sorted ## +# centerX # returns midpoint in x ## +# centerY # returns midpoint in y ## +# contains() # returns true if points are equal or inside ## +# dump() # sends text representation to standard output using floats ## +# dumpHex # sends text representation to standard output using hexadecimal ## +# height() # returns span in y ## +# inset() # moves the sides symmetrically about the center ## +# intersect() # sets to shared area; returns true if not empty ## +# intersects() # returns true if areas overlap ## +# isEmpty # returns true if width or height are zero or negative ## +# isFinite # returns true if no member is infinite or NaN ## +# isSorted # returns true if width or height are zero or positive ## +# iset() # sets to int input (left, top, right, bottom) ## +# isetWH # sets to int input (0, 0, width, height) ## +# join() # sets to union of bounds ## +# joinNonEmptyArg # sets to union of bounds, asserting that argument is not empty ## +# joinPossiblyEmptyRect # sets to union of bounds. Skips empty check for both ## +# left() # returns smaller bounds in x, if sorted ## +# makeInset # constructs from sides moved symmetrically about the center ## +# makeOffset # constructs from translated sides ## +# makeOutset # constructs from sides moved symmetrically about the center ## +# makeSorted # constructs, ordering sides from smaller to larger ## +# offset() # translates sides without changing width and height ## +# offsetTo # translates to (x, y) without changing width and height ## +# outset() # moves the sides symmetrically about the center ## +# right() # returns larger bounds in x, if sorted ## +# round() # sets members to nearest integer value ## +# roundIn # sets members to nearest integer value towards opposite ## +# roundOut # sets members to nearest integer value away from opposite ## +# set() # sets to SkScalar input (left, top, right, bottom) and others ## +# setBounds # sets to upper and lower limits of Point array ## +# setBoundsCheck # sets to upper and lower limits of Point array ## +# setEmpty # sets to (0, 0, 0, 0) ## +# setLTRB # sets to SkScalar input (left, top, right, bottom) ## +# setWH # sets to SkScalar input (0, 0, width, height) ## +# setXYWH # sets to SkScalar input (x, y, width, height) ## +# sort() # orders sides from smaller to larger ## +# toQuad # returns four corners as Point ## +# top() # returns smaller bounds in y, if sorted ## +# width() # returns span in x ## +# x() # returns bounds left ## +# y() # returns bounds top ## #Table ## #Subtopic ## diff --git a/docs/SkSurface_Reference.bmh b/docs/SkSurface_Reference.bmh index 3ab33c7d22..164570d422 100644 --- a/docs/SkSurface_Reference.bmh +++ b/docs/SkSurface_Reference.bmh @@ -18,41 +18,62 @@ of the requested dimensions are zero, then nullptr will be returned. #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 ## + #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() # Set up 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 # Returns Image capturing Surface contents. ## -# makeSurface # Returns 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() # Pause commands until signaled. ## -# width() # Returns pixel column count. ## +# 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 ## diff --git a/docs/status.json b/docs/status.json index 43be98cdf3..3aeea76992 100644 --- a/docs/status.json +++ b/docs/status.json @@ -14,6 +14,7 @@ ]
},
"docs": [
+ "SkAutoCanvasRestore_Reference.bmh",
"SkCanvas_Reference.bmh",
"SkIPoint16_Reference.bmh",
"SkPaint_Reference.bmh",
|