-
Notifications
You must be signed in to change notification settings - Fork 32
/
GRContextOptions.xml
414 lines (414 loc) · 20.7 KB
/
GRContextOptions.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
<Type Name="GRContextOptions" FullName="SkiaSharp.GRContextOptions">
<TypeSignature Language="C#" Value="public struct GRContextOptions" FrameworkAlternate="skiasharp-1.60" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit GRContextOptions extends System.ValueType" FrameworkAlternate="skiasharp-1.60" />
<TypeSignature Language="DocId" Value="T:SkiaSharp.GRContextOptions" />
<TypeSignature Language="C#" Value="public class GRContextOptions" FrameworkAlternate="skiasharp-2.80;skiasharp-2.88" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit GRContextOptions extends System.Object" FrameworkAlternate="skiasharp-2.80;skiasharp-2.88" />
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
<BaseTypeName FrameworkAlternate="skiasharp-2.80;skiasharp-2.88">System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents the collection of options for the construction of a context.</summary>
<remarks></remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public GRContextOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.GRContextOptions.#ctor" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AllowPathMaskCaching">
<MemberSignature Language="C#" Value="public bool AllowPathMaskCaching { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool AllowPathMaskCaching" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRContextOptions.AllowPathMaskCaching" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether to allow path mask textures to be cached.</summary>
<value></value>
<remarks>This is only really useful if paths are commonly rendered at the same scale and fractional translation. Default is false.</remarks>
</Docs>
</Member>
<Member MemberName="AvoidStencilBuffers">
<MemberSignature Language="C#" Value="public bool AvoidStencilBuffers { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool AvoidStencilBuffers" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRContextOptions.AvoidStencilBuffers" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether to avoid allocating stencil buffers.</summary>
<value></value>
<remarks>Bugs on certain drivers cause stencil buffers to leak. This flag causes Skia to avoid allocating stencil buffers and use alternate rasterization paths, avoiding the leak.</remarks>
</Docs>
</Member>
<Member MemberName="BufferMapThreshold">
<MemberSignature Language="C#" Value="public int BufferMapThreshold { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 BufferMapThreshold" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRContextOptions.BufferMapThreshold" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.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 or sets the threshold, in bytes, above which a buffer mapping API will be used to map vertex and index buffers to CPU memory in order to update them.</summary>
<value></value>
<remarks>A value of -1 means the context should deduce the optimal value for this platform. Default is -1.</remarks>
</Docs>
</Member>
<Member MemberName="Default">
<MemberSignature Language="C#" Value="public static SkiaSharp.GRContextOptions Default { get; }" />
<MemberSignature Language="ILAsm" Value=".property valuetype SkiaSharp.GRContextOptions Default" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRContextOptions.Default" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.GRContextOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a new instance with the values set to the defaults.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="DisableGpuYuvConversion">
<MemberSignature Language="C#" Value="public bool DisableGpuYuvConversion { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool DisableGpuYuvConversion" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRContextOptions.DisableGpuYuvConversion" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether the GPU will be used to perform YUV -> RGB conversion when generating textures from codec-backed images.</summary>
<value></value>
<remarks>Default is false.</remarks>
</Docs>
</Member>
<Member MemberName="DoManualMipmapping">
<MemberSignature Language="C#" Value="public bool DoManualMipmapping { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool DoManualMipmapping" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRContextOptions.DoManualMipmapping" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether to construct mipmaps manually, via repeated downsampling draw-calls.</summary>
<value></value>
<remarks>This is used when the driver's implementation (glGenerateMipmap) contains bugs. This requires mipmap level and LOD control (for example, desktop or ES3). Default is false.</remarks>
</Docs>
</Member>
<Member MemberName="EnableInstancedRendering">
<MemberSignature Language="C#" Value="public bool EnableInstancedRendering { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool EnableInstancedRendering" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRContextOptions.EnableInstancedRendering" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether to enable instanced rendering as long as all required functionality is supported by the hardware.</summary>
<value></value>
<remarks>Instanced rendering is still experimental at this point and disabled by default. Default is false.</remarks>
</Docs>
</Member>
<Member MemberName="GlyphCacheTextureMaximumBytes">
<MemberSignature Language="C#" Value="public float GlyphCacheTextureMaximumBytes { get; set; }" FrameworkAlternate="skiasharp-1.60" />
<MemberSignature Language="ILAsm" Value=".property instance float32 GlyphCacheTextureMaximumBytes" FrameworkAlternate="skiasharp-1.60" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRContextOptions.GlyphCacheTextureMaximumBytes" />
<MemberSignature Language="C#" Value="public int GlyphCacheTextureMaximumBytes { get; set; }" FrameworkAlternate="skiasharp-2.80;skiasharp-2.88" />
<MemberSignature Language="ILAsm" Value=".property instance int32 GlyphCacheTextureMaximumBytes" FrameworkAlternate="skiasharp-2.80;skiasharp-2.88" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType FrameworkAlternate="skiasharp-1.60">System.Single</ReturnType>
<ReturnType FrameworkAlternate="skiasharp-2.80;skiasharp-2.88">System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the maximum size of cache textures used for the SkiaSharp Glyph cache.</summary>
<value></value>
<remarks>Default is 2048 * 1024 * 4.</remarks>
</Docs>
</Member>
<Member MemberName="GpuPathRenderers">
<MemberSignature Language="C#" Value="public SkiaSharp.GRContextOptionsGpuPathRenderers GpuPathRenderers { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype SkiaSharp.GRContextOptionsGpuPathRenderers GpuPathRenderers" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRContextOptions.GpuPathRenderers" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>SkiaSharp.GRContextOptionsGpuPathRenderers</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the GPU path renderers.</summary>
<value></value>
<remarks>Default is <see cref="F:SkiaSharp.GRContextOptionsGpuPathRenderers.All" />.</remarks>
</Docs>
</Member>
<Member MemberName="ImmediateMode">
<MemberSignature Language="C#" Value="public bool ImmediateMode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool ImmediateMode" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRContextOptions.ImmediateMode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether the context operates in immediate mode.</summary>
<value></value>
<remarks>The context will issue all draws to the backend API immediately. Intended to ease debugging. Default is false.</remarks>
</Docs>
</Member>
<Member MemberName="MaxTextureSizeOverride">
<MemberSignature Language="C#" Value="public int MaxTextureSizeOverride { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxTextureSizeOverride" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRContextOptions.MaxTextureSizeOverride" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the maximum size of a texture.</summary>
<value></value>
<remarks>An option to override feature detection using backend API queries. The override can only reduce the feature set or limits, never increase them beyond the detected values. Default is 0x7FFFFFFF.</remarks>
</Docs>
</Member>
<Member MemberName="MaxTileSizeOverride">
<MemberSignature Language="C#" Value="public int MaxTileSizeOverride { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxTileSizeOverride" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRContextOptions.MaxTileSizeOverride" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the maximum size (if non-zero) of a tile for software-backed images and bitmaps rendered by the device.</summary>
<value></value>
<remarks>An option to override feature detection using backend API queries. The override can only reduce the feature set or limits, never increase them beyond the detected values. Default is 0.</remarks>
</Docs>
</Member>
<Member MemberName="RequireDecodeDisableForSrgb">
<MemberSignature Language="C#" Value="public bool RequireDecodeDisableForSrgb { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool RequireDecodeDisableForSrgb" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRContextOptions.RequireDecodeDisableForSrgb" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether sRGB support will be disabled if sRGB decoding cannot be enabled.</summary>
<value></value>
<remarks>Default is true.</remarks>
</Docs>
</Member>
<Member MemberName="RuntimeProgramCacheSize">
<MemberSignature Language="C#" Value="public int RuntimeProgramCacheSize { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 RuntimeProgramCacheSize" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRContextOptions.RuntimeProgramCacheSize" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SuppressDualSourceBlending">
<MemberSignature Language="C#" Value="public bool SuppressDualSourceBlending { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool SuppressDualSourceBlending" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRContextOptions.SuppressDualSourceBlending" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether to suppress dual source blending.</summary>
<value></value>
<remarks>Default is false.</remarks>
</Docs>
</Member>
<Member MemberName="SuppressPathRendering">
<MemberSignature Language="C#" Value="public bool SuppressPathRendering { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool SuppressPathRendering" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRContextOptions.SuppressPathRendering" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether the caps will never report driver support for path rendering.</summary>
<value></value>
<remarks>Default is false.</remarks>
</Docs>
</Member>
<Member MemberName="SuppressPrints">
<MemberSignature Language="C#" Value="public bool SuppressPrints { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool SuppressPrints" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRContextOptions.SuppressPrints" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether to suppress prints for the <see cref="T:SkiaSharp.GRContext" />.</summary>
<value></value>
<remarks>Default is false.</remarks>
</Docs>
</Member>
<Member MemberName="UseDrawInsteadOfPartialRenderTargetWrite">
<MemberSignature Language="C#" Value="public bool UseDrawInsteadOfPartialRenderTargetWrite { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool UseDrawInsteadOfPartialRenderTargetWrite" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRContextOptions.UseDrawInsteadOfPartialRenderTargetWrite" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether to avoid partial writes.</summary>
<value></value>
<remarks>Some GPUs have problems with partial writes of the render target. Default is false.</remarks>
</Docs>
</Member>
<Member MemberName="UseShaderSwizzling">
<MemberSignature Language="C#" Value="public bool UseShaderSwizzling { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool UseShaderSwizzling" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRContextOptions.UseShaderSwizzling" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether to do all swizzling manually in the shader and don't rely on extensions to do swizzling.</summary>
<value></value>
<remarks>Default is false.</remarks>
</Docs>
</Member>
<Member MemberName="WireframeMode">
<MemberSignature Language="C#" Value="public bool WireframeMode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool WireframeMode" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRContextOptions.WireframeMode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.60.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether to render everything in wireframe.</summary>
<value></value>
<remarks>Default is false.</remarks>
</Docs>
</Member>
</Members>
</Type>