This commit is contained in:
Miguel de Icaza 2016-02-22 18:01:47 -08:00
Родитель c3c049366c
Коммит 3fdcb20939
21 изменённых файлов: 143 добавлений и 87 удалений

Просмотреть файл

@ -13,9 +13,9 @@
<summary>Abstraction for drawing a rectangle of pixels.</summary>
<remarks>
<para>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.</para>
<para />
<para></para>
<para>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.</para>
<para />
<para></para>
<para>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 <see langword="null" /> will be returned.</para>
</remarks>
</Docs>

Просмотреть файл

@ -10,7 +10,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Base class for decoding compressed images into a SkBitmap.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
@ -414,9 +414,11 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Controls whether the decoder attempts to dither the image.</summary>
<value>
<para />
</value>
<remarks>The default setting is <paramref name="true" />.</remarks>
</Docs>
</Member>
<Member MemberName="Format">
@ -502,7 +504,7 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Controls whether the decoder chooses quality over speed.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>

Просмотреть файл

@ -9,8 +9,10 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Decoder file format</summary>
<remarks>
<para></para>
</remarks>
</Docs>
<Members>
<Member MemberName="Astc">

Просмотреть файл

@ -9,8 +9,10 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Results from the <see cref="M:SkiaSharp.SKImageDecoder.Decode" /> methods.</summary>
<remarks>
<para />
</remarks>
</Docs>
<Members>
<Member MemberName="Failure">
@ -24,7 +26,9 @@
<ReturnType>SkiaSharp.SKImageDecoderResult</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>
<para />
</summary>
</Docs>
</Member>
<Member MemberName="PartialSuccess">
@ -38,7 +42,9 @@
<ReturnType>SkiaSharp.SKImageDecoderResult</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>
<para />
</summary>
</Docs>
</Member>
<Member MemberName="Success">
@ -52,7 +58,9 @@
<ReturnType>SkiaSharp.SKImageDecoderResult</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>
<para />
</summary>
</Docs>
</Member>
</Members>

Просмотреть файл

@ -10,7 +10,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Image filters for the <see cref="T:SkiaSharp.SKPaint" /></summary>
<remarks>To be added.</remarks>
</Docs>
<Members>

Просмотреть файл

@ -40,9 +40,13 @@
<ReturnType>SkiaSharp.SKColor</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>The paints color.</summary>
<value>
<para />
</value>
<remarks>
<para>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.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ColorFilter">
@ -91,7 +95,7 @@
<ReturnType>SkiaSharp.SKImageFilter</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Image filter</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
@ -203,9 +207,13 @@
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>The paint's stroke miter value</summary>
<value>
<para>the paint's miter limit, used whenever the paint's style is Stroke or StrokeAndFill.</para>
</value>
<remarks>
<para>This is used to control the behavior of miter joins when the joins angle is sharp.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="StrokeWidth">
@ -219,9 +227,11 @@
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>The paints stroke width.</summary>
<value>
<para>the paint's stroke width, used whenever the paint's style is Stroke or StrokeAndFill.</para>
</value>
<remarks>The value of zero is the special hairline mode.   Hairlines always draw with a width of 1 pixel, regardless of the transformation matrix.</remarks>
</Docs>
</Member>
<Member MemberName="TextAlign">

Просмотреть файл

@ -9,8 +9,10 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Describes how LCD strips are organized for each pixel.</summary>
<remarks>
<para>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.</para>
</remarks>
</Docs>
<Members>
<Member MemberName="BgrHorizontal">
@ -24,7 +26,7 @@
<ReturnType>SkiaSharp.SKPixelGeometry</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Pixels are made up horizontal blue, green and red lights.</summary>
</Docs>
</Member>
<Member MemberName="BgrVertical">
@ -38,7 +40,7 @@
<ReturnType>SkiaSharp.SKPixelGeometry</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Pixels are made up vertical blue, green and red lights.</summary>
</Docs>
</Member>
<Member MemberName="RgbHorizontal">
@ -52,7 +54,7 @@
<ReturnType>SkiaSharp.SKPixelGeometry</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Pixels are made up horizontal red, green and blue lights.</summary>
</Docs>
</Member>
<Member MemberName="RgbVertical">
@ -66,7 +68,7 @@
<ReturnType>SkiaSharp.SKPixelGeometry</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Pixels are made up vertical red, green and blue lights.</summary>
</Docs>
</Member>
<Member MemberName="Unknown">
@ -80,7 +82,7 @@
<ReturnType>SkiaSharp.SKPixelGeometry</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Use if the order is not known or the pixels are meant to be "portable" and/or transformed before showing (e.g. rotated, scaled).</summary>
</Docs>
</Member>
</Members>

Просмотреть файл

@ -10,8 +10,12 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Shaders specify the source color(s) for what is being drawn in the <see cref="T:SkiaSharp.SKPaint" />.</summary>
<remarks>
<para>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. </para>
<para />
<para>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.</para>
</remarks>
</Docs>
<Members>
<Member MemberName="CreateBitmap">

Просмотреть файл

@ -24,7 +24,9 @@
<ReturnType>SkiaSharp.SKShaderTileMode</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>
<para>Replicate the edge color if the shader draws outside of its original bounds</para>
</summary>
</Docs>
</Member>
<Member MemberName="Mirror">
@ -38,7 +40,7 @@
<ReturnType>SkiaSharp.SKShaderTileMode</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Repeat the shader's image horizontally and vertically, alternating mirror images so that adjacent images always seam</summary>
</Docs>
</Member>
<Member MemberName="Repeat">
@ -52,7 +54,7 @@
<ReturnType>SkiaSharp.SKShaderTileMode</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Repeat the shader's image horizontally and vertically</summary>
</Docs>
</Member>
</Members>

Просмотреть файл

@ -10,8 +10,10 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Stores an ordered pair of floating-point numbers describing the width and height of a rectangle.</summary>
<remarks>
<para></para>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
@ -28,7 +30,7 @@
<Docs>
<param name="width">To be added.</param>
<param name="height">To be added.</param>
<summary>To be added.</summary>
<summary>Initializes a new SKSize with a given width and height.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@ -43,7 +45,7 @@
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The height</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@ -58,7 +60,7 @@
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The width</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>

Просмотреть файл

@ -10,8 +10,10 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Stores an ordered pair of integers describing the width and height of a rectangle.</summary>
<remarks>
<para />
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
@ -28,7 +30,7 @@
<Docs>
<param name="width">To be added.</param>
<param name="height">To be added.</param>
<summary>To be added.</summary>
<summary>Initializes a new SKSize with a given width and height.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@ -43,7 +45,7 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The height</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@ -58,7 +60,7 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The width</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>

Просмотреть файл

@ -10,7 +10,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>An in-memory SKStream.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members />

Просмотреть файл

@ -10,7 +10,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>An SKStream that supports the seek operation</summary>
<remarks>To be added.</remarks>
</Docs>
<Members />

Просмотреть файл

@ -9,8 +9,11 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Cap enum specifies the settings for the paint's strokecap. </summary>
<remarks>
<para>This is the treatment that is applied to the beginning and end of each non-closed contour (e.g. lines).</para>
<para></para>
</remarks>
</Docs>
<Members>
<Member MemberName="Butt">
@ -24,7 +27,7 @@
<ReturnType>SkiaSharp.SKStrokeCap</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>begin/end contours with no extension</summary>
</Docs>
</Member>
<Member MemberName="Round">
@ -38,7 +41,7 @@
<ReturnType>SkiaSharp.SKStrokeCap</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>begin/end contours with a semi-circle extension</summary>
</Docs>
</Member>
<Member MemberName="Square">
@ -52,7 +55,7 @@
<ReturnType>SkiaSharp.SKStrokeCap</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>begin/end contours with a half square extension</summary>
</Docs>
</Member>
</Members>

Просмотреть файл

@ -9,8 +9,10 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Join style for stroking operations.</summary>
<remarks>
<para>This is the treatment that is applied to corners in paths and rectangles.</para>
</remarks>
</Docs>
<Members>
<Member MemberName="Bevel">
@ -24,7 +26,7 @@
<ReturnType>SkiaSharp.SKStrokeJoin</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Connect path segments with a flat bevel join</summary>
</Docs>
</Member>
<Member MemberName="Mitter">
@ -38,7 +40,7 @@
<ReturnType>SkiaSharp.SKStrokeJoin</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Connect path segments with a sharp join</summary>
</Docs>
</Member>
<Member MemberName="Round">
@ -52,7 +54,7 @@
<ReturnType>SkiaSharp.SKStrokeJoin</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Connect path segments with a round join</summary>
</Docs>
</Member>
</Members>

Просмотреть файл

@ -26,7 +26,7 @@
}
]]></code>
</example>
<para />
<para></para>
</remarks>
</Docs>
<Members>

Просмотреть файл

@ -11,7 +11,11 @@
<Interfaces />
<Docs>
<summary>Surface properties</summary>
<remarks>These are used to configure the properties of the surface when it is being created.</remarks>
<remarks>
<para>These are used to configure the properties of the surface when it is being created.</para>
<para />
<para>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.</para>
</remarks>
</Docs>
<Members>
<Member MemberName="PixelGeometry">
@ -26,7 +30,8 @@
</ReturnValue>
<Docs>
<summary>
<para />
<para>Describes the LCD geometry of each pixel on the surface.</para>
<para></para>
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>

Просмотреть файл

@ -10,7 +10,9 @@
</Base>
<Docs>
<summary>Possible text alignment values</summary>
<remarks>To be added.</remarks>
<remarks>
<para />
</remarks>
</Docs>
<Members>
<Member MemberName="Center">

Просмотреть файл

@ -9,8 +9,10 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Possible encodings.</summary>
<remarks>
<para />
</remarks>
</Docs>
<Members>
<Member MemberName="GlyphId">
@ -24,7 +26,7 @@
<ReturnType>SkiaSharp.SKTextEncoding</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The buffer contains glyph ids.</summary>
</Docs>
</Member>
<Member MemberName="Utf16">
@ -38,7 +40,7 @@
<ReturnType>SkiaSharp.SKTextEncoding</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The buffer contains UTF-16 encoded characters.</summary>
</Docs>
</Member>
<Member MemberName="Utf32">
@ -52,7 +54,7 @@
<ReturnType>SkiaSharp.SKTextEncoding</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The buffer contains UTF-32 encoded characters.</summary>
</Docs>
</Member>
<Member MemberName="Utf8">
@ -66,7 +68,7 @@
<ReturnType>SkiaSharp.SKTextEncoding</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The buffer contains UTF-8 encoded characters.</summary>
</Docs>
</Member>
</Members>

Просмотреть файл

@ -14,9 +14,9 @@
<remarks>
<para>The SkTypeface class specifies the typeface and intrinsic style of a font.</para>
<para>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).</para>
<para />
<para></para>
<para>Typeface objects are immutable, and so they can be shared between threads.</para>
<para />
<para></para>
</remarks>
</Docs>
<Members>
@ -174,11 +174,15 @@
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<param name="path">To be added.</param>
<param name="index">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="path">path of the file.</param>
<param name="index">The font face index.</param>
<summary>Return a new typeface given a file. </summary>
<returns>
<para />
</returns>
<remarks>
<para>If the file does not exist, or is not a valid font file, returns <paramref name="null" />.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="FromStream">
@ -196,11 +200,13 @@
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<param name="stream">To be added.</param>
<param name="index">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="stream">Input stream</param>
<param name="index">the font face index.</param>
<summary>Return a new typeface given a stream. </summary>
<returns>If the stream is not a valid font file, returns <paramref name="null" />. </returns>
<remarks>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="FromTypeface">

Просмотреть файл

@ -9,8 +9,10 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Specifies the intrinsic style attributes of a given typeface</summary>
<remarks>
<para />
</remarks>
</Docs>
<Members>
<Member MemberName="Bold">
@ -24,7 +26,7 @@
<ReturnType>SkiaSharp.SKTypefaceStyle</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Bold</summary>
</Docs>
</Member>
<Member MemberName="BoldItalic">
@ -38,7 +40,7 @@
<ReturnType>SkiaSharp.SKTypefaceStyle</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Bold and Italic, convenience definition.</summary>
</Docs>
</Member>
<Member MemberName="Italic">
@ -52,7 +54,7 @@
<ReturnType>SkiaSharp.SKTypefaceStyle</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Italic</summary>
</Docs>
</Member>
<Member MemberName="Normal">
@ -66,7 +68,7 @@
<ReturnType>SkiaSharp.SKTypefaceStyle</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Normal</summary>
</Docs>
</Member>
</Members>