-
Notifications
You must be signed in to change notification settings - Fork 31
/
SKPath+Iterator.xml
234 lines (232 loc) · 12.8 KB
/
SKPath+Iterator.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
<Type Name="SKPath+Iterator" FullName="SkiaSharp.SKPath+Iterator">
<TypeSignature Language="C#" Value="public class SKPath.Iterator : SkiaSharp.SKNativeObject" FrameworkAlternate="skiasharp-1.60" />
<TypeSignature Language="ILAsm" Value=".class nested public auto ansi beforefieldinit SKPath/Iterator extends SkiaSharp.SKNativeObject" FrameworkAlternate="skiasharp-1.60" />
<TypeSignature Language="DocId" Value="T:SkiaSharp.SKPath.Iterator" />
<TypeSignature Language="C#" Value="public class SKPath.Iterator : SkiaSharp.SKObject" FrameworkAlternate="skiasharp-1.68;skiasharp-2.80;skiasharp-2.88" />
<TypeSignature Language="ILAsm" Value=".class nested public auto ansi beforefieldinit SKPath/Iterator extends SkiaSharp.SKObject" FrameworkAlternate="skiasharp-1.68;skiasharp-2.80;skiasharp-2.88" />
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
<AssemblyVersion>1.68.0.0</AssemblyVersion>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>SkiaSharp.SKNativeObject</BaseTypeName>
<BaseTypeName FrameworkAlternate="skiasharp-1.68;skiasharp-2.80;skiasharp-2.88">SkiaSharp.SKObject</BaseTypeName>
</Base>
<Interfaces></Interfaces>
<Docs>
<summary>Iterator object to scan the all of the segments (lines, quadratics, cubics) of each contours in a path.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Iterators are created by calling the
<xref:SkiaSharp.SKPath.CreateIterator%2A?displayProperty=nameWithType> method.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="ConicWeight">
<MemberSignature Language="C#" Value="public float ConicWeight ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance float32 ConicWeight() cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKPath.Iterator.ConicWeight" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
<AssemblyVersion>1.68.0.0</AssemblyVersion>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Return the weight for the current conic.</summary>
<returns></returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Only valid if the current segment return by
<xref:SkiaSharp.SKPath.Iterator.Next%2A> was <xref:SkiaSharp.SKPathVerb.Conic>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Dispose(bool disposing) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKPath.Iterator.Dispose(System.Boolean)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
<AssemblyVersion>1.68.0.0</AssemblyVersion>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="disposing">
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
<summary>Releases the unmanaged resources used by the <see cref="T:SkiaSharp.SKPath.Iterator" /> and optionally releases the managed resources.</summary>
<remarks>Always dispose the object before you release your last reference to the <see cref="T:SkiaSharp.SKPath.Iterator" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the finalizer.</remarks>
</Docs>
</Member>
<Member MemberName="DisposeNative">
<MemberSignature Language="C#" Value="protected override void DisposeNative ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void DisposeNative() cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKPath.Iterator.DisposeNative" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.68.0.0</AssemblyVersion>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Implemented by derived <see cref="T:SkiaSharp.SKObject" /> types to destroy any native objects.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="IsCloseContour">
<MemberSignature Language="C#" Value="public bool IsCloseContour ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsCloseContour() cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKPath.Iterator.IsCloseContour" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
<AssemblyVersion>1.68.0.0</AssemblyVersion>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns a value indicating whether the current contour is closed.</summary>
<returns>Returns true if the current contour is closed (has a <see cref="E:SkiaSharp.SKPathVerb.Close" />).</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="IsCloseLine">
<MemberSignature Language="C#" Value="public bool IsCloseLine ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsCloseLine() cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKPath.Iterator.IsCloseLine" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
<AssemblyVersion>1.68.0.0</AssemblyVersion>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns a value indicating whether the last call to <see cref="M:SkiaSharp.SKPath.Iterator.Next(SkiaSharp.SKPoint[],System.Boolean,System.Boolean)" /> returns a line which was the result of a <see cref="M:SkiaSharp.SKPath.Close" /> command.</summary>
<returns>Returns true if the last call to <see cref="M:SkiaSharp.SKPath.Iterator.Next(SkiaSharp.SKPoint[],System.Boolean,System.Boolean)" /> returned a line which was the result of a <see cref="M:SkiaSharp.SKPath.Close" /> command.</returns>
<remarks>If the call to <see cref="M:SkiaSharp.SKPath.Iterator.Next(SkiaSharp.SKPoint[],System.Boolean,System.Boolean)" /> returned a different value than <see cref="F:SkiaSharp.SKPathVerb.Line" />, the result is undefined.</remarks>
</Docs>
</Member>
<Member MemberName="Next">
<MemberSignature Language="C#" Value="public SkiaSharp.SKPathVerb Next (SkiaSharp.SKPoint[] points);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype SkiaSharp.SKPathVerb Next(valuetype SkiaSharp.SKPoint[] points) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKPath.Iterator.Next(SkiaSharp.SKPoint[])" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKPathVerb</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="points" Type="SkiaSharp.SKPoint[]" Index="0" FrameworkAlternate="skiasharp-2.80;skiasharp-2.88" />
</Parameters>
<Docs>
<param name="points">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Next">
<MemberSignature Language="C#" Value="public SkiaSharp.SKPathVerb Next (Span<SkiaSharp.SKPoint> points);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype SkiaSharp.SKPathVerb Next(valuetype System.Span`1<valuetype SkiaSharp.SKPoint> points) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKPath.Iterator.Next(System.Span{SkiaSharp.SKPoint})" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.SKPathVerb</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="points" Type="System.Span<SkiaSharp.SKPoint>" Index="0" FrameworkAlternate="skiasharp-2.80;skiasharp-2.88" />
</Parameters>
<Docs>
<param name="points">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Next">
<MemberSignature Language="C#" Value="public SkiaSharp.SKPathVerb Next (SkiaSharp.SKPoint[] points, bool doConsumeDegenerates = true, bool exact = false);" FrameworkAlternate="skiasharp-1.60;skiasharp-1.68" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype SkiaSharp.SKPathVerb Next(valuetype SkiaSharp.SKPoint[] points, bool doConsumeDegenerates, bool exact) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKPath.Iterator.Next(SkiaSharp.SKPoint[],System.Boolean,System.Boolean)" />
<MemberSignature Language="C#" Value="public SkiaSharp.SKPathVerb Next (SkiaSharp.SKPoint[] points, bool doConsumeDegenerates, bool exact);" FrameworkAlternate="skiasharp-2.80;skiasharp-2.88" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
<AssemblyVersion>1.68.0.0</AssemblyVersion>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="skiasharp-2.80;skiasharp-2.88">
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="skiasharp-2.80;skiasharp-2.88">
<AttributeName Language="C#">[System.Obsolete("Use Next(SKPoint[]) instead.")]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>SkiaSharp.SKPathVerb</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="points" Type="SkiaSharp.SKPoint[]" />
<Parameter Name="doConsumeDegenerates" Type="System.Boolean" />
<Parameter Name="exact" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="points">The storage for the points representing the current verb and/or segment. Should be an array of four points.</param>
<param name="doConsumeDegenerates">If <see langword="true" />, first scan for segments that are deemed degenerate (too short) and skip those.</param>
<param name="exact">If <paramref name="doConsumeDegenerates" /> is <see langword="true" /> and exact is true, skip only degenerate elements with lengths exactly equal to zero. If exact is <see langword="false" />, skip degenerate elements with lengths close to zero. If <paramref name="doConsumeDegenerates" /> is <see langword="false" />, exact has no effect.</param>
<summary>Returns the next verb in this iteration of the path.</summary>
<returns>The verb of the current segment.</returns>
<remarks>When all segments have been visited, returns <see cref="F:SkiaSharp.SKPathVerb.Done" />.</remarks>
</Docs>
</Member>
</Members>
</Type>