Skip to content

Commit 644c51e

Browse files
mattleibowmattleibow
committed
Update the docs
1 parent 25f56b9 commit 644c51e

21 files changed

+1485
-53
lines changed

‎SkiaSharpAPI/FrameworksIndex/skiasharp-1.68.2.xml

+50
Large diffs are not rendered by default.

‎SkiaSharpAPI/SkiaSharp/GRContext.xml

+4-1
Original file line numberDiff line numberDiff line change
@@ -363,12 +363,15 @@
363363
<AssemblyVersion>1.68.0.0</AssemblyVersion>
364364
</AssemblyInfo>
365365
<Attributes>
366-
<Attribute FrameworkAlternate="skiasharp-1.68.0;skiasharp-1.68.1;skiasharp-1.68.2">
366+
<Attribute FrameworkAlternate="skiasharp-1.68.0;skiasharp-1.68.1">
367367
<AttributeName>System.Obsolete("Use GetMaxSurfaceSampleCount(SKColorType) instead.")</AttributeName>
368368
</Attribute>
369369
<Attribute FrameworkAlternate="skiasharp-1.68.2">
370370
<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
371371
</Attribute>
372+
<Attribute FrameworkAlternate="skiasharp-1.68.2">
373+
<AttributeName>System.Obsolete</AttributeName>
374+
</Attribute>
372375
</Attributes>
373376
<ReturnValue>
374377
<ReturnType>System.Int32</ReturnType>

‎SkiaSharpAPI/SkiaSharp/SKBitmap.xml

+143-4
Original file line numberDiff line numberDiff line change
@@ -681,6 +681,28 @@
681681
<remarks></remarks>
682682
</Docs>
683683
</Member>
684+
<Member MemberName="Decode">
685+
<MemberSignature Language="C#" Value="public static SkiaSharp.SKBitmap Decode (ReadOnlySpan&lt;byte&gt; buffer);" />
686+
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKBitmap Decode(valuetype System.ReadOnlySpan`1&lt;unsigned int8&gt; buffer) cil managed" />
687+
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKBitmap.Decode(System.ReadOnlySpan{System.Byte})" />
688+
<MemberType>Method</MemberType>
689+
<AssemblyInfo>
690+
<AssemblyName>SkiaSharp</AssemblyName>
691+
<AssemblyVersion>1.68.0.0</AssemblyVersion>
692+
</AssemblyInfo>
693+
<ReturnValue>
694+
<ReturnType>SkiaSharp.SKBitmap</ReturnType>
695+
</ReturnValue>
696+
<Parameters>
697+
<Parameter Name="buffer" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="0" FrameworkAlternate="skiasharp-1.68.2" />
698+
</Parameters>
699+
<Docs>
700+
<param name="buffer">To be added.</param>
701+
<summary>To be added.</summary>
702+
<returns>To be added.</returns>
703+
<remarks>To be added.</remarks>
704+
</Docs>
705+
</Member>
684706
<Member MemberName="Decode">
685707
<MemberSignature Language="C#" Value="public static SkiaSharp.SKBitmap Decode (string filename);" />
686708
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKBitmap Decode(string filename) cil managed" />
@@ -847,6 +869,30 @@
847869
<remarks></remarks>
848870
</Docs>
849871
</Member>
872+
<Member MemberName="Decode">
873+
<MemberSignature Language="C#" Value="public static SkiaSharp.SKBitmap Decode (ReadOnlySpan&lt;byte&gt; buffer, SkiaSharp.SKImageInfo bitmapInfo);" />
874+
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKBitmap Decode(valuetype System.ReadOnlySpan`1&lt;unsigned int8&gt; buffer, valuetype SkiaSharp.SKImageInfo bitmapInfo) cil managed" />
875+
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKBitmap.Decode(System.ReadOnlySpan{System.Byte},SkiaSharp.SKImageInfo)" />
876+
<MemberType>Method</MemberType>
877+
<AssemblyInfo>
878+
<AssemblyName>SkiaSharp</AssemblyName>
879+
<AssemblyVersion>1.68.0.0</AssemblyVersion>
880+
</AssemblyInfo>
881+
<ReturnValue>
882+
<ReturnType>SkiaSharp.SKBitmap</ReturnType>
883+
</ReturnValue>
884+
<Parameters>
885+
<Parameter Name="buffer" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="0" FrameworkAlternate="skiasharp-1.68.2" />
886+
<Parameter Name="bitmapInfo" Type="SkiaSharp.SKImageInfo" Index="1" FrameworkAlternate="skiasharp-1.68.2" />
887+
</Parameters>
888+
<Docs>
889+
<param name="buffer">To be added.</param>
890+
<param name="bitmapInfo">To be added.</param>
891+
<summary>To be added.</summary>
892+
<returns>To be added.</returns>
893+
<remarks>To be added.</remarks>
894+
</Docs>
895+
</Member>
850896
<Member MemberName="Decode">
851897
<MemberSignature Language="C#" Value="public static SkiaSharp.SKBitmap Decode (string filename, SkiaSharp.SKImageInfo bitmapInfo);" />
852898
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class SkiaSharp.SKBitmap Decode(string filename, valuetype SkiaSharp.SKImageInfo bitmapInfo) cil managed" />
@@ -979,6 +1025,28 @@
9791025
<remarks></remarks>
9801026
</Docs>
9811027
</Member>
1028+
<Member MemberName="DecodeBounds">
1029+
<MemberSignature Language="C#" Value="public static SkiaSharp.SKImageInfo DecodeBounds (ReadOnlySpan&lt;byte&gt; buffer);" />
1030+
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype SkiaSharp.SKImageInfo DecodeBounds(valuetype System.ReadOnlySpan`1&lt;unsigned int8&gt; buffer) cil managed" />
1031+
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKBitmap.DecodeBounds(System.ReadOnlySpan{System.Byte})" />
1032+
<MemberType>Method</MemberType>
1033+
<AssemblyInfo>
1034+
<AssemblyName>SkiaSharp</AssemblyName>
1035+
<AssemblyVersion>1.68.0.0</AssemblyVersion>
1036+
</AssemblyInfo>
1037+
<ReturnValue>
1038+
<ReturnType>SkiaSharp.SKImageInfo</ReturnType>
1039+
</ReturnValue>
1040+
<Parameters>
1041+
<Parameter Name="buffer" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="0" FrameworkAlternate="skiasharp-1.68.2" />
1042+
</Parameters>
1043+
<Docs>
1044+
<param name="buffer">To be added.</param>
1045+
<summary>To be added.</summary>
1046+
<returns>To be added.</returns>
1047+
<remarks>To be added.</remarks>
1048+
</Docs>
1049+
</Member>
9821050
<Member MemberName="DecodeBounds">
9831051
<MemberSignature Language="C#" Value="public static SkiaSharp.SKImageInfo DecodeBounds (string filename);" />
9841052
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype SkiaSharp.SKImageInfo DecodeBounds(string filename) cil managed" />
@@ -1071,6 +1139,30 @@
10711139
<remarks></remarks>
10721140
</Docs>
10731141
</Member>
1142+
<Member MemberName="Encode">
1143+
<MemberSignature Language="C#" Value="public SkiaSharp.SKData Encode (SkiaSharp.SKEncodedImageFormat format, int quality);" />
1144+
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class SkiaSharp.SKData Encode(valuetype SkiaSharp.SKEncodedImageFormat format, int32 quality) cil managed" />
1145+
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKBitmap.Encode(SkiaSharp.SKEncodedImageFormat,System.Int32)" />
1146+
<MemberType>Method</MemberType>
1147+
<AssemblyInfo>
1148+
<AssemblyName>SkiaSharp</AssemblyName>
1149+
<AssemblyVersion>1.68.0.0</AssemblyVersion>
1150+
</AssemblyInfo>
1151+
<ReturnValue>
1152+
<ReturnType>SkiaSharp.SKData</ReturnType>
1153+
</ReturnValue>
1154+
<Parameters>
1155+
<Parameter Name="format" Type="SkiaSharp.SKEncodedImageFormat" Index="0" FrameworkAlternate="skiasharp-1.68.2" />
1156+
<Parameter Name="quality" Type="System.Int32" Index="1" FrameworkAlternate="skiasharp-1.68.2" />
1157+
</Parameters>
1158+
<Docs>
1159+
<param name="format">To be added.</param>
1160+
<param name="quality">To be added.</param>
1161+
<summary>To be added.</summary>
1162+
<returns>To be added.</returns>
1163+
<remarks>To be added.</remarks>
1164+
</Docs>
1165+
</Member>
10741166
<Member MemberName="Encode">
10751167
<MemberSignature Language="C#" Value="public bool Encode (SkiaSharp.SKWStream dst, SkiaSharp.SKEncodedImageFormat format, int quality);" />
10761168
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Encode(class SkiaSharp.SKWStream dst, valuetype SkiaSharp.SKEncodedImageFormat format, int32 quality) cil managed" />
@@ -1085,12 +1177,9 @@
10851177
<AssemblyVersion>1.68.0.0</AssemblyVersion>
10861178
</AssemblyInfo>
10871179
<Attributes>
1088-
<Attribute FrameworkAlternate="skiasharp-1.60.2;skiasharp-1.60.3;skiasharp-1.68.0;skiasharp-1.68.1;skiasharp-1.68.2">
1180+
<Attribute FrameworkAlternate="skiasharp-1.60.2;skiasharp-1.60.3;skiasharp-1.68.0;skiasharp-1.68.1">
10891181
<AttributeName>System.Obsolete("Use SKPixmap.Encode instead.")</AttributeName>
10901182
</Attribute>
1091-
<Attribute FrameworkAlternate="skiasharp-1.68.2">
1092-
<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
1093-
</Attribute>
10941183
</Attributes>
10951184
<ReturnValue>
10961185
<ReturnType>System.Boolean</ReturnType>
@@ -1109,6 +1198,32 @@
11091198
<remarks></remarks>
11101199
</Docs>
11111200
</Member>
1201+
<Member MemberName="Encode">
1202+
<MemberSignature Language="C#" Value="public bool Encode (System.IO.Stream dst, SkiaSharp.SKEncodedImageFormat format, int quality);" />
1203+
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Encode(class System.IO.Stream dst, valuetype SkiaSharp.SKEncodedImageFormat format, int32 quality) cil managed" />
1204+
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKBitmap.Encode(System.IO.Stream,SkiaSharp.SKEncodedImageFormat,System.Int32)" />
1205+
<MemberType>Method</MemberType>
1206+
<AssemblyInfo>
1207+
<AssemblyName>SkiaSharp</AssemblyName>
1208+
<AssemblyVersion>1.68.0.0</AssemblyVersion>
1209+
</AssemblyInfo>
1210+
<ReturnValue>
1211+
<ReturnType>System.Boolean</ReturnType>
1212+
</ReturnValue>
1213+
<Parameters>
1214+
<Parameter Name="dst" Type="System.IO.Stream" Index="0" FrameworkAlternate="skiasharp-1.68.2" />
1215+
<Parameter Name="format" Type="SkiaSharp.SKEncodedImageFormat" Index="1" FrameworkAlternate="skiasharp-1.68.2" />
1216+
<Parameter Name="quality" Type="System.Int32" Index="2" FrameworkAlternate="skiasharp-1.68.2" />
1217+
</Parameters>
1218+
<Docs>
1219+
<param name="dst">To be added.</param>
1220+
<param name="format">To be added.</param>
1221+
<param name="quality">To be added.</param>
1222+
<summary>To be added.</summary>
1223+
<returns>To be added.</returns>
1224+
<remarks>To be added.</remarks>
1225+
</Docs>
1226+
</Member>
11121227
<Member MemberName="Erase">
11131228
<MemberSignature Language="C#" Value="public void Erase (SkiaSharp.SKColor color);" />
11141229
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Erase(valuetype SkiaSharp.SKColor color) cil managed" />
@@ -2211,6 +2326,30 @@
22112326
<remarks></remarks>
22122327
</Docs>
22132328
</Member>
2329+
<Member MemberName="Resize">
2330+
<MemberSignature Language="C#" Value="public SkiaSharp.SKBitmap Resize (SkiaSharp.SKSizeI size, SkiaSharp.SKFilterQuality quality);" />
2331+
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class SkiaSharp.SKBitmap Resize(valuetype SkiaSharp.SKSizeI size, valuetype SkiaSharp.SKFilterQuality quality) cil managed" />
2332+
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKBitmap.Resize(SkiaSharp.SKSizeI,SkiaSharp.SKFilterQuality)" />
2333+
<MemberType>Method</MemberType>
2334+
<AssemblyInfo>
2335+
<AssemblyName>SkiaSharp</AssemblyName>
2336+
<AssemblyVersion>1.68.0.0</AssemblyVersion>
2337+
</AssemblyInfo>
2338+
<ReturnValue>
2339+
<ReturnType>SkiaSharp.SKBitmap</ReturnType>
2340+
</ReturnValue>
2341+
<Parameters>
2342+
<Parameter Name="size" Type="SkiaSharp.SKSizeI" Index="0" FrameworkAlternate="skiasharp-1.68.2" />
2343+
<Parameter Name="quality" Type="SkiaSharp.SKFilterQuality" Index="1" FrameworkAlternate="skiasharp-1.68.2" />
2344+
</Parameters>
2345+
<Docs>
2346+
<param name="size">To be added.</param>
2347+
<param name="quality">To be added.</param>
2348+
<summary>To be added.</summary>
2349+
<returns>To be added.</returns>
2350+
<remarks>To be added.</remarks>
2351+
</Docs>
2352+
</Member>
22142353
<Member MemberName="Resize">
22152354
<MemberSignature Language="C#" Value="public static bool Resize (SkiaSharp.SKBitmap dst, SkiaSharp.SKBitmap src, SkiaSharp.SKBitmapResizeMethod method);" />
22162355
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool Resize(class SkiaSharp.SKBitmap dst, class SkiaSharp.SKBitmap src, valuetype SkiaSharp.SKBitmapResizeMethod method) cil managed" />

‎SkiaSharpAPI/SkiaSharp/SKCanvas.xml

+19
Original file line numberDiff line numberDiff line change
@@ -3810,6 +3810,25 @@ safely ignored.
38103810
<remarks>This will equal the number of <see cref="M:SkiaSharp.SKCanvas.Save" /> calls minus <see cref="M:SkiaSharp.SKCanvas.Restore" /> calls + 1. The save count on a new canvas is 1.</remarks>
38113811
</Docs>
38123812
</Member>
3813+
<Member MemberName="SaveLayer">
3814+
<MemberSignature Language="C#" Value="public int SaveLayer ();" />
3815+
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance int32 SaveLayer() cil managed" />
3816+
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKCanvas.SaveLayer" />
3817+
<MemberType>Method</MemberType>
3818+
<AssemblyInfo>
3819+
<AssemblyName>SkiaSharp</AssemblyName>
3820+
<AssemblyVersion>1.68.0.0</AssemblyVersion>
3821+
</AssemblyInfo>
3822+
<ReturnValue>
3823+
<ReturnType>System.Int32</ReturnType>
3824+
</ReturnValue>
3825+
<Parameters />
3826+
<Docs>
3827+
<summary>To be added.</summary>
3828+
<returns>To be added.</returns>
3829+
<remarks>To be added.</remarks>
3830+
</Docs>
3831+
</Member>
38133832
<Member MemberName="SaveLayer">
38143833
<MemberSignature Language="C#" Value="public int SaveLayer (SkiaSharp.SKPaint paint);" />
38153834
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance int32 SaveLayer(class SkiaSharp.SKPaint paint) cil managed" />

‎SkiaSharpAPI/SkiaSharp/SKColor.xml

+3-7
Original file line numberDiff line numberDiff line change
@@ -187,11 +187,9 @@
187187
</Docs>
188188
</Member>
189189
<Member MemberName="Equals">
190-
<MemberSignature Language="C#" Value="public override bool Equals (object other);" FrameworkAlternate="skiasharp-1.57.0;skiasharp-1.57.1;skiasharp-1.58.0;skiasharp-1.58.1;skiasharp-1.59.0;skiasharp-1.59.1;skiasharp-1.59.2;skiasharp-1.59.3;skiasharp-1.60.0;skiasharp-1.60.1;skiasharp-1.60.2;skiasharp-1.60.3;skiasharp-1.68.0;skiasharp-1.68.1" />
191-
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object other) cil managed" FrameworkAlternate="skiasharp-1.57.0;skiasharp-1.57.1;skiasharp-1.58.0;skiasharp-1.58.1;skiasharp-1.59.0;skiasharp-1.59.1;skiasharp-1.59.2;skiasharp-1.59.3;skiasharp-1.60.0;skiasharp-1.60.1;skiasharp-1.60.2;skiasharp-1.60.3;skiasharp-1.68.0;skiasharp-1.68.1" />
190+
<MemberSignature Language="C#" Value="public override bool Equals (object other);" />
191+
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object other) cil managed" />
192192
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKColor.Equals(System.Object)" />
193-
<MemberSignature Language="C#" Value="public override bool Equals (object obj);" FrameworkAlternate="skiasharp-1.68.2" />
194-
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" FrameworkAlternate="skiasharp-1.68.2" />
195193
<MemberType>Method</MemberType>
196194
<AssemblyInfo>
197195
<AssemblyName>SkiaSharp</AssemblyName>
@@ -205,12 +203,10 @@
205203
<ReturnType>System.Boolean</ReturnType>
206204
</ReturnValue>
207205
<Parameters>
208-
<Parameter Name="other" Type="System.Object" Index="0" FrameworkAlternate="skiasharp-1.57.0;skiasharp-1.57.1;skiasharp-1.58.0;skiasharp-1.58.1;skiasharp-1.59.0;skiasharp-1.59.1;skiasharp-1.59.2;skiasharp-1.59.3;skiasharp-1.60.0;skiasharp-1.60.1;skiasharp-1.60.2;skiasharp-1.60.3;skiasharp-1.68.0;skiasharp-1.68.1" />
209-
<Parameter Name="obj" Type="System.Object" Index="0" FrameworkAlternate="skiasharp-1.68.2" />
206+
<Parameter Name="other" Type="System.Object" />
210207
</Parameters>
211208
<Docs>
212209
<param name="other">The object to compare with the current object.</param>
213-
<param name="obj">To be added.</param>
214210
<summary>Determines whether the specified object is equal to the current object.</summary>
215211
<returns>Returns <see langword="true" /> if the specified object is equal to the current object; otherwise, <see langword="false" />.</returns>
216212
<remarks></remarks>

‎SkiaSharpAPI/SkiaSharp/SKDynamicMemoryWStream.xml

+43
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,49 @@
8989
<remarks></remarks>
9090
</Docs>
9191
</Member>
92+
<Member MemberName="CopyTo">
93+
<MemberSignature Language="C#" Value="public bool CopyTo (System.IO.Stream dst);" />
94+
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool CopyTo(class System.IO.Stream dst) cil managed" />
95+
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKDynamicMemoryWStream.CopyTo(System.IO.Stream)" />
96+
<MemberType>Method</MemberType>
97+
<AssemblyInfo>
98+
<AssemblyName>SkiaSharp</AssemblyName>
99+
<AssemblyVersion>1.68.0.0</AssemblyVersion>
100+
</AssemblyInfo>
101+
<ReturnValue>
102+
<ReturnType>System.Boolean</ReturnType>
103+
</ReturnValue>
104+
<Parameters>
105+
<Parameter Name="dst" Type="System.IO.Stream" Index="0" FrameworkAlternate="skiasharp-1.68.2" />
106+
</Parameters>
107+
<Docs>
108+
<param name="dst">To be added.</param>
109+
<summary>To be added.</summary>
110+
<returns>To be added.</returns>
111+
<remarks>To be added.</remarks>
112+
</Docs>
113+
</Member>
114+
<Member MemberName="CopyTo">
115+
<MemberSignature Language="C#" Value="public void CopyTo (Span&lt;byte&gt; data);" />
116+
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void CopyTo(valuetype System.Span`1&lt;unsigned int8&gt; data) cil managed" />
117+
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKDynamicMemoryWStream.CopyTo(System.Span{System.Byte})" />
118+
<MemberType>Method</MemberType>
119+
<AssemblyInfo>
120+
<AssemblyName>SkiaSharp</AssemblyName>
121+
<AssemblyVersion>1.68.0.0</AssemblyVersion>
122+
</AssemblyInfo>
123+
<ReturnValue>
124+
<ReturnType>System.Void</ReturnType>
125+
</ReturnValue>
126+
<Parameters>
127+
<Parameter Name="data" Type="System.Span&lt;System.Byte&gt;" Index="0" FrameworkAlternate="skiasharp-1.68.2" />
128+
</Parameters>
129+
<Docs>
130+
<param name="data">To be added.</param>
131+
<summary>To be added.</summary>
132+
<remarks>To be added.</remarks>
133+
</Docs>
134+
</Member>
92135
<Member MemberName="CopyToData">
93136
<MemberSignature Language="C#" Value="public SkiaSharp.SKData CopyToData ();" />
94137
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class SkiaSharp.SKData CopyToData() cil managed" />

0 commit comments

Comments
 (0)