-
Notifications
You must be signed in to change notification settings - Fork 42
/
CADisplayLink.xml
688 lines (681 loc) · 37.3 KB
/
CADisplayLink.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
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
<Type Name="CADisplayLink" FullName="CoreAnimation.CADisplayLink">
<TypeSignature Language="C#" Value="public class CADisplayLink : Foundation.NSObject" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CADisplayLink extends Foundation.NSObject" />
<TypeSignature Language="DocId" Value="T:CoreAnimation.CADisplayLink" />
<TypeSignature Language="F#" Value="type CADisplayLink = class
 inherit NSObject" />
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Foundation.NSObject</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>Foundation.Register("CADisplayLink", true)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Synchronization object between your animations and the display refresh.</summary>
<remarks>
<para>
The display link object is a timer that can be used to
synchronize your drawing with the screen refresh rate. Once
you create your CADisplayLink, you need to add it to a runloop
by using the <see cref="M:CoreAnimation.CADisplayLink.AddToRunLoop(Foundation.NSRunLoop,Foundation.NSString)" />
method.
</para>
<para>
Using the display link ensures that your application will not
suffer from display glitches like screen tearing and micro-stuttering.
</para>
<para>
You can pause the display link by setting the <see cref="P:CoreAnimation.CADisplayLink.Paused" />
property. And you can remove your display link from any
registered run loops by calling the <see cref="M:CoreAnimation.CADisplayLink.Invalidate" />
method.
</para>
<para>
By default the timer is triggered sixty times per second. If
your application does not need this level of precision, set
the FrameInterval property to skip one or more updates. For
example, setting FrameInterval to two, would invoke your
target method thirty times per second.
</para>
<example>
<code lang="csharp lang-csharp"><![CDATA[
GLKView myGlView;
void Setup ()
{
CADisplayLink displayLink = CADisplayLink.Create (Display);
displayLink.AddToRunLoop (NSRunLoop.Main, NSRunLoop.UITrackingRunLoopMode);
}
void Display ()
{
myGLView.Display ();
}
]]></code>
</example>
</remarks>
<related type="externalDocumentation" href="https://developer.apple.com/library/ios/documentation/QuartzCore/Reference/CADisplayLink_ClassRef/index.html">Apple documentation for <c>CADisplayLink</c></related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CADisplayLink ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:CoreAnimation.CADisplayLink.#ctor" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Foundation.Export("init")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Default constructor that initializes a new instance of this class with no parameters.</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected CADisplayLink (Foundation.NSObjectFlag t);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class Foundation.NSObjectFlag t) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreAnimation.CADisplayLink.#ctor(Foundation.NSObjectFlag)" />
<MemberSignature Language="F#" Value="new CoreAnimation.CADisplayLink : Foundation.NSObjectFlag -> CoreAnimation.CADisplayLink" Usage="new CoreAnimation.CADisplayLink t" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="t" Type="Foundation.NSObjectFlag" />
</Parameters>
<Docs>
<param name="t">Unused sentinel value, pass NSObjectFlag.Empty.</param>
<summary>Constructor to call on derived classes to skip initialization and merely allocate the object.</summary>
<remarks>
<para>This constructor should be called by derived classes when they completely construct the object in managed code and merely want the runtime to allocate and initialize the NSObject. This is required to implement the two-step initialization process that Objective-C uses, the first step is to perform the object allocation, the second step is to initialize the object. When developers invoke the constructor that takes the NSObjectFlag.Empty they take advantage of a direct path that goes all the way up to NSObject to merely allocate the object's memory and bind the Objective-C and C# objects together. The actual initialization of the object is up to the developer.</para>
<para>This constructor is typically used by the binding generator to allocate the object, but prevent the actual initialization to take place. Once the allocation has taken place, the constructor has to initialize the object. With constructors generated by the binding generator this means that it manually invokes one of the "init" methods to initialize the object.</para>
<para>It is the developer's responsibility to completely initialize the object if they chain up using the NSObjectFlag.Empty path.</para>
<para>In general, if the developer's constructor invokes the NSObjectFlag.Empty base implementation, then it should be calling an Objective-C init method. If this is not the case, developers should instead chain to the proper constructor in their class. </para>
<para>The argument value is ignored and merely ensures that the only code that is executed is the construction phase is the basic NSObject allocation and runtime type registration. Typically the chaining would look like this:</para>
<example>
<code lang="csharp lang-csharp"><![CDATA[
//
// The NSObjectFlag merely allocates the object and registers the
// C# class with the Objective-C runtime if necessary, but no actual
// initXxx method is invoked, that is done later in the constructor
//
// This is taken from Xamarin.iOS's source code:
//
[Export ("initWithFrame:")]
public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
{
// Invoke the init method now.
var initWithFrame = new Selector ("initWithFrame:").Handle;
if (IsDirectBinding)
Handle = ObjCRuntime.Messaging.IntPtr_objc_msgSend_CGRect (this.Handle, initWithFrame, frame);
else
Handle = ObjCRuntime.Messaging.IntPtr_objc_msgSendSuper_CGRect (this.SuperHandle, initWithFrame, frame);
}
]]></code>
</example>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected internal CADisplayLink (IntPtr handle);" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreAnimation.CADisplayLink.#ctor(System.IntPtr)" />
<MemberSignature Language="F#" Value="new CoreAnimation.CADisplayLink : nativeint -> CoreAnimation.CADisplayLink" Usage="new CoreAnimation.CADisplayLink handle" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="handle" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="handle">Pointer (handle) to the unmanaged object.</param>
<summary>A constructor used when creating managed representations of unmanaged objects; Called by the runtime.</summary>
<remarks>
<para>This constructor is invoked by the runtime infrastructure (<see cref="M:ObjCRuntime.Runtime.GetNSObject(System.IntPtr)" />) to create a new managed representation for a pointer to an unmanaged Objective-C object. Developers should not invoke this method directly, instead they should call the GetNSObject method as it will prevent two instances of a managed object to point to the same native object.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="AddToRunLoop">
<MemberSignature Language="C#" Value="public void AddToRunLoop (Foundation.NSRunLoop runloop, Foundation.NSRunLoopMode mode);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddToRunLoop(class Foundation.NSRunLoop runloop, valuetype Foundation.NSRunLoopMode mode) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreAnimation.CADisplayLink.AddToRunLoop(Foundation.NSRunLoop,Foundation.NSRunLoopMode)" />
<MemberSignature Language="F#" Value="member this.AddToRunLoop : Foundation.NSRunLoop * Foundation.NSRunLoopMode -> unit" Usage="cADisplayLink.AddToRunLoop (runloop, mode)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="runloop" Type="Foundation.NSRunLoop" />
<Parameter Name="mode" Type="Foundation.NSRunLoopMode" />
</Parameters>
<Docs>
<param name="runloop">The runloop on which to run.</param>
<param name="mode">Modes in which the timer will be invoked.</param>
<summary>Trigger timer events on the specified runloop for the specified modes.</summary>
<remarks>
<para>The mode parameter will determine when the event is sent. The NSRunLoop.NSDefaultRunLoopMode is not delivered during UI tracking events (like scrolling in a UIScrollbar). For getting those kinds of events use NSRunLoop.UITrackingRunLoopMode. Or use NSRunLoop.NSRunLoopCommonModes which covers both cases. </para>
</remarks>
</Docs>
</Member>
<Member MemberName="AddToRunLoop">
<MemberSignature Language="C#" Value="public virtual void AddToRunLoop (Foundation.NSRunLoop runloop, Foundation.NSString mode);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void AddToRunLoop(class Foundation.NSRunLoop runloop, class Foundation.NSString mode) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreAnimation.CADisplayLink.AddToRunLoop(Foundation.NSRunLoop,Foundation.NSString)" />
<MemberSignature Language="F#" Value="abstract member AddToRunLoop : Foundation.NSRunLoop * Foundation.NSString -> unit
override this.AddToRunLoop : Foundation.NSRunLoop * Foundation.NSString -> unit" Usage="cADisplayLink.AddToRunLoop (runloop, mode)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Foundation.Export("addToRunLoop:forMode:")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="runloop" Type="Foundation.NSRunLoop" />
<Parameter Name="mode" Type="Foundation.NSString" />
</Parameters>
<Docs>
<param name="runloop">The runloop on which to run.</param>
<param name="mode">Modes in which the timer will be invoked, one of the various NSString constants in <see cref="T:Foundation.NSRunLoop" />.<para tool="nullallowed">This parameter can be <see langword="null" />.</para></param>
<summary>Trigger timer events on the specified runloop for the specified modes (weakly typed parameters).</summary>
<remarks>
<para>You should use the strongly typed version if possible, as it prevents common errors.</para>
<para>
The mode parameter will determine when the event is sent.
The NSRunLoop.NSDefaultRunLoopMode is not delivered during
UI tracking events (like scrolling in a UIScrollbar). For
getting those kinds of events use
NSRunLoop.UITrackingRunLoopMode. Or use
NSRunLoop.NSRunLoopCommonModes which covers both cases.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ClassHandle">
<MemberSignature Language="C#" Value="public override IntPtr ClassHandle { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance native int ClassHandle" />
<MemberSignature Language="DocId" Value="P:CoreAnimation.CADisplayLink.ClassHandle" />
<MemberSignature Language="F#" Value="member this.ClassHandle : nativeint" Usage="CoreAnimation.CADisplayLink.ClassHandle" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>The handle for this class.</summary>
<value>The pointer to the Objective-C class.</value>
<remarks>Each Xamarin.iOS class mirrors an unmanaged Objective-C class. This value contains the pointer to the Objective-C class, it is similar to calling objc_getClass with the object name.</remarks>
</Docs>
</Member>
<Member MemberName="Create">
<MemberSignature Language="C#" Value="public static CoreAnimation.CADisplayLink Create (Action action);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class CoreAnimation.CADisplayLink Create(class System.Action action) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreAnimation.CADisplayLink.Create(System.Action)" />
<MemberSignature Language="F#" Value="static member Create : Action -> CoreAnimation.CADisplayLink" Usage="CoreAnimation.CADisplayLink.Create action" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>CoreAnimation.CADisplayLink</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="action" Type="System.Action" />
</Parameters>
<Docs>
<param name="action">Method to invoke on each screen refresh.</param>
<summary>Registers the delegate to be invoked every time the display is about to be updated.</summary>
<returns>The DisplayLink object that will invoke the specified method on each screen update.</returns>
<remarks>Once you create the display link, you must add the handler to the runloop.</remarks>
</Docs>
</Member>
<Member MemberName="Create">
<MemberSignature Language="C#" Value="public static CoreAnimation.CADisplayLink Create (Foundation.NSObject target, ObjCRuntime.Selector sel);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class CoreAnimation.CADisplayLink Create(class Foundation.NSObject target, class ObjCRuntime.Selector sel) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreAnimation.CADisplayLink.Create(Foundation.NSObject,ObjCRuntime.Selector)" />
<MemberSignature Language="F#" Value="static member Create : Foundation.NSObject * ObjCRuntime.Selector -> CoreAnimation.CADisplayLink" Usage="CoreAnimation.CADisplayLink.Create (target, sel)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Foundation.Export("displayLinkWithTarget:selector:")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>CoreAnimation.CADisplayLink</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="target" Type="Foundation.NSObject" />
<Parameter Name="sel" Type="ObjCRuntime.Selector" />
</Parameters>
<Docs>
<param name="target">Target object to invoke the selector on.</param>
<param name="sel">Selector to invoke.</param>
<summary>Objective-C style registeration of the method to be invoked every time the display is about to be updated.</summary>
<returns>The DisplayLink object that will invoke the specified method on each screen update.</returns>
<remarks>
<para>
With C# you can use the Create overload that takes a NSAction as it can be used with lambdas.
</para>
<para>
Once you create the display link, you must add the handler to the runloop.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Duration">
<MemberSignature Language="C#" Value="public virtual double Duration { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 Duration" />
<MemberSignature Language="DocId" Value="P:CoreAnimation.CADisplayLink.Duration" />
<MemberSignature Language="F#" Value="member this.Duration : double" Usage="CoreAnimation.CADisplayLink.Duration" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: Foundation.Export("duration")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>The time between screen refreshes.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FrameInterval">
<MemberSignature Language="C#" Value="public virtual nint FrameInterval { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.nint FrameInterval" />
<MemberSignature Language="DocId" Value="P:CoreAnimation.CADisplayLink.FrameInterval" />
<MemberSignature Language="F#" Value="member this.FrameInterval : nint with get, set" Usage="CoreAnimation.CADisplayLink.FrameInterval" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Deprecated(ObjCRuntime.PlatformName.iOS, 10, 0, ObjCRuntime.PlatformArchitecture.None, "Use 'PreferredFramesPerSecond' property.")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Deprecated(ObjCRuntime.PlatformName.TvOS, 10, 0, ObjCRuntime.PlatformArchitecture.None, "Use 'PreferredFramesPerSecond' property.")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Deprecated(ObjCRuntime.PlatformName.WatchOS, 3, 0, ObjCRuntime.PlatformArchitecture.None, "Use 'PreferredFramesPerSecond' property.")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: Foundation.Export("frameInterval")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: ObjCRuntime.Deprecated(ObjCRuntime.PlatformName.iOS, 10, 0, ObjCRuntime.PlatformArchitecture.None, "Use 'PreferredFramesPerSecond' property.")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: ObjCRuntime.Deprecated(ObjCRuntime.PlatformName.TvOS, 10, 0, ObjCRuntime.PlatformArchitecture.None, "Use 'PreferredFramesPerSecond' property.")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: ObjCRuntime.Deprecated(ObjCRuntime.PlatformName.WatchOS, 3, 0, ObjCRuntime.PlatformArchitecture.None, "Use 'PreferredFramesPerSecond' property.")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>set: Foundation.Export("setFrameInterval:")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>set: ObjCRuntime.Deprecated(ObjCRuntime.PlatformName.iOS, 10, 0, ObjCRuntime.PlatformArchitecture.None, "Use 'PreferredFramesPerSecond' property.")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>set: ObjCRuntime.Deprecated(ObjCRuntime.PlatformName.TvOS, 10, 0, ObjCRuntime.PlatformArchitecture.None, "Use 'PreferredFramesPerSecond' property.")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>set: ObjCRuntime.Deprecated(ObjCRuntime.PlatformName.WatchOS, 3, 0, ObjCRuntime.PlatformArchitecture.None, "Use 'PreferredFramesPerSecond' property.")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.nint</ReturnType>
</ReturnValue>
<Docs>
<summary>Developers should not use this deprecated property. Developers should use 'PreferredFramesPerSecond' property.</summary>
<value>To be added.</value>
<remarks>
<para>
The default value is one, which means that your code is
invoked once each time that a screen refresh will take
place. If you set this value to two, then your method will
only be invoked half the time (once every two frames) and so
on.
</para>
<para>
In general, you should not skip frames. If your software
can not keep up with the frame rate, it is better to
increase the frame interval and deliver a consistent set
of updates.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Invalidate">
<MemberSignature Language="C#" Value="public virtual void Invalidate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Invalidate() cil managed" />
<MemberSignature Language="DocId" Value="M:CoreAnimation.CADisplayLink.Invalidate" />
<MemberSignature Language="F#" Value="abstract member Invalidate : unit -> unit
override this.Invalidate : unit -> unit" Usage="cADisplayLink.Invalidate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Foundation.Export("invalidate")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Terminates the connection between CoreAnimation and your code. This removes the CADisplayLink from all run loops.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Paused">
<MemberSignature Language="C#" Value="public virtual bool Paused { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool Paused" />
<MemberSignature Language="DocId" Value="P:CoreAnimation.CADisplayLink.Paused" />
<MemberSignature Language="F#" Value="member this.Paused : bool with get, set" Usage="CoreAnimation.CADisplayLink.Paused" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: Foundation.Export("isPaused")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>set: Foundation.Export("setPaused:")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Whether the notifications between the animation loop and your code are suspended.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PreferredFramesPerSecond">
<MemberSignature Language="C#" Value="public virtual nint PreferredFramesPerSecond { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.nint PreferredFramesPerSecond" />
<MemberSignature Language="DocId" Value="P:CoreAnimation.CADisplayLink.PreferredFramesPerSecond" />
<MemberSignature Language="F#" Value="member this.PreferredFramesPerSecond : nint with get, set" Usage="CoreAnimation.CADisplayLink.PreferredFramesPerSecond" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Introduced(ObjCRuntime.PlatformName.WatchOS, 3, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Introduced(ObjCRuntime.PlatformName.TvOS, 10, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 10, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: Foundation.Export("preferredFramesPerSecond")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: ObjCRuntime.Introduced(ObjCRuntime.PlatformName.WatchOS, 3, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: ObjCRuntime.Introduced(ObjCRuntime.PlatformName.TvOS, 10, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 10, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>set: Foundation.Export("setPreferredFramesPerSecond:")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>set: ObjCRuntime.Introduced(ObjCRuntime.PlatformName.WatchOS, 3, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>set: ObjCRuntime.Introduced(ObjCRuntime.PlatformName.TvOS, 10, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>set: ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 10, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.nint</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the preferred display rate.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RemoveFromRunLoop">
<MemberSignature Language="C#" Value="public void RemoveFromRunLoop (Foundation.NSRunLoop runloop, Foundation.NSRunLoopMode mode);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveFromRunLoop(class Foundation.NSRunLoop runloop, valuetype Foundation.NSRunLoopMode mode) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreAnimation.CADisplayLink.RemoveFromRunLoop(Foundation.NSRunLoop,Foundation.NSRunLoopMode)" />
<MemberSignature Language="F#" Value="member this.RemoveFromRunLoop : Foundation.NSRunLoop * Foundation.NSRunLoopMode -> unit" Usage="cADisplayLink.RemoveFromRunLoop (runloop, mode)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="runloop" Type="Foundation.NSRunLoop" />
<Parameter Name="mode" Type="Foundation.NSRunLoopMode" />
</Parameters>
<Docs>
<param name="runloop">The run loop from which to remove the display link.</param>
<param name="mode">The mode of the run loop.</param>
<summary>Removes the display link from the provided run loop when in the specified mode.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RemoveFromRunLoop">
<MemberSignature Language="C#" Value="public virtual void RemoveFromRunLoop (Foundation.NSRunLoop runloop, Foundation.NSString mode);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void RemoveFromRunLoop(class Foundation.NSRunLoop runloop, class Foundation.NSString mode) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreAnimation.CADisplayLink.RemoveFromRunLoop(Foundation.NSRunLoop,Foundation.NSString)" />
<MemberSignature Language="F#" Value="abstract member RemoveFromRunLoop : Foundation.NSRunLoop * Foundation.NSString -> unit
override this.RemoveFromRunLoop : Foundation.NSRunLoop * Foundation.NSString -> unit" Usage="cADisplayLink.RemoveFromRunLoop (runloop, mode)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Foundation.Export("removeFromRunLoop:forMode:")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="runloop" Type="Foundation.NSRunLoop" />
<Parameter Name="mode" Type="Foundation.NSString" />
</Parameters>
<Docs>
<param name="runloop">The run loop from which to remove the display link.</param>
<param name="mode">
<para>The mode of the run loop.</para>
<para tool="nullallowed">This parameter can be <see langword="null" />.</para>
</param>
<summary>Removes the display link from the provided run loop when in the specified mode.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TargetTimestamp">
<MemberSignature Language="C#" Value="public virtual double TargetTimestamp { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 TargetTimestamp" />
<MemberSignature Language="DocId" Value="P:CoreAnimation.CADisplayLink.TargetTimestamp" />
<MemberSignature Language="F#" Value="member this.TargetTimestamp : double" Usage="CoreAnimation.CADisplayLink.TargetTimestamp" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Introduced(ObjCRuntime.PlatformName.WatchOS, 3, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Introduced(ObjCRuntime.PlatformName.TvOS, 10, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 10, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: Foundation.Export("targetTimestamp")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: ObjCRuntime.Introduced(ObjCRuntime.PlatformName.WatchOS, 3, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: ObjCRuntime.Introduced(ObjCRuntime.PlatformName.TvOS, 10, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 10, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the time stamp for the desired time to start displaying the target of the display link.</summary>
<value>The time stamp for the desired time to start displaying the target of the display link.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Timestamp">
<MemberSignature Language="C#" Value="public virtual double Timestamp { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 Timestamp" />
<MemberSignature Language="DocId" Value="P:CoreAnimation.CADisplayLink.Timestamp" />
<MemberSignature Language="F#" Value="member this.Timestamp : double" Usage="CoreAnimation.CADisplayLink.Timestamp" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: Foundation.Export("timestamp")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>Timestamp for the last frame displayed.</summary>
<value>
</value>
<remarks>
<para>Developers can this value to compute which date should be displayed next.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>