/
GRBackendRenderTargetDesc.xml
421 lines (419 loc) · 19.7 KB
/
GRBackendRenderTargetDesc.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
<Type Name="GRBackendRenderTargetDesc" FullName="SkiaSharp.GRBackendRenderTargetDesc">
<TypeSignature Language="C#" Value="public struct GRBackendRenderTargetDesc" FrameworkAlternate="skiasharp-1.60" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit GRBackendRenderTargetDesc extends System.ValueType" FrameworkAlternate="skiasharp-1.60" />
<TypeSignature Language="DocId" Value="T:SkiaSharp.GRBackendRenderTargetDesc" />
<TypeSignature Language="C#" Value="public struct GRBackendRenderTargetDesc : IEquatable<SkiaSharp.GRBackendRenderTargetDesc>" FrameworkAlternate="skiasharp-1.68;skiasharp-2.80;skiasharp-2.88" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit GRBackendRenderTargetDesc extends System.ValueType implements class System.IEquatable`1<valuetype SkiaSharp.GRBackendRenderTargetDesc>" 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>System.ValueType</BaseTypeName>
</Base>
<Interfaces>
<Interface FrameworkAlternate="skiasharp-1.68;skiasharp-2.80;skiasharp-2.88">
<InterfaceName>System.IEquatable<SkiaSharp.GRBackendRenderTargetDesc></InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute FrameworkAlternate="skiasharp-1.68;skiasharp-2.80;skiasharp-2.88">
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="skiasharp-1.68;skiasharp-2.80;skiasharp-2.88">
<AttributeName Language="C#">[System.Obsolete("Use GRBackendRenderTarget instead.")]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Wrap an existing render target created by the client in the 3D API with an underlying GRRenderTarget object.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The client is responsible for ensuring that the underlying 3D API object lives
at least as long as the GRRenderTarget object wrapping it.
We require the client to explicitly provide information about the target, such
as width, height, and pixel configuration, rather than querying the 3D API for
these values. We expect these properties to be immutable even if the 3D API
doesn't require this (eg: OpenGL).
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="Config">
<MemberSignature Language="C#" Value="public SkiaSharp.GRPixelConfig Config { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype SkiaSharp.GRPixelConfig Config" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRBackendRenderTargetDesc.Config" />
<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>
<Attributes>
<Attribute FrameworkAlternate="skiasharp-2.88">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>SkiaSharp.GRPixelConfig</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the color format.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public readonly bool Equals (SkiaSharp.GRBackendRenderTargetDesc obj);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(valuetype SkiaSharp.GRBackendRenderTargetDesc obj) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.GRBackendRenderTargetDesc.Equals(SkiaSharp.GRBackendRenderTargetDesc)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IEquatable`1.Equals(`0)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>SkiaSharp</AssemblyName>
<AssemblyVersion>1.68.0.0</AssemblyVersion>
<AssemblyVersion>2.80.0.0</AssemblyVersion>
<AssemblyVersion>2.88.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="skiasharp-2.88">
<AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="SkiaSharp.GRBackendRenderTargetDesc" Index="0" FrameworkAlternate="skiasharp-1.68;skiasharp-2.80;skiasharp-2.88" />
</Parameters>
<Docs>
<param name="obj">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override readonly bool Equals (object obj);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.GRBackendRenderTargetDesc.Equals(System.Object)" />
<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>
<Attributes>
<Attribute FrameworkAlternate="skiasharp-2.88">
<AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" Index="0" FrameworkAlternate="skiasharp-1.68;skiasharp-2.80;skiasharp-2.88" />
</Parameters>
<Docs>
<param name="obj">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override readonly int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.GRBackendRenderTargetDesc.GetHashCode" />
<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>
<Attributes>
<Attribute FrameworkAlternate="skiasharp-2.88">
<AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Height">
<MemberSignature Language="C#" Value="public int Height { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Height" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRBackendRenderTargetDesc.Height" />
<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>
<Attributes>
<Attribute FrameworkAlternate="skiasharp-2.88">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the height in pixels.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="op_Equality">
<MemberSignature Language="C#" Value="public static bool operator == (SkiaSharp.GRBackendRenderTargetDesc left, SkiaSharp.GRBackendRenderTargetDesc right);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Equality(valuetype SkiaSharp.GRBackendRenderTargetDesc left, valuetype SkiaSharp.GRBackendRenderTargetDesc right) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.GRBackendRenderTargetDesc.op_Equality(SkiaSharp.GRBackendRenderTargetDesc,SkiaSharp.GRBackendRenderTargetDesc)" />
<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.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="left" Type="SkiaSharp.GRBackendRenderTargetDesc" Index="0" FrameworkAlternate="skiasharp-1.68;skiasharp-2.80;skiasharp-2.88" />
<Parameter Name="right" Type="SkiaSharp.GRBackendRenderTargetDesc" Index="1" FrameworkAlternate="skiasharp-1.68;skiasharp-2.80;skiasharp-2.88" />
</Parameters>
<Docs>
<param name="left">To be added.</param>
<param name="right">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="op_Inequality">
<MemberSignature Language="C#" Value="public static bool operator != (SkiaSharp.GRBackendRenderTargetDesc left, SkiaSharp.GRBackendRenderTargetDesc right);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Inequality(valuetype SkiaSharp.GRBackendRenderTargetDesc left, valuetype SkiaSharp.GRBackendRenderTargetDesc right) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.GRBackendRenderTargetDesc.op_Inequality(SkiaSharp.GRBackendRenderTargetDesc,SkiaSharp.GRBackendRenderTargetDesc)" />
<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.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="left" Type="SkiaSharp.GRBackendRenderTargetDesc" Index="0" FrameworkAlternate="skiasharp-1.68;skiasharp-2.80;skiasharp-2.88" />
<Parameter Name="right" Type="SkiaSharp.GRBackendRenderTargetDesc" Index="1" FrameworkAlternate="skiasharp-1.68;skiasharp-2.80;skiasharp-2.88" />
</Parameters>
<Docs>
<param name="left">To be added.</param>
<param name="right">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Origin">
<MemberSignature Language="C#" Value="public SkiaSharp.GRSurfaceOrigin Origin { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype SkiaSharp.GRSurfaceOrigin Origin" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRBackendRenderTargetDesc.Origin" />
<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>
<Attributes>
<Attribute FrameworkAlternate="skiasharp-2.88">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>SkiaSharp.GRSurfaceOrigin</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the pixel origin.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Rect">
<MemberSignature Language="C#" Value="public SkiaSharp.SKRectI Rect { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype SkiaSharp.SKRectI Rect" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRBackendRenderTargetDesc.Rect" />
<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>
<Attributes>
<Attribute FrameworkAlternate="skiasharp-2.88">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>SkiaSharp.SKRectI</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a rectangle with the current width and height.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="RenderTargetHandle">
<MemberSignature Language="C#" Value="public IntPtr RenderTargetHandle { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance native int RenderTargetHandle" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRBackendRenderTargetDesc.RenderTargetHandle" />
<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>
<Attributes>
<Attribute FrameworkAlternate="skiasharp-2.88">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the handle to the 3D API object.</summary>
<value></value>
<remarks>When using OpenGL, it is the FBO ID.</remarks>
</Docs>
</Member>
<Member MemberName="SampleCount">
<MemberSignature Language="C#" Value="public int SampleCount { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 SampleCount" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRBackendRenderTargetDesc.SampleCount" />
<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>
<Attributes>
<Attribute FrameworkAlternate="skiasharp-2.88">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the number of samples per pixel.</summary>
<value></value>
<remarks>This is used to influence decisions about applying other forms of anti-aliasing.</remarks>
</Docs>
</Member>
<Member MemberName="Size">
<MemberSignature Language="C#" Value="public SkiaSharp.SKSizeI Size { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype SkiaSharp.SKSizeI Size" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRBackendRenderTargetDesc.Size" />
<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>
<Attributes>
<Attribute FrameworkAlternate="skiasharp-2.88">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>SkiaSharp.SKSizeI</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the current size of the 3D API object.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="StencilBits">
<MemberSignature Language="C#" Value="public int StencilBits { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 StencilBits" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRBackendRenderTargetDesc.StencilBits" />
<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>
<Attributes>
<Attribute FrameworkAlternate="skiasharp-2.88">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the number of bits of stencil per pixel.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Width">
<MemberSignature Language="C#" Value="public int Width { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Width" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.GRBackendRenderTargetDesc.Width" />
<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>
<Attributes>
<Attribute FrameworkAlternate="skiasharp-2.88">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the width in pixels.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>