Docs update

docs/en/SkiaSharp/SKAlphaType.xml

@@ -11,7 +11,7 @@
   <Docs>
     <summary>Describes how to interpret the alpha component of a pixel.</summary>
     <remarks>
-      <para />
+      <para></para>
     </remarks>
   </Docs>
   <Members>

docs/en/SkiaSharp/SKBitmap.xml

@@ -13,8 +13,8 @@
     <summary>Raster bitmap.</summary>
     <remarks>
       <para>This class specifies a raster bitmap. A bitmap has an integer width and height, and a format (colortype), and a pointer to the actual pixels. Bitmaps can be drawn into a <see cref="T:SkiaSharp.SKCanvas" />, but they are also used to specify the target of a <see cref="T:SkiaSharp.SKCanvas" />' drawing operations.</para>
-      <para>    </para>
       <para>An SkBitmap exposes, which lets a caller write its pixels; the constness is considered to apply to the bitmap's configuration, not its contents.</para>
+      <para>To retrive a pointer to the raw image data of the SKBitmap, call the <see cref="M:SkiaSharp.SKBitmap.LockPixels" /> method, and then call the <see cref="M:SkiaSharp.SKBitmap.GetPixels" /> method to get a pointer to the image data.  Once you no longer need to use the raw data pointer, call the <see cref="M:SkiaSharp.SKBitmap.UnlockPixels" /> method.   The raw data is laid out in the format configured at the time that the SKBitmap was created.</para>
     </remarks>
   </Docs>
   <Members>
@@ -29,8 +29,8 @@
       <Docs>
         <summary>Default construct creates a bitmap with zero width and height, and no pixels. Its colortype is set to <see cref="E:SkiaSharp.SKColorType.Unknown." /></summary>
         <remarks>
-          <para>
+          <para>This constructor does not allocate a backing store for the bitmap.</para>
-          </para>
+          <para></para>
         </remarks>
       </Docs>
     </Member>
@@ -45,9 +45,9 @@
         <Parameter Name="info" Type="SkiaSharp.SKImageInfo" />
       </Parameters>
       <Docs>
-        <param name="info">To be added.</param>
+        <param name="info">Description of the desired image format.</param>
-        <summary>To be added.</summary>
+        <summary>Constructor that configures the bitmap based on an <see cref="T:SkiaSharp.SKImageInfo" /> specification.</summary>
-        <remarks>To be added.</remarks>
+        <remarks>This constructor might throw an exception if it is not possible to create a bitmap with the specified configuration (for example, the image info requires a color table, and there is no color table).</remarks>
       </Docs>
     </Member>
     <Member MemberName=".ctor">
@@ -64,8 +64,8 @@
       <Docs>
         <param name="info">To be added.</param>
         <param name="rowBytes">To be added.</param>
-        <summary>To be added.</summary>
+        <summary>Constructor that configures the bitmap based on an <see cref="T:SkiaSharp.SKImageInfo" /> specification, and the specified number of bytes per row (the stride size)</summary>
-        <remarks>To be added.</remarks>
+        <remarks>This constructor might throw an exception if it is not possible to create a bitmap with the specified configuration (for example, the image info requires a color table, and there is no color table).</remarks>
       </Docs>
     </Member>
     <Member MemberName=".ctor">
@@ -86,8 +86,8 @@
         <param name="isOpaque">If true, sets the <see cref="T:SkiaSharp.SKAlphaType" /> to Opaque, otherwise it sets it to Premul</param>
         <summary>Creates a bitmap with the given width, height and opacity with color type set to <see cref="E:SkiaSharp.SKColorType.N_32" /></summary>
         <remarks>
-          <para>
+          <para>This constructor might throw an exception if it is not possible to create a bitmap with the specified configuration (for example, the image info requires a color table, and there is no color table).</para>
-          </para>
+          <para></para>
         </remarks>
       </Docs>
     </Member>
@@ -110,7 +110,7 @@
         <param name="colorType">The desired color type.</param>
         <param name="alphaType">The desired alpha type.</param>
         <summary>Creates a bitmap with the given width, height, color type and alpha type.</summary>
-        <remarks>To be added.</remarks>
+        <remarks>This constructor might throw an exception if it is not possible to create a bitmap with the specified configuration (for example, the image info requires a color table, and there is no color table).</remarks>
       </Docs>
     </Member>
     <Member MemberName="AlphaType">
@@ -124,9 +124,11 @@
         <ReturnType>SkiaSharp.SKAlphaType</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Returns the configured alpha type for the bitmap.</summary>
-        <value>To be added.</value>
+        <value>
-        <remarks>To be added.</remarks>
+          <para />
+        </value>
+        <remarks>This determines the kind of encoding used for the alpha channel, opaque, premultiplied or unpremultiplied.</remarks>
       </Docs>
     </Member>
     <Member MemberName="ByteCount">
@@ -225,9 +227,11 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Copies the contents of the bitmap and returns the copy.</summary>
-        <returns>To be added.</returns>
+        <returns>The copy of the bitmap, or <paramref name="null" /> on error.</returns>
-        <remarks>To be added.</remarks>
+        <remarks>
+          <para></para>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="Copy">
@@ -244,10 +248,12 @@
         <Parameter Name="colorType" Type="SkiaSharp.SKColorType" />
       </Parameters>
       <Docs>
-        <param name="colorType">To be added.</param>
+        <param name="colorType">The color type to use for the copy of the bitmap.</param>
-        <summary>To be added.</summary>
+        <summary>Copies the contents of the bitmap with the specified color type and returns the copy.</summary>
-        <returns>To be added.</returns>
+        <returns>The copy of the bitmap, or <paramref name="null" /> on error.</returns>
-        <remarks>To be added.</remarks>
+        <remarks>
+          <para />
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="CopyTo">
@@ -514,11 +520,33 @@
         <Parameter Name="y" Type="System.Int32" />
       </Parameters>
       <Docs>
-        <param name="x">To be added.</param>
+        <param name="x">X coordinate</param>
-        <param name="y">To be added.</param>
+        <param name="y">Y coordinate</param>
-        <summary>To be added.</summary>
+        <summary>Returns the color for the pixel at the specified location</summary>
-        <returns>To be added.</returns>
+        <returns>Alpha only colortypes return black with the appropriate alpha set.  The value is undefined for the Unknown SkColorType or if x or y are out of bounds, or if the bitmap does not have any pixels (or has not be locked with <see cref="M:SkiaSharp.SKBitmap.LockPixels" />)</returns>
-        <remarks>To be added.</remarks>
+        <remarks>In most cases this will require un-premultiplying the color.  </remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="GetPixels">
+      <MemberSignature Language="C#" Value="public IntPtr GetPixels (out IntPtr length);" />
+      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance native int GetPixels(native int length) cil managed" />
+      <MemberType>Method</MemberType>
+      <AssemblyInfo>
+        <AssemblyVersion>1.0.0.0</AssemblyVersion>
+      </AssemblyInfo>
+      <ReturnValue>
+        <ReturnType>System.IntPtr</ReturnType>
+      </ReturnValue>
+      <Parameters>
+        <Parameter Name="length" Type="System.IntPtr&amp;" RefType="out" />
+      </Parameters>
+      <Docs>
+        <param name="length">The lenght of the pixel buffer returned.</param>
+        <summary>Returns the address of the pixels for this SKBitmap</summary>
+        <returns>Returns a pointer to the region that contains the pixel data for this bitmap.   This might return <see langword="null" /> if there is no pixel buffer associated with this bitmap.</returns>
+        <remarks>
+          <para></para>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="Height">
@@ -580,9 +608,12 @@
         <ReturnType>System.Boolean</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Indicates if the bitmap contents are immutable, meaning that the contents of its pixels will not change for the lifetime of the bitmap.</summary>
-        <value>To be added.</value>
+        <value>
-        <remarks>To be added.</remarks>
+          <see langword="true" /> if it is immutable, <see langword="false" /> otherwise.</value>
+        <remarks>
+          <para></para>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="IsNull">
@@ -617,6 +648,25 @@
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
+    <Member MemberName="LockPixels">
+      <MemberSignature Language="C#" Value="public void LockPixels ();" />
+      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void LockPixels() cil managed" />
+      <MemberType>Method</MemberType>
+      <AssemblyInfo>
+        <AssemblyVersion>1.0.0.0</AssemblyVersion>
+      </AssemblyInfo>
+      <ReturnValue>
+        <ReturnType>System.Void</ReturnType>
+      </ReturnValue>
+      <Parameters />
+      <Docs>
+        <summary>Call this to ensure that the bitmap points to the current pixel address in the pixelref. </summary>
+        <remarks>
+          <para>This allows pixelrefs that implement cached/deferred image decoding to know when there are active clients of a given image.</para>
+          <para>Balance it with a call to <see cref="M:SkiaSharp.SKBitmap.UnlockPixels" />. These calls are harmless if there is no pixelref.</para>
+        </remarks>
+      </Docs>
+    </Member>
     <Member MemberName="Pixels">
       <MemberSignature Language="C#" Value="public SkiaSharp.SKColor[] Pixels { get; set; }" />
       <MemberSignature Language="ILAsm" Value=".property instance valuetype SkiaSharp.SKColor[] Pixels" />
@@ -645,8 +695,12 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
+        <summary>
-        <remarks>To be added.</remarks>
+          <para>Reset the bitmap to its initial state (see default constructor). </para>
+        </summary>
+        <remarks>
+          <para>If we are a (shared) owner of the pixels, that ownership is decremented.</para>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="RowBytes">
@@ -677,8 +731,10 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Marks the bitmap as immutable.</summary>
-        <remarks>To be added.</remarks>
+        <remarks>
+          <para>Marks this bitmap as immutable, meaning that the contents of its pixels will not change for the lifetime of the bitmap and of the underlying pixelref. This state can be set, but it cannot be cleared once it is set. This state propagates to all other bitmaps that share the same pixelref.</para>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="SetPixel">
@@ -697,11 +753,30 @@
         <Parameter Name="color" Type="SkiaSharp.SKColor" />
       </Parameters>
       <Docs>
-        <param name="x">To be added.</param>
+        <param name="x">X coordinate</param>
-        <param name="y">To be added.</param>
+        <param name="y">Y coordinat</param>
-        <param name="color">To be added.</param>
+        <param name="color">Color to set</param>
-        <summary>To be added.</summary>
+        <summary>Sets the color of the pixel at a specified location.</summary>
-        <remarks>To be added.</remarks>
+        <remarks>This method will set the color of the pixel on the bitmap to the specified <paramref name="color" /> performing any necessary color conversions to the format of the bitmap.</remarks>
+      </Docs>
+    </Member>
+    <Member MemberName="UnlockPixels">
+      <MemberSignature Language="C#" Value="public void UnlockPixels ();" />
+      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void UnlockPixels() cil managed" />
+      <MemberType>Method</MemberType>
+      <AssemblyInfo>
+        <AssemblyVersion>1.0.0.0</AssemblyVersion>
+      </AssemblyInfo>
+      <ReturnValue>
+        <ReturnType>System.Void</ReturnType>
+      </ReturnValue>
+      <Parameters />
+      <Docs>
+        <summary>Call this to balance a previous call to <see cref="M:SkiaSharp.SKBitmap.LockPixels" />.</summary>
+        <remarks>
+          <para>When you are finished access the pixel memory, call this to balance a previous call to <see cref="M:SkiaSharp.SKBitmap.LockPixels" />. This allows pixelrefs that implement cached/deferred image decoding to know when there are active clients of a given image.</para>
+          <para></para>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="Width">

docs/en/SkiaSharp/SKBlurStyle.xml

@@ -11,8 +11,7 @@
   <Docs>
     <summary>Blur types for the <see cref="M:SkiaSharp.SKMaskFilteter.CreateBlur" /> method.</summary>
     <remarks>
-      <para>
+      <para></para>
-      </para>
     </remarks>
   </Docs>
   <Members>

docs/en/SkiaSharp/SKColor.xml

@@ -13,7 +13,7 @@
     <summary>32 bit ARGB color value, not premultiplied. </summary>
     <remarks>
       <para>The color components are always in a known order. </para>
-      <para />
+      <para></para>
       <para>SkColor is the type used to specify colors in SkPaint and in gradients.</para>
     </remarks>
   </Docs>

docs/en/SkiaSharp/SKColorFilter.xml

@@ -12,8 +12,7 @@
   <Docs>
     <summary>Color filters for use in an <see cref="T:SkiaSharp.SKPaint" />.</summary>
     <remarks>
-      <para>
+      <para></para>
-      </para>
     </remarks>
   </Docs>
   <Members>

docs/en/SkiaSharp/SKColorType.xml

@@ -11,8 +11,7 @@
   <Docs>
     <summary>Describes how to interpret the components of a pixel.</summary>
     <remarks>
-      <para>
+      <para></para>
-      </para>
     </remarks>
   </Docs>
   <Members>

docs/en/SkiaSharp/SKColors.xml

@@ -12,7 +12,7 @@
   <Docs>
     <summary>Definitions for some common color names.</summary>
     <remarks>
-      <para />
+      <para></para>
     </remarks>
   </Docs>
   <Members>

docs/en/SkiaSharp/SKCropRectFlags.xml

@@ -16,7 +16,7 @@
   <Docs>
     <summary>Flags used by the <see cref="T:SkiaSharp.SKImageFilter.CropRect" /> method.</summary>
     <remarks>
-      <para />
+      <para></para>
     </remarks>
   </Docs>
   <Members>

docs/en/SkiaSharp/SKData.xml

@@ -14,8 +14,7 @@
     <remarks>
       <para>Not only is the data immutable, but the actual pointer that is returned by the <see cref="P:SkiaSharp.SKData.Data" /> property is guaranteed to always be the same for the life of this instance.</para>
       <para>The <see cref="M:SkiaSharp.SKData.AsStream" /> method can be used to return a <see cref="T:System.IO.Stream" /> that wraps this SKData and allows for .NET APIs to scan the contents of the SKData as a stream.</para>
-      <para>
+      <para></para>
-      </para>
       <para>You can use the constructors for this object to make copies of the data, or you can use the <see cref="M:SkiaSharp.SKData.FromMallocMemory" /> to wrap a block of memory that has been allocated with the platform malloc function.</para>
     </remarks>
   </Docs>
@@ -49,8 +48,7 @@
         <param name="bytes">Array of bytes that will be copied.</param>
         <summary>Creates an SKData by copying the provided byte array.</summary>
         <remarks>
-          <para>
+          <para></para>
-          </para>
         </remarks>
       </Docs>
     </Member>
@@ -70,8 +68,7 @@
         <param name="length">Length of the buffer.</param>
         <summary>Creates an SKData by copying the provided byte buffer for the specified length.</summary>
         <remarks>
-          <para>
+          <para></para>
-          </para>
         </remarks>
       </Docs>
     </Member>

docs/en/SkiaSharp/SKDropShadowImageFilterShadowMode.xml

@@ -13,20 +13,6 @@
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
-    <Member MemberName="DawShadowOnly">
-      <MemberSignature Language="C#" Value="DawShadowOnly" />
-      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype SkiaSharp.SKDropShadowImageFilterShadowMode DawShadowOnly = int32(1)" />
-      <MemberType>Field</MemberType>
-      <AssemblyInfo>
-        <AssemblyVersion>1.0.0.0</AssemblyVersion>
-      </AssemblyInfo>
-      <ReturnValue>
-        <ReturnType>SkiaSharp.SKDropShadowImageFilterShadowMode</ReturnType>
-      </ReturnValue>
-      <Docs>
-        <summary>To be added.</summary>
-      </Docs>
-    </Member>
     <Member MemberName="DrawShadowAndForeground">
       <MemberSignature Language="C#" Value="DrawShadowAndForeground" />
       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype SkiaSharp.SKDropShadowImageFilterShadowMode DrawShadowAndForeground = int32(0)" />
@@ -41,5 +27,19 @@
         <summary>To be added.</summary>
       </Docs>
     </Member>
+    <Member MemberName="DrawShadowOnly">
+      <MemberSignature Language="C#" Value="DrawShadowOnly" />
+      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype SkiaSharp.SKDropShadowImageFilterShadowMode DrawShadowOnly = int32(1)" />
+      <MemberType>Field</MemberType>
+      <AssemblyInfo>
+        <AssemblyVersion>1.0.0.0</AssemblyVersion>
+      </AssemblyInfo>
+      <ReturnValue>
+        <ReturnType>SkiaSharp.SKDropShadowImageFilterShadowMode</ReturnType>
+      </ReturnValue>
+      <Docs>
+        <summary>To be added.</summary>
+      </Docs>
+    </Member>
   </Members>
 </Type>

docs/en/SkiaSharp/SKImage.xml

@@ -13,11 +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>
       <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>
       <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>
@@ -60,6 +58,26 @@
         </remarks>
       </Docs>
     </Member>
+    <Member MemberName="FromData">
+      <MemberSignature Language="C#" Value="public static SkiaSharp.SKImage FromData (SkiaSharp.SKData data);" />
+      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKImage FromData(class SkiaSharp.SKData data) cil managed" />
+      <MemberType>Method</MemberType>
+      <AssemblyInfo>
+        <AssemblyVersion>1.0.0.0</AssemblyVersion>
+      </AssemblyInfo>
+      <ReturnValue>
+        <ReturnType>SkiaSharp.SKImage</ReturnType>
+      </ReturnValue>
+      <Parameters>
+        <Parameter Name="data" Type="SkiaSharp.SKData" />
+      </Parameters>
+      <Docs>
+        <param name="data">Data holding the encoded image.</param>
+        <summary>Creates an SKImage from an encoded image wrapped by the data.</summary>
+        <returns>The decoded image, or <see langword="null" /> on error.</returns>
+        <remarks>To be added.</remarks>
+      </Docs>
+    </Member>
     <Member MemberName="FromData">
       <MemberSignature Language="C#" Value="public static SkiaSharp.SKImage FromData (SkiaSharp.SKData data, SkiaSharp.SKRectI subset);" />
       <MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKImage FromData(class SkiaSharp.SKData data, valuetype SkiaSharp.SKRectI subset) cil managed" />
@@ -80,7 +98,7 @@
         <summary>Creates an SKImage from an encoded image wrapped by the data.</summary>
         <returns>The decoded image, or <see langword="null" /> on error.</returns>
         <remarks>
-          <para />
+          <para></para>
         </remarks>
       </Docs>
     </Member>

docs/en/SkiaSharp/SKPaint.xml

@@ -10,7 +10,7 @@
   </Base>
   <Interfaces />
   <Docs>
-    <summary>The SKPaint class holds the style and color information about how to draw geometries, text and bitmaps.</summary>
+    <summary />
     <remarks />
   </Docs>
   <Members>

docs/en/SkiaSharp/SKShader.xml

@@ -13,8 +13,7 @@
     <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></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>