unoplatform
/
Uno.SkiaSharp
зеркало из https://github.com/unoplatform/Uno.SkiaSharp.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Updated the docs

This commit is contained in:
Matthew Leibowitz 2017-01-16 09:07:57 +02:00
Родитель d35281556c
Коммит 3fe0a38bcb
4 изменённых файлов: 88 добавлений и 84 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

48
docs/en/SkiaSharp/SKBitmap.xml
Просмотреть файл

@ -1135,10 +1135,12 @@
<Parameter Name="pixmap" Type="SkiaSharp.SKPixmap" /> <Parameter Name="pixmap" Type="SkiaSharp.SKPixmap" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="pixmap">To be added.</param> <param name="pixmap">The pixels to install.</param>
<summary>To be added.</summary> <summary>Installs the specified pixels into the bitmap.</summary>
<returns>To be added.</returns> <returns>Returns true on success, or false on failure. If there was an error, the bitmap will be set to empty.</returns>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="InstallPixels"> <Member MemberName="InstallPixels">
@ -1393,9 +1395,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Returns the pixels if they are available without having to lock the bitmap.</summary>
<returns>To be added.</returns> <returns>Returns the pixels if they are available, otherwise <see langword="null" />.</returns>
<remarks>To be added.</remarks> <remarks>If the pixels are available without locking, then the pixmap is only valid until the bitmap changes in any way, in which case the pixmap becomes invalid.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Pixels"> <Member MemberName="Pixels">
@ -1484,11 +1486,11 @@
<Parameter Name="method" Type="SkiaSharp.SKBitmapResizeMethod" /> <Parameter Name="method" Type="SkiaSharp.SKBitmapResizeMethod" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="dst">To be added.</param> <param name="dst">The bitmap to store the resized pixels.</param>
<param name="method">To be added.</param> <param name="method">The resize method.</param>
<summary>To be added.</summary> <summary>Resizes the current bitmap using the specified resize method.</summary>
<returns>To be added.</returns> <returns>Returns <see langword="true" /> if the resize operation can be performed, otherwise <see langword="false" />.</returns>
<remarks>To be added.</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Resize"> <Member MemberName="Resize">
@ -1506,11 +1508,11 @@
<Parameter Name="method" Type="SkiaSharp.SKBitmapResizeMethod" /> <Parameter Name="method" Type="SkiaSharp.SKBitmapResizeMethod" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="info">To be added.</param> <param name="info">The image information of the desired bitmap.</param>
<param name="method">To be added.</param> <param name="method">The resize method.</param>
<summary>To be added.</summary> <summary>Resizes the current bitmap using the specified resize method.</summary>
<returns>To be added.</returns> <returns>Returns the resized bitmap if the resize operation could be performed, otherwise <see langword="null" />.</returns>
<remarks>To be added.</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Resize"> <Member MemberName="Resize">
@ -1529,12 +1531,12 @@
<Parameter Name="method" Type="SkiaSharp.SKBitmapResizeMethod" /> <Parameter Name="method" Type="SkiaSharp.SKBitmapResizeMethod" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="dst">To be added.</param> <param name="dst">The bitmap to store the resized pixels.</param>
<param name="src">To be added.</param> <param name="src">The bitmap to resize.</param>
<param name="method">To be added.</param> <param name="method">The resize method.</param>
<summary>To be added.</summary> <summary>Resizes the provided bitmap using the specified resize method.</summary>
<returns>To be added.</returns> <returns>Returns <see langword="true" /> if the resize operation can be performed, otherwise <see langword="false" />.</returns>
<remarks>To be added.</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RowBytes"> <Member MemberName="RowBytes">

14
docs/en/SkiaSharp/SKBitmapResizeMethod.xml
Просмотреть файл

@ -9,8 +9,8 @@
<BaseTypeName>System.Enum</BaseTypeName> <BaseTypeName>System.Enum</BaseTypeName>
</Base> </Base>
<Docs> <Docs>
<summary>To be added.</summary> <summary>Channel selector type for the <see cref="M:SkiaSharp.SKBitmap.Resize" /> method or the <see cref="M:SkiaSharp.SKPixmap.Resize" /> method.</summary>
<remarks>To be added.</remarks> <remarks></remarks>
</Docs> </Docs>
<Members> <Members>
<Member MemberName="Box"> <Member MemberName="Box">
@ -24,7 +24,7 @@
<ReturnType>SkiaSharp.SKBitmapResizeMethod</ReturnType> <ReturnType>SkiaSharp.SKBitmapResizeMethod</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>Use the box interpolated filter (Shrink: average color; Grow: pixel replication).</summary>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Hamming"> <Member MemberName="Hamming">
@ -38,7 +38,7 @@
<ReturnType>SkiaSharp.SKBitmapResizeMethod</ReturnType> <ReturnType>SkiaSharp.SKBitmapResizeMethod</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>Use the Hamming windowed Sinc filter (cosine bell variant).</summary>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Lanczos3"> <Member MemberName="Lanczos3">
@ -52,7 +52,7 @@
<ReturnType>SkiaSharp.SKBitmapResizeMethod</ReturnType> <ReturnType>SkiaSharp.SKBitmapResizeMethod</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>Use the Lanczos windowed Sinc filter.</summary>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Mitchell"> <Member MemberName="Mitchell">
@ -66,7 +66,7 @@
<ReturnType>SkiaSharp.SKBitmapResizeMethod</ReturnType> <ReturnType>SkiaSharp.SKBitmapResizeMethod</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>Use the Mitchell cubic filter.</summary>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Triangle"> <Member MemberName="Triangle">
@ -80,7 +80,7 @@
<ReturnType>SkiaSharp.SKBitmapResizeMethod</ReturnType> <ReturnType>SkiaSharp.SKBitmapResizeMethod</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>Use the box triangle or bilinear filter.</summary>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

8
docs/en/SkiaSharp/SKPicture.xml
Просмотреть файл

@ -62,9 +62,11 @@
<ReturnType>SkiaSharp.SKRect</ReturnType> <ReturnType>SkiaSharp.SKRect</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>Gets the culling rectangle for this picture.</summary>
<value>To be added.</value> <value>
<remarks>To be added.</remarks> <para></para>
</value>
<remarks>Operations recorded into this picture that attempt to draw outside the culling rectangle might not be drawn.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Dispose"> <Member MemberName="Dispose">

102
docs/en/SkiaSharp/SKPixmap.xml
Просмотреть файл

@ -10,8 +10,8 @@
</Base> </Base>
<Interfaces /> <Interfaces />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Pairs <see cref="T:SkiaSharp.SKImageInfo" /> with actual pixels and rowbytes.</summary>
<remarks>To be added.</remarks> <remarks>This class does not try to manage the lifetime of the pixel memory (nor the colortable if provided).</remarks>
</Docs> </Docs>
<Members> <Members>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -23,8 +23,8 @@
</AssemblyInfo> </AssemblyInfo>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Creates an empty instance of <see cref="T:SkiaSharp.SKPixmap" />.</summary>
<remarks>To be added.</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -41,12 +41,12 @@
<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">The image information of the pixels.</param>
<param name="addr">To be added.</param> <param name="addr">The memory address of the pixels.</param>
<param name="rowBytes">To be added.</param> <param name="rowBytes">The number of bytes per row.</param>
<param name="ctable">To be added.</param> <param name="ctable">The color table.</param>
<summary>To be added.</summary> <summary>Creates an instance of <see cref="T:SkiaSharp.SKPixmap" />.</summary>
<remarks>To be added.</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="AlphaType"> <Member MemberName="AlphaType">
@ -60,9 +60,9 @@
<ReturnType>SkiaSharp.SKAlphaType</ReturnType> <ReturnType>SkiaSharp.SKAlphaType</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>Gets the alpha type.</summary>
<value>To be added.</value> <value></value>
<remarks>To be added.</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="BytesPerPixel"> <Member MemberName="BytesPerPixel">
@ -76,9 +76,9 @@
<ReturnType>System.Int32</ReturnType> <ReturnType>System.Int32</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>Gets the number of bytes per pixel.</summary>
<value>To be added.</value> <value></value>
<remarks>To be added.</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ColorTable"> <Member MemberName="ColorTable">
@ -92,9 +92,9 @@
<ReturnType>SkiaSharp.SKColorTable</ReturnType> <ReturnType>SkiaSharp.SKColorTable</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>Gets the color table.</summary>
<value>To be added.</value> <value></value>
<remarks>To be added.</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ColorType"> <Member MemberName="ColorType">
@ -108,9 +108,9 @@
<ReturnType>SkiaSharp.SKColorType</ReturnType> <ReturnType>SkiaSharp.SKColorType</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>Gets the color type.</summary>
<value>To be added.</value> <value></value>
<remarks>To be added.</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Dispose"> <Member MemberName="Dispose">
@ -144,9 +144,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Returns the memory address of the pixels.</summary>
<returns>To be added.</returns> <returns></returns>
<remarks>To be added.</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Height"> <Member MemberName="Height">
@ -160,9 +160,9 @@
<ReturnType>System.Int32</ReturnType> <ReturnType>System.Int32</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>Gets the image height.</summary>
<value>To be added.</value> <value></value>
<remarks>To be added.</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Info"> <Member MemberName="Info">
@ -176,9 +176,9 @@
<ReturnType>SkiaSharp.SKImageInfo</ReturnType> <ReturnType>SkiaSharp.SKImageInfo</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>Gets the image info.</summary>
<value>To be added.</value> <value></value>
<remarks>To be added.</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Reset"> <Member MemberName="Reset">
@ -193,8 +193,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Reset the pixmap to an empty pixmap.</summary>
<remarks>To be added.</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Reset"> <Member MemberName="Reset">
@ -214,12 +214,12 @@
<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">The image information of the pixels.</param>
<param name="addr">To be added.</param> <param name="addr">The memory address of the pixels.</param>
<param name="rowBytes">To be added.</param> <param name="rowBytes">The number of bytes per row.</param>
<param name="ctable">To be added.</param> <param name="ctable">The color table.</param>
<summary>To be added.</summary> <summary>Resets the pixmap to the specified pixels.</summary>
<remarks>To be added.</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Resize"> <Member MemberName="Resize">
@ -238,12 +238,12 @@
<Parameter Name="method" Type="SkiaSharp.SKBitmapResizeMethod" /> <Parameter Name="method" Type="SkiaSharp.SKBitmapResizeMethod" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="dst">To be added.</param> <param name="dst">The pixmap to store the resized pixels.</param>
<param name="src">To be added.</param> <param name="src">The pixmap to resize.</param>
<param name="method">To be added.</param> <param name="method">The resize method.</param>
<summary>To be added.</summary> <summary>Resize the specified pixmap using the specified method.</summary>
<returns>To be added.</returns> <returns>Returns <see langword="true" /> if the resize operation can be performed, otherwise <see langword="false" />.</returns>
<remarks>To be added.</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RowBytes"> <Member MemberName="RowBytes">
@ -257,9 +257,9 @@
<ReturnType>System.Int32</ReturnType> <ReturnType>System.Int32</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>Gets the number of bytes per row.</summary>
<value>To be added.</value> <value></value>
<remarks>To be added.</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Width"> <Member MemberName="Width">
@ -273,9 +273,9 @@
<ReturnType>System.Int32</ReturnType> <ReturnType>System.Int32</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>Gets the image width.</summary>
<value>To be added.</value> <value></value>
<remarks>To be added.</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>