-
Notifications
You must be signed in to change notification settings - Fork 31
/
SKWStream.xml
444 lines (444 loc) · 20.5 KB
/
SKWStream.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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
<Type Name="SKWStream" FullName="SkiaSharp.SKWStream">
<TypeSignature Language="C#" Value="public abstract class SKWStream : SkiaSharp.SKObject" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit SKWStream extends SkiaSharp.SKObject" />
<TypeSignature Language="DocId" Value="T:SkiaSharp.SKWStream" />
<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.SKObject</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>An abstraction for writing a stream of bytes, which can be backed by memory, or a file, or something else.</summary>
<remarks></remarks>
</Docs>
<Members>
<Member MemberName="BytesWritten">
<MemberSignature Language="C#" Value="public virtual int BytesWritten { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 BytesWritten" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.SKWStream.BytesWritten" />
<MemberType>Property</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.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the number of bytes written so far.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Flush">
<MemberSignature Language="C#" Value="public virtual void Flush ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Flush() cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKWStream.Flush" />
<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 />
<Docs>
<summary>Flush the buffer to the underlying destination.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetSizeOfPackedUInt32">
<MemberSignature Language="C#" Value="public static int GetSizeOfPackedUInt32 (uint value);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 GetSizeOfPackedUInt32(unsigned int32 value) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKWStream.GetSizeOfPackedUInt32(System.UInt32)" />
<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.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="value">The value to store.</param>
<summary>Returns the number of bytes in the stream required to store the specified value.</summary>
<returns>Returns the number of bytes required.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="NewLine">
<MemberSignature Language="C#" Value="public bool NewLine ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool NewLine() cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKWStream.NewLine" />
<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>Write a newline character to the stream, if one was not already written.</summary>
<returns>Returns true if the write succeeded, otherwise false.</returns>
<remarks>If the last character was a newline character, this method does nothing.</remarks>
</Docs>
</Member>
<Member MemberName="Write">
<MemberSignature Language="C#" Value="public virtual bool Write (byte[] buffer, int size);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Write(unsigned int8[] buffer, int32 size) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKWStream.Write(System.Byte[],System.Int32)" />
<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>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="size" Type="System.Int32" />
</Parameters>
<Docs>
<param name="buffer">The data buffer to write.</param>
<param name="size">The number of bytes from the buffer to write.</param>
<summary>Write the provided data to the stream.</summary>
<returns>Returns true if the write succeeded, otherwise false.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Write16">
<MemberSignature Language="C#" Value="public bool Write16 (ushort value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Write16(unsigned int16 value) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKWStream.Write16(System.UInt16)" />
<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>
<Parameter Name="value" Type="System.UInt16" />
</Parameters>
<Docs>
<param name="value">The unsigned 16-bit integer to write.</param>
<summary>Write a single, unsigned 16-bit integer to the stream.</summary>
<returns>Returns true if the write succeeded, otherwise false.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Write32">
<MemberSignature Language="C#" Value="public bool Write32 (uint value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Write32(unsigned int32 value) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKWStream.Write32(System.UInt32)" />
<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>
<Parameter Name="value" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="value">The unsigned 32-bit integer to write.</param>
<summary>Write a single, unsigned 32-bit integer to the stream.</summary>
<returns>Returns true if the write succeeded, otherwise false.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Write8">
<MemberSignature Language="C#" Value="public bool Write8 (byte value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Write8(unsigned int8 value) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKWStream.Write8(System.Byte)" />
<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>
<Parameter Name="value" Type="System.Byte" />
</Parameters>
<Docs>
<param name="value">The byte to write.</param>
<summary>Write a single byte to the stream.</summary>
<returns>Returns true if the write succeeded, otherwise false.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="WriteBigDecimalAsText">
<MemberSignature Language="C#" Value="public bool WriteBigDecimalAsText (long value, int digits);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool WriteBigDecimalAsText(int64 value, int32 digits) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKWStream.WriteBigDecimalAsText(System.Int64,System.Int32)" />
<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>
<Parameter Name="value" Type="System.Int64" />
<Parameter Name="digits" Type="System.Int32" />
</Parameters>
<Docs>
<param name="value">The 64-bit integer to write.</param>
<param name="digits">The number of digits (length) to use when writing.</param>
<summary>Write a single 64-bit integer to the stream as a string.</summary>
<returns>Returns true if the write succeeded, otherwise false.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="WriteBool">
<MemberSignature Language="C#" Value="public bool WriteBool (bool value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool WriteBool(bool value) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKWStream.WriteBool(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.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="value">The boolean to write.</param>
<summary>Write a single boolean to the stream.</summary>
<returns>Returns true if the write succeeded, otherwise false.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="WriteDecimalAsTest">
<MemberSignature Language="C#" Value="public bool WriteDecimalAsTest (int value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool WriteDecimalAsTest(int32 value) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKWStream.WriteDecimalAsTest(System.Int32)" />
<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>
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<param name="value">The 32-bit integer to write.</param>
<summary>Write a 32-bit integer to the stream as a string.</summary>
<returns>Returns true if the write succeeded, otherwise false.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="WriteHexAsText">
<MemberSignature Language="C#" Value="public bool WriteHexAsText (uint value, int digits);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool WriteHexAsText(unsigned int32 value, int32 digits) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKWStream.WriteHexAsText(System.UInt32,System.Int32)" />
<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>
<Parameter Name="value" Type="System.UInt32" />
<Parameter Name="digits" Type="System.Int32" />
</Parameters>
<Docs>
<param name="value">The unsigned, 32-bit integer to write.</param>
<param name="digits">The number of digits (length) to use when writing.</param>
<summary>Write an unsigned, 32-bit integer to the stream as a hexadecimal string.</summary>
<returns>Returns true if the write succeeded, otherwise false.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="WritePackedUInt32">
<MemberSignature Language="C#" Value="public bool WritePackedUInt32 (uint value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool WritePackedUInt32(unsigned int32 value) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKWStream.WritePackedUInt32(System.UInt32)" />
<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>
<Parameter Name="value" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="value">The unsigned 32-bit integer to write.</param>
<summary>Write a single, unsigned 32-bit integer to the stream in the smallest space possible.</summary>
<returns>Returns true if the write succeeded, otherwise false.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="WriteScalar">
<MemberSignature Language="C#" Value="public bool WriteScalar (float value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool WriteScalar(float32 value) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKWStream.WriteScalar(System.Single)" />
<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>
<Parameter Name="value" Type="System.Single" />
</Parameters>
<Docs>
<param name="value">The floating-point number to write.</param>
<summary>Write a single, floating-point number to the stream.</summary>
<returns>Returns true if the write succeeded, otherwise false.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="WriteScalarAsText">
<MemberSignature Language="C#" Value="public bool WriteScalarAsText (float value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool WriteScalarAsText(float32 value) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKWStream.WriteScalarAsText(System.Single)" />
<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>
<Parameter Name="value" Type="System.Single" />
</Parameters>
<Docs>
<param name="value">The floating-point number to write.</param>
<summary>Write a single, floating-point number to the stream as text.</summary>
<returns>Returns true if the write succeeded, otherwise false.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="WriteStream">
<MemberSignature Language="C#" Value="public bool WriteStream (SkiaSharp.SKStream input, int length);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool WriteStream(class SkiaSharp.SKStream input, int32 length) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKWStream.WriteStream(SkiaSharp.SKStream,System.Int32)" />
<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>
<Parameter Name="input" Type="SkiaSharp.SKStream" />
<Parameter Name="length" Type="System.Int32" />
</Parameters>
<Docs>
<param name="input">The stream to write.</param>
<param name="length">The number of bytes to write.</param>
<summary>Write the contents of the specified stream to this stream.</summary>
<returns>Returns true if the write succeeded, otherwise false.</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="WriteText">
<MemberSignature Language="C#" Value="public bool WriteText (string value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool WriteText(string value) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.SKWStream.WriteText(System.String)" />
<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>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<param name="value">The string to write.</param>
<summary>Write a string to the stream as a string.</summary>
<returns>Returns true if the write succeeded, otherwise false.</returns>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>