This commit is contained in:
Miguel de Icaza 2016-08-11 23:50:00 -04:00
Родитель e646da249f
Коммит 1a9b10d6e4
2 изменённых файлов: 30 добавлений и 31 удалений

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

@ -36,8 +36,7 @@
<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> <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> <remarks>
<para>This constructor does not allocate a backing store for the bitmap.</para> <para>This constructor does not allocate a backing store for the bitmap.</para>
<para> <para></para>
</para>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
@ -71,10 +70,10 @@
<Parameter Name="ctable" Type="SkiaSharp.SKColorTable" /> <Parameter Name="ctable" Type="SkiaSharp.SKColorTable" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="info">To be added.</param> <param name="info">Description of the desired image format.</param>
<param name="ctable">To be added.</param> <param name="ctable">Color lookup table</param>
<summary>To be added.</summary> <summary>Constructor that configures the bitmap based on an <see cref="T:SkiaSharp.SKImageInfo" /> specification and a color table.</summary>
<remarks>To be added.</remarks> <remarks>Use this method to create a bitmap that will use a color lookup table.   The bitmap will be an 8-bit indexed bitmap, where each value represents an index into the color table, and the color is determined by the value in the specific location in the color table array.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -92,8 +91,8 @@
<Parameter Name="rowBytes" Type="System.Int32" /> <Parameter Name="rowBytes" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="info">To be added.</param> <param name="info">Description of the desired image format.</param>
<param name="rowBytes">To be added.</param> <param name="rowBytes">The number of bytes per row.</param>
<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> <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>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> <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> </Docs>
@ -120,8 +119,7 @@
<summary>Creates a bitmap with the given width, height and opacity with color type set to <see cref="E:SkiaSharp.SKColorType.N_32" /></summary> <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> <remarks>
<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>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>
</para>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
@ -166,8 +164,7 @@
<Docs> <Docs>
<summary>Returns the configured alpha type for the bitmap.</summary> <summary>Returns the configured alpha type for the bitmap.</summary>
<value> <value>
<para> <para></para>
</para>
</value> </value>
<remarks>This determines the kind of encoding used for the alpha channel, opaque, premultiplied or unpremultiplied.</remarks> <remarks>This determines the kind of encoding used for the alpha channel, opaque, premultiplied or unpremultiplied.</remarks>
</Docs> </Docs>
@ -304,8 +301,7 @@
<summary>Copies the contents of the bitmap and returns the copy.</summary> <summary>Copies the contents of the bitmap and returns the copy.</summary>
<returns>The copy of the bitmap, or <paramref name="null" /> on error.</returns> <returns>The copy of the bitmap, or <paramref name="null" /> on error.</returns>
<remarks> <remarks>
<para> <para></para>
</para>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
@ -854,8 +850,7 @@
<summary>Returns the address of the pixels for this SKBitmap</summary> <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> <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> <remarks>
<para> <para></para>
</para>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
@ -934,8 +929,7 @@
<value> <value>
<see langword="true" /> if it is immutable, <see langword="false" /> otherwise.</value> <see langword="true" /> if it is immutable, <see langword="false" /> otherwise.</value>
<remarks> <remarks>
<para> <para></para>
</para>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
@ -1125,8 +1119,7 @@
<summary>Call this to balance a previous call to <see cref="M:SkiaSharp.SKBitmap.LockPixels" />.</summary> <summary>Call this to balance a previous call to <see cref="M:SkiaSharp.SKBitmap.LockPixels" />.</summary>
<remarks> <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>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></para>
</para>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>

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

@ -9,8 +9,14 @@
</Base> </Base>
<Interfaces /> <Interfaces />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Holds a color table for indexed 8-bit bitmaps.</summary>
<remarks>To be added.</remarks> <remarks>
<para>This class is used to represent a color lookup table for indexed bitmap images.</para>
<para />
<para>The table can contain up to 256 colors (8 bits).</para>
<para />
<para>The colors are stored are pre-multiplied 32-bit colors.</para>
</remarks>
</Docs> </Docs>
<Members> <Members>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -21,7 +27,7 @@
</AssemblyInfo> </AssemblyInfo>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Creates a new emtpy color table with 256 emtpy elements.</summary>
<remarks>To be added.</remarks> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -36,7 +42,7 @@
</Parameters> </Parameters>
<Docs> <Docs>
<param name="colors">To be added.</param> <param name="colors">To be added.</param>
<summary>To be added.</summary> <summary>Creates a color table with the provided colors, up to 256 colors can be provided.</summary>
<remarks>To be added.</remarks> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -51,7 +57,7 @@
</Parameters> </Parameters>
<Docs> <Docs>
<param name="count">To be added.</param> <param name="count">To be added.</param>
<summary>To be added.</summary> <summary>Creates a color table with the specified number of elements, with empty colors.</summary>
<remarks>To be added.</remarks> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -68,7 +74,7 @@
<Docs> <Docs>
<param name="colors">To be added.</param> <param name="colors">To be added.</param>
<param name="count">To be added.</param> <param name="count">To be added.</param>
<summary>To be added.</summary> <summary>Creates a color table with the provided colors, but only consumes the first count elements from the colors array.</summary>
<remarks>To be added.</remarks> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -82,7 +88,7 @@
<ReturnType>SkiaSharp.SKColor[]</ReturnType> <ReturnType>SkiaSharp.SKColor[]</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>Gets a copy of the colors in the color table.</summary>
<value>To be added.</value> <value>To be added.</value>
<remarks>To be added.</remarks> <remarks>To be added.</remarks>
</Docs> </Docs>
@ -97,7 +103,7 @@
<ReturnType>System.Int32</ReturnType> <ReturnType>System.Int32</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>The number of colors in the lookup table.</summary>
<value>To be added.</value> <value>To be added.</value>
<remarks>To be added.</remarks> <remarks>To be added.</remarks>
</Docs> </Docs>
@ -116,7 +122,7 @@
</Parameters> </Parameters>
<Docs> <Docs>
<param name="disposing">To be added.</param> <param name="disposing">To be added.</param>
<summary>To be added.</summary> <summary>Use this to dispose this object by subclasses.</summary>
<remarks>To be added.</remarks> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -131,7 +137,7 @@
</ReturnValue> </ReturnValue>
<MemberValue>256</MemberValue> <MemberValue>256</MemberValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>The maximum number of colors in the color lookup table.</summary>
<remarks>To be added.</remarks> <remarks>To be added.</remarks>
</Docs> </Docs>
</Member> </Member>
@ -146,7 +152,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Returns an unmanaged pointer to the color lookup table.</summary>
<returns>To be added.</returns> <returns>To be added.</returns>
<remarks>To be added.</remarks> <remarks>To be added.</remarks>
</Docs> </Docs>