/
SKGLLayer.xml
353 lines (328 loc) · 15.9 KB
/
SKGLLayer.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
<Type Name="SKGLLayer" FullName="SkiaSharp.Views.Mac.SKGLLayer">
<TypeSignature Language="C#" Value="public class SKGLLayer : CoreAnimation.CAOpenGLLayer" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SKGLLayer extends CoreAnimation.CAOpenGLLayer" />
<TypeSignature Language="DocId" Value="T:SkiaSharp.Views.Mac.SKGLLayer" />
<AssemblyInfo>
<AssemblyName>SkiaSharp.Views.Mac</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>CoreAnimation.CAOpenGLLayer</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>A CoreAnimation OpenGL layer that can be drawn on using SkiaSharp drawing commands.</summary>
<remarks></remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SKGLLayer ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.Views.Mac.SKGLLayer.#ctor" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp.Views.Mac</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>
<Parameters />
<Docs>
<summary>Default constructor that initializes a new instance of <see cref="T:SkiaSharp.Views.Mac.SKGLLayer" />.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="CanvasSize">
<MemberSignature Language="C#" Value="public SkiaSharp.SKSize CanvasSize { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype SkiaSharp.SKSize CanvasSize" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.Views.Mac.SKGLLayer.CanvasSize" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp.Views.Mac</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>SkiaSharp.SKSize</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the current canvas size.</summary>
<value></value>
<remarks>The canvas size may be different to the view size as a result of the current device's pixel density.</remarks>
</Docs>
</Member>
<Member MemberName="DrawInCGLContext">
<MemberSignature Language="C#" Value="public override void DrawInCGLContext (OpenGL.CGLContext glContext, OpenGL.CGLPixelFormat pixelFormat, double timeInterval, ref CoreVideo.CVTimeStamp timeStamp);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void DrawInCGLContext(class OpenGL.CGLContext glContext, class OpenGL.CGLPixelFormat pixelFormat, float64 timeInterval, valuetype CoreVideo.CVTimeStamp& timeStamp) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.Views.Mac.SKGLLayer.DrawInCGLContext(OpenGL.CGLContext,OpenGL.CGLPixelFormat,System.Double,CoreVideo.CVTimeStamp@)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp.Views.Mac</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="glContext" Type="OpenGL.CGLContext" />
<Parameter Name="pixelFormat" Type="OpenGL.CGLPixelFormat" />
<Parameter Name="timeInterval" Type="System.Double" />
<Parameter Name="timeStamp" Type="CoreVideo.CVTimeStamp" RefType="ref" />
</Parameters>
<Docs>
<param name="glContext">The rendering context in to which the OpenGL content should be rendered.</param>
<param name="pixelFormat">The pixel format used when the context was created.</param>
<param name="timeInterval">The current layer time.</param>
<param name="timeStamp">The display timestamp associated with the time interval. Can be <see langword="null" />.</param>
<summary>Draws the OpenGL content for the specified time.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="DrawInSurface">
<MemberSignature Language="C#" Value="public virtual void DrawInSurface (SkiaSharp.SKSurface surface, SkiaSharp.GRBackendRenderTargetDesc renderTarget);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void DrawInSurface(class SkiaSharp.SKSurface surface, valuetype SkiaSharp.GRBackendRenderTargetDesc renderTarget) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.Views.Mac.SKGLLayer.DrawInSurface(SkiaSharp.SKSurface,SkiaSharp.GRBackendRenderTargetDesc)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp.Views.Mac</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-views-1.68;skiasharp-views-2.80;skiasharp-views-2.88">
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="skiasharp-views-1.68;skiasharp-views-2.80;skiasharp-views-2.88">
<AttributeName Language="C#">[System.Obsolete("Use OnPaintSurface(SKPaintGLSurfaceEventArgs) instead.")]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="surface" Type="SkiaSharp.SKSurface" />
<Parameter Name="renderTarget" Type="SkiaSharp.GRBackendRenderTargetDesc" />
</Parameters>
<Docs>
<param name="surface">The surface to draw on.</param>
<param name="renderTarget">The render target that is currently being drawn.</param>
<summary>Implement this to draw on the canvas.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
There are two ways to draw on this surface: by overriding the
<xref:SkiaSharp.Views.Mac.SKGLLayer.DrawInSurface(SkiaSharp.SKSurface,SkiaSharp.GRBackendRenderTargetDesc)>
method, or by attaching a handler to the
<xref:SkiaSharp.Views.Mac.SKGLLayer.PaintSurface>
event.
> [!IMPORTANT]
> If this method is overridden, then the base must be called, otherwise the
> event may not be fired.
> [!NOTE]
> If SkiaSharp version v1.68.x or greater is being used, then the
> <xref:SkiaSharp.Views.Mac.SKGLLayer.OnPaintSurface(SkiaSharp.Views.Mac.SKPaintGLSurfaceEventArgs)>
> method should be overridden instead of
> <xref:SkiaSharp.Views.Mac.SKGLLayer.DrawInSurface(SkiaSharp.SKSurface,SkiaSharp.GRBackendRenderTargetDesc)>.
## Examples
```csharp
public override void DrawInSurface (SKSurface surface, SKBackendRenderTargetDesc renderTarget)
{
// call the base method
base.DrawInSurface (surface, renderTarget);
var surfaceWidth = renderTarget.Width;
var surfaceHeight = renderTarget.Height;
var canvas = surface.Canvas;
// draw on the canvas
canvas.Flush ();
}
```
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GRContext">
<MemberSignature Language="C#" Value="public SkiaSharp.GRContext GRContext { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class SkiaSharp.GRContext GRContext" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.Views.Mac.SKGLLayer.GRContext" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp.Views.Mac</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>SkiaSharp.GRContext</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the current GPU context.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="OnPaintSurface">
<MemberSignature Language="C#" Value="protected virtual void OnPaintSurface (SkiaSharp.Views.Mac.SKPaintGLSurfaceEventArgs e);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnPaintSurface(class SkiaSharp.Views.Mac.SKPaintGLSurfaceEventArgs e) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.Views.Mac.SKGLLayer.OnPaintSurface(SkiaSharp.Views.Mac.SKPaintGLSurfaceEventArgs)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp.Views.Mac</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>
<Parameter Name="e" Type="SkiaSharp.Views.Mac.SKPaintGLSurfaceEventArgs" Index="0" FrameworkAlternate="skiasharp-views-1.68;skiasharp-views-2.80;skiasharp-views-2.88" />
</Parameters>
<Docs>
<param name="e">The event arguments that contain the drawing surface and information.</param>
<summary>Implement this to draw on the canvas.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
There are two ways to draw on this surface: by overriding the
<xref:SkiaSharp.Views.Mac.SKGLLayer.OnPaintSurface(SkiaSharp.Views.Mac.SKPaintGLSurfaceEventArgs)>
method, or by attaching a handler to the
<xref:SkiaSharp.Views.Mac.SKGLLayer.PaintSurface>
event.
> [!IMPORTANT]
> If this method is overridden, then the base must be called, otherwise the
> event will not be fired.
> [!NOTE]
> If a version of SkiaSharp prior to version v1.68.x is being used, then the
> <xref:SkiaSharp.Views.Mac.SKGLLayer.DrawInSurface(SkiaSharp.SKSurface,SkiaSharp.GRBackendRenderTargetDesc)>
> method should be overridden instead of
> <xref:SkiaSharp.Views.Mac.SKGLLayer.OnPaintSurface(SkiaSharp.Views.Mac.SKPaintGLSurfaceEventArgs)>.
## Examples
```csharp
protected override void OnPaintSurface (SKPaintGLSurfaceEventArgs e)
{
// call the base method
base.OnPaintSurface (e);
var surface = e.Surface;
var surfaceWidth = e.BackendRenderTarget.Width;
var surfaceHeight = e.BackendRenderTarget.Height;
var canvas = surface.Canvas;
// draw on the canvas
canvas.Flush ();
}
```
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="PaintSurface">
<MemberSignature Language="C#" Value="public event EventHandler<SkiaSharp.Views.Mac.SKPaintGLSurfaceEventArgs> PaintSurface;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class SkiaSharp.Views.Mac.SKPaintGLSurfaceEventArgs> PaintSurface" />
<MemberSignature Language="DocId" Value="E:SkiaSharp.Views.Mac.SKGLLayer.PaintSurface" />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp.Views.Mac</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.EventHandler<SkiaSharp.Views.Mac.SKPaintGLSurfaceEventArgs></ReturnType>
</ReturnValue>
<Docs>
<summary>Occurs when the the canvas needs to be redrawn.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
There are two ways to draw on this surface: by overriding the
<xref:SkiaSharp.Views.Mac.SKGLLayer.OnPaintSurface(SkiaSharp.Views.Mac.SKPaintGLSurfaceEventArgs)>
method, or by attaching a handler to the
<xref:SkiaSharp.Views.Mac.SKGLLayer.PaintSurface>
event.
> [!NOTE]
> If a version of SkiaSharp prior to version v1.68.x is being used, then the
> <xref:SkiaSharp.Views.Mac.SKGLLayer.DrawInSurface(SkiaSharp.SKSurface,SkiaSharp.GRBackendRenderTargetDesc)>
> method should be overridden instead of
> <xref:SkiaSharp.Views.Mac.SKGLLayer.OnPaintSurface(SkiaSharp.Views.Mac.SKPaintGLSurfaceEventArgs)>.
## Examples
```csharp
myLayer.PaintSurface += (sender, e) => {
var surface = e.Surface;
var surfaceWidth = e.BackendRenderTarget.Width;
var surfaceHeight = e.BackendRenderTarget.Height;
var canvas = surface.Canvas;
// draw on the canvas
canvas.Flush ();
};
```
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Release">
<MemberSignature Language="C#" Value="public override void Release (OpenGL.CGLContext glContext);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Release(class OpenGL.CGLContext glContext) cil managed" />
<MemberSignature Language="DocId" Value="M:SkiaSharp.Views.Mac.SKGLLayer.Release(OpenGL.CGLContext)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp.Views.Mac</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="glContext" Type="OpenGL.CGLContext" />
</Parameters>
<Docs>
<param name="glContext">The rendering context to release.</param>
<summary>Releases the specified rendering context.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SKDelegate">
<MemberSignature Language="C#" Value="public SkiaSharp.Views.Mac.ISKGLLayerDelegate SKDelegate { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class SkiaSharp.Views.Mac.ISKGLLayerDelegate SKDelegate" />
<MemberSignature Language="DocId" Value="P:SkiaSharp.Views.Mac.SKGLLayer.SKDelegate" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>SkiaSharp.Views.Mac</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-views-1.68;skiasharp-views-2.80;skiasharp-views-2.88">
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="skiasharp-views-1.68;skiasharp-views-2.80;skiasharp-views-2.88">
<AttributeName Language="C#">[System.Obsolete("Use PaintSurface instead.")]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>SkiaSharp.Views.Mac.ISKGLLayerDelegate</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the layer's delegate object.</summary>
<value></value>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>