From 3fdcb209394091b55dca9c8d8ca5e13953cc92f7 Mon Sep 17 00:00:00 2001 From: Miguel de Icaza Date: Mon, 22 Feb 2016 18:01:47 -0800 Subject: [PATCH] More docs --- docs/en/SkiaSharp/SKImage.xml | 4 +-- docs/en/SkiaSharp/SKImageDecoder.xml | 12 +++++---- docs/en/SkiaSharp/SKImageDecoderFormat.xml | 6 +++-- docs/en/SkiaSharp/SKImageDecoderResult.xml | 18 +++++++++---- docs/en/SkiaSharp/SKImageFilter.xml | 2 +- docs/en/SkiaSharp/SKPaint.xml | 30 ++++++++++++++-------- docs/en/SkiaSharp/SKPixelGeometry.xml | 16 +++++++----- docs/en/SkiaSharp/SKShader.xml | 8 ++++-- docs/en/SkiaSharp/SKShaderTileMode.xml | 8 +++--- docs/en/SkiaSharp/SKSize.xml | 12 +++++---- docs/en/SkiaSharp/SKSizeI.xml | 12 +++++---- docs/en/SkiaSharp/SKStreamMemory.xml | 2 +- docs/en/SkiaSharp/SKStreamSeekable.xml | 2 +- docs/en/SkiaSharp/SKStrokeCap.xml | 13 ++++++---- docs/en/SkiaSharp/SKStrokeJoin.xml | 12 +++++---- docs/en/SkiaSharp/SKSurface.xml | 2 +- docs/en/SkiaSharp/SKSurfaceProps.xml | 9 +++++-- docs/en/SkiaSharp/SKTextAlign.xml | 4 ++- docs/en/SkiaSharp/SKTextEncoding.xml | 14 +++++----- docs/en/SkiaSharp/SKTypeface.xml | 30 +++++++++++++--------- docs/en/SkiaSharp/SKTypefaceStyle.xml | 14 +++++----- 21 files changed, 143 insertions(+), 87 deletions(-) diff --git a/docs/en/SkiaSharp/SKImage.xml b/docs/en/SkiaSharp/SKImage.xml index 83ec0595..002661dc 100644 --- a/docs/en/SkiaSharp/SKImage.xml +++ b/docs/en/SkiaSharp/SKImage.xml @@ -13,9 +13,9 @@ Abstraction for drawing a rectangle of pixels. SkImage is an abstraction for drawing a rectagle of pixels, though the particular type of image could be actually storing its data on the GPU, or as drawing commands (picture or PDF or otherwise), ready to be played back into another canvas. - + The content of SkImage is always immutable, though the actual storage may change, if for example that image can be re-created via encoded data or other means. - + SkImage always has a non-zero dimensions. If there is a request to create a new image, either directly or via SkSurface, and either of the requested dimensions are zero, then will be returned. diff --git a/docs/en/SkiaSharp/SKImageDecoder.xml b/docs/en/SkiaSharp/SKImageDecoder.xml index 652a31db..588527fa 100644 --- a/docs/en/SkiaSharp/SKImageDecoder.xml +++ b/docs/en/SkiaSharp/SKImageDecoder.xml @@ -10,7 +10,7 @@ - To be added. + Base class for decoding compressed images into a SkBitmap. To be added. @@ -414,9 +414,11 @@ System.Boolean - To be added. - To be added. - To be added. + Controls whether the decoder attempts to dither the image. + + + + The default setting is . @@ -502,7 +504,7 @@ System.Boolean - To be added. + Controls whether the decoder chooses quality over speed. To be added. To be added. diff --git a/docs/en/SkiaSharp/SKImageDecoderFormat.xml b/docs/en/SkiaSharp/SKImageDecoderFormat.xml index a2be05b4..d9f79484 100644 --- a/docs/en/SkiaSharp/SKImageDecoderFormat.xml +++ b/docs/en/SkiaSharp/SKImageDecoderFormat.xml @@ -9,8 +9,10 @@ System.Enum - To be added. - To be added. + Decoder file format + + + diff --git a/docs/en/SkiaSharp/SKImageDecoderResult.xml b/docs/en/SkiaSharp/SKImageDecoderResult.xml index d9e0941e..916f61fe 100644 --- a/docs/en/SkiaSharp/SKImageDecoderResult.xml +++ b/docs/en/SkiaSharp/SKImageDecoderResult.xml @@ -9,8 +9,10 @@ System.Enum - To be added. - To be added. + Results from the  methods. + + + @@ -24,7 +26,9 @@ SkiaSharp.SKImageDecoderResult - To be added. + + + @@ -38,7 +42,9 @@ SkiaSharp.SKImageDecoderResult - To be added. + + + @@ -52,7 +58,9 @@ SkiaSharp.SKImageDecoderResult - To be added. + + + diff --git a/docs/en/SkiaSharp/SKImageFilter.xml b/docs/en/SkiaSharp/SKImageFilter.xml index 306f90e3..e61c5678 100644 --- a/docs/en/SkiaSharp/SKImageFilter.xml +++ b/docs/en/SkiaSharp/SKImageFilter.xml @@ -10,7 +10,7 @@ - To be added. + Image filters for the  To be added. diff --git a/docs/en/SkiaSharp/SKPaint.xml b/docs/en/SkiaSharp/SKPaint.xml index fa83363d..1365602b 100644 --- a/docs/en/SkiaSharp/SKPaint.xml +++ b/docs/en/SkiaSharp/SKPaint.xml @@ -40,9 +40,13 @@ SkiaSharp.SKColor - To be added. - To be added. - To be added. + The paint’s color. + + + + + Note that the color is a 32bit value containing alpha as well as r,g,b. This 32bit value is not premultiplied, meaning that its alpha can be any value, regardless of the values of r,g,b. + @@ -91,7 +95,7 @@ SkiaSharp.SKImageFilter - To be added. + Image filter To be added. To be added. @@ -203,9 +207,13 @@ System.Single - To be added. - To be added. - To be added. + The paint's stroke miter value + + the paint's miter limit, used whenever the paint's style is Stroke or StrokeAndFill. + + + This is used to control the behavior of miter joins when the joins angle is sharp. + @@ -219,9 +227,11 @@ System.Single - To be added. - To be added. - To be added. + The paint’s stroke width. + + the paint's stroke width, used whenever the paint's style is Stroke or StrokeAndFill. + + The value of zero is the special hairline mode.   Hairlines always draw with a width of 1 pixel, regardless of the transformation matrix. diff --git a/docs/en/SkiaSharp/SKPixelGeometry.xml b/docs/en/SkiaSharp/SKPixelGeometry.xml index c92106ab..01823180 100644 --- a/docs/en/SkiaSharp/SKPixelGeometry.xml +++ b/docs/en/SkiaSharp/SKPixelGeometry.xml @@ -9,8 +9,10 @@ System.Enum - To be added. - To be added. + Describes how LCD strips are organized for each pixel. + + Description of how the LCD strips are arranged for each pixel. If this is unknown, or the pixels are meant to be "portable" and/or transformed before showing (e.g. rotated, scaled) then use Unknown. + @@ -24,7 +26,7 @@ SkiaSharp.SKPixelGeometry - To be added. + Pixels are made up horizontal blue, green and red lights. @@ -38,7 +40,7 @@ SkiaSharp.SKPixelGeometry - To be added. + Pixels are made up vertical blue, green and red lights. @@ -52,7 +54,7 @@ SkiaSharp.SKPixelGeometry - To be added. + Pixels are made up horizontal red, green and blue lights. @@ -66,7 +68,7 @@ SkiaSharp.SKPixelGeometry - To be added. + Pixels are made up vertical red, green and blue lights. @@ -80,7 +82,7 @@ SkiaSharp.SKPixelGeometry - To be added. + Use if the order is not known or the pixels are meant to be "portable" and/or transformed before showing (e.g. rotated, scaled). diff --git a/docs/en/SkiaSharp/SKShader.xml b/docs/en/SkiaSharp/SKShader.xml index af94c63e..84e48376 100644 --- a/docs/en/SkiaSharp/SKShader.xml +++ b/docs/en/SkiaSharp/SKShader.xml @@ -10,8 +10,12 @@ - To be added. - To be added. + Shaders specify the source color(s) for what is being drawn in the . + + Shaders specify the source color(s) for what is being drawn. If a paint has no shader, then the paint's color is used. If the paint has a shader, then the shader's color(s) are use instead, but they are modulated by the paint's alpha.  + + This makes it easy to create a shader once (e.g. bitmap tiling or gradient) and then change its transparency w/o having to modify the original shader, only the paint's alpha needs to be modified. + diff --git a/docs/en/SkiaSharp/SKShaderTileMode.xml b/docs/en/SkiaSharp/SKShaderTileMode.xml index dd0fe435..e6d94f93 100644 --- a/docs/en/SkiaSharp/SKShaderTileMode.xml +++ b/docs/en/SkiaSharp/SKShaderTileMode.xml @@ -24,7 +24,9 @@ SkiaSharp.SKShaderTileMode - To be added. + + Replicate the edge color if the shader draws outside of its original bounds + @@ -38,7 +40,7 @@ SkiaSharp.SKShaderTileMode - To be added. + Repeat the shader's image horizontally and vertically, alternating mirror images so that adjacent images always seam @@ -52,7 +54,7 @@ SkiaSharp.SKShaderTileMode - To be added. + Repeat the shader's image horizontally and vertically diff --git a/docs/en/SkiaSharp/SKSize.xml b/docs/en/SkiaSharp/SKSize.xml index 44695c3f..f5135443 100644 --- a/docs/en/SkiaSharp/SKSize.xml +++ b/docs/en/SkiaSharp/SKSize.xml @@ -10,8 +10,10 @@ - To be added. - To be added. + Stores an ordered pair of floating-point numbers describing the width and height of a rectangle. + + + @@ -28,7 +30,7 @@ To be added. To be added. - To be added. + Initializes a new SKSize with a given width and height. To be added. @@ -43,7 +45,7 @@ System.Single - To be added. + The height To be added. @@ -58,7 +60,7 @@ System.Single - To be added. + The width To be added. diff --git a/docs/en/SkiaSharp/SKSizeI.xml b/docs/en/SkiaSharp/SKSizeI.xml index bd648d31..552af84d 100644 --- a/docs/en/SkiaSharp/SKSizeI.xml +++ b/docs/en/SkiaSharp/SKSizeI.xml @@ -10,8 +10,10 @@ - To be added. - To be added. + Stores an ordered pair of integers describing the width and height of a rectangle. + + + @@ -28,7 +30,7 @@ To be added. To be added. - To be added. + Initializes a new SKSize with a given width and height. To be added. @@ -43,7 +45,7 @@ System.Int32 - To be added. + The height To be added. @@ -58,7 +60,7 @@ System.Int32 - To be added. + The width To be added. diff --git a/docs/en/SkiaSharp/SKStreamMemory.xml b/docs/en/SkiaSharp/SKStreamMemory.xml index 0c630be3..ad23a71d 100644 --- a/docs/en/SkiaSharp/SKStreamMemory.xml +++ b/docs/en/SkiaSharp/SKStreamMemory.xml @@ -10,7 +10,7 @@ - To be added. + An in-memory SKStream. To be added. diff --git a/docs/en/SkiaSharp/SKStreamSeekable.xml b/docs/en/SkiaSharp/SKStreamSeekable.xml index adc7d381..9449d658 100644 --- a/docs/en/SkiaSharp/SKStreamSeekable.xml +++ b/docs/en/SkiaSharp/SKStreamSeekable.xml @@ -10,7 +10,7 @@ - To be added. + An SKStream that supports the seek operation To be added. diff --git a/docs/en/SkiaSharp/SKStrokeCap.xml b/docs/en/SkiaSharp/SKStrokeCap.xml index d6729be0..51ed080d 100644 --- a/docs/en/SkiaSharp/SKStrokeCap.xml +++ b/docs/en/SkiaSharp/SKStrokeCap.xml @@ -9,8 +9,11 @@ System.Enum - To be added. - To be added. + Cap enum specifies the settings for the paint's strokecap.  + + This is the treatment that is applied to the beginning and end of each non-closed contour (e.g. lines). + + @@ -24,7 +27,7 @@ SkiaSharp.SKStrokeCap - To be added. + begin/end contours with no extension @@ -38,7 +41,7 @@ SkiaSharp.SKStrokeCap - To be added. + begin/end contours with a semi-circle extension @@ -52,7 +55,7 @@ SkiaSharp.SKStrokeCap - To be added. + begin/end contours with a half square extension diff --git a/docs/en/SkiaSharp/SKStrokeJoin.xml b/docs/en/SkiaSharp/SKStrokeJoin.xml index 23321996..a0b42eda 100644 --- a/docs/en/SkiaSharp/SKStrokeJoin.xml +++ b/docs/en/SkiaSharp/SKStrokeJoin.xml @@ -9,8 +9,10 @@ System.Enum - To be added. - To be added. + Join style for stroking operations. + + This is the treatment that is applied to corners in paths and rectangles. + @@ -24,7 +26,7 @@ SkiaSharp.SKStrokeJoin - To be added. + Connect path segments with a flat bevel join @@ -38,7 +40,7 @@ SkiaSharp.SKStrokeJoin - To be added. + Connect path segments with a sharp join @@ -52,7 +54,7 @@ SkiaSharp.SKStrokeJoin - To be added. + Connect path segments with a round join diff --git a/docs/en/SkiaSharp/SKSurface.xml b/docs/en/SkiaSharp/SKSurface.xml index 37daf8c1..ab0890ac 100644 --- a/docs/en/SkiaSharp/SKSurface.xml +++ b/docs/en/SkiaSharp/SKSurface.xml @@ -26,7 +26,7 @@ } ]]> - + diff --git a/docs/en/SkiaSharp/SKSurfaceProps.xml b/docs/en/SkiaSharp/SKSurfaceProps.xml index ef77dcc5..fddb1810 100644 --- a/docs/en/SkiaSharp/SKSurfaceProps.xml +++ b/docs/en/SkiaSharp/SKSurfaceProps.xml @@ -11,7 +11,11 @@ Surface properties - These are used to configure the properties of the surface when it is being created. + + These are used to configure the properties of the surface when it is being created. + + Currently the only setting avaialble is the PixelGeometry that you use to describe the order and orientation of the individual LED elements on each pixel. + @@ -26,7 +30,8 @@ - + Describes the LCD geometry of each pixel on the surface. + To be added. To be added. diff --git a/docs/en/SkiaSharp/SKTextAlign.xml b/docs/en/SkiaSharp/SKTextAlign.xml index bc17dbd9..acbc71a6 100644 --- a/docs/en/SkiaSharp/SKTextAlign.xml +++ b/docs/en/SkiaSharp/SKTextAlign.xml @@ -10,7 +10,9 @@ Possible text alignment values - To be added. + + + diff --git a/docs/en/SkiaSharp/SKTextEncoding.xml b/docs/en/SkiaSharp/SKTextEncoding.xml index dc448854..7f19cbef 100644 --- a/docs/en/SkiaSharp/SKTextEncoding.xml +++ b/docs/en/SkiaSharp/SKTextEncoding.xml @@ -9,8 +9,10 @@ System.Enum - To be added. - To be added. + Possible encodings. + + + @@ -24,7 +26,7 @@ SkiaSharp.SKTextEncoding - To be added. + The buffer contains glyph ids. @@ -38,7 +40,7 @@ SkiaSharp.SKTextEncoding - To be added. + The buffer contains UTF-16 encoded characters. @@ -52,7 +54,7 @@ SkiaSharp.SKTextEncoding - To be added. + The buffer contains UTF-32 encoded characters. @@ -66,7 +68,7 @@ SkiaSharp.SKTextEncoding - To be added. + The buffer contains UTF-8 encoded characters. diff --git a/docs/en/SkiaSharp/SKTypeface.xml b/docs/en/SkiaSharp/SKTypeface.xml index 02beb9ec..c17ec8ba 100644 --- a/docs/en/SkiaSharp/SKTypeface.xml +++ b/docs/en/SkiaSharp/SKTypeface.xml @@ -14,9 +14,9 @@ The SkTypeface class specifies the typeface and intrinsic style of a font. This is used in the paint, along with optionally algorithmic settings like textSize, textSkewX, textScaleX, kFakeBoldText_Mask, to specifyhow text appears when drawn (and measured). - + Typeface objects are immutable, and so they can be shared between threads. - + @@ -174,11 +174,15 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + path of the file. + The font face index. + Return a new typeface given a file.  + + + + + If the file does not exist, or is not a valid font file, returns . + @@ -196,11 +200,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + Input stream + the font face index. + Return a new typeface given a stream.  + If the stream is not a valid font file, returns .  + + + diff --git a/docs/en/SkiaSharp/SKTypefaceStyle.xml b/docs/en/SkiaSharp/SKTypefaceStyle.xml index e79f4ebf..9c70e0c7 100644 --- a/docs/en/SkiaSharp/SKTypefaceStyle.xml +++ b/docs/en/SkiaSharp/SKTypefaceStyle.xml @@ -9,8 +9,10 @@ System.Enum - To be added. - To be added. + Specifies the intrinsic style attributes of a given typeface + + + @@ -24,7 +26,7 @@ SkiaSharp.SKTypefaceStyle - To be added. + Bold @@ -38,7 +40,7 @@ SkiaSharp.SKTypefaceStyle - To be added. + Bold and Italic, convenience definition. @@ -52,7 +54,7 @@ SkiaSharp.SKTypefaceStyle - To be added. + Italic @@ -66,7 +68,7 @@ SkiaSharp.SKTypefaceStyle - To be added. + Normal