-
Notifications
You must be signed in to change notification settings - Fork 0
/
ISurfaceHolder.xml
650 lines (650 loc) · 44 KB
/
ISurfaceHolder.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
<Type Name="ISurfaceHolder" FullName="Android.Views.ISurfaceHolder">
<TypeSignature Language="C#" Value="public interface ISurfaceHolder : Android.Runtime.IJavaObject, IDisposable, Java.Interop.IJavaPeerable" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit ISurfaceHolder implements class Android.Runtime.IJavaObject, class Java.Interop.IJavaPeerable, class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Android.Views.ISurfaceHolder" />
<TypeSignature Language="F#" Value="type ISurfaceHolder = interface
 interface IJavaObject
 interface IDisposable
 interface IJavaPeerable" />
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces>
<Interface>
<InterfaceName>Android.Runtime.IJavaObject</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Java.Interop.IJavaPeerable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("android/view/SurfaceHolder", "", "Android.Views.ISurfaceHolderInvoker")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("android/view/SurfaceHolder", "", "Android.Views.ISurfaceHolderInvoker")>]</AttributeName>
</Attribute>
</Attributes>
<Docs since="1">
<summary>Abstract interface to someone holding a display surface.</summary>
<remarks>
<para>Abstract interface to someone holding a display surface. Allows you to
control the surface size and format, edit the pixels in the surface, and
monitor changes to the surface. This interface is typically available
through the <c>SurfaceView</c> class.</para>
<para>When using this interface from a thread other than the one running
its <c>SurfaceView</c>, you will want to carefully read the
methods
<c>#lockCanvas</c> and <c>Callback#surfaceCreated Callback.surfaceCreated()</c>.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/SurfaceHolder" title="Reference documentation">Java documentation for <code>android.view.SurfaceHolder</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
</Docs>
<Members>
<Member MemberName="AddCallback">
<MemberSignature Language="C#" Value="public void AddCallback (Android.Views.ISurfaceHolderCallback? callback);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void AddCallback(class Android.Views.ISurfaceHolderCallback callback) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Views.ISurfaceHolder.AddCallback(Android.Views.ISurfaceHolderCallback)" />
<MemberSignature Language="F#" Value="abstract member AddCallback : Android.Views.ISurfaceHolderCallback -> unit" Usage="iSurfaceHolder.AddCallback callback" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("addCallback", "(Landroid/view/SurfaceHolder$Callback;)V", "GetAddCallback_Landroid_view_SurfaceHolder_Callback_Handler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("addCallback", "(Landroid/view/SurfaceHolder$Callback;)V", "GetAddCallback_Landroid_view_SurfaceHolder_Callback_Handler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="callback" Type="Android.Views.ISurfaceHolderCallback" />
</Parameters>
<Docs>
<param name="callback">The new Callback interface.</param>
<summary>Add a Callback interface for this holder.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/SurfaceHolder#addCallback(android.view.Callback)" title="Reference documentation">Java documentation for <code>android.view.SurfaceHolder.addCallback(android.view.Callback)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
</Docs>
</Member>
<Member MemberName="IsCreating">
<MemberSignature Language="C#" Value="public bool IsCreating { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsCreating" />
<MemberSignature Language="DocId" Value="P:Android.Views.ISurfaceHolder.IsCreating" />
<MemberSignature Language="F#" Value="member this.IsCreating : bool" Usage="Android.Views.ISurfaceHolder.IsCreating" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[get: Android.Runtime.Register("isCreating", "()Z", "GetIsCreatingHandler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<get: Android.Runtime.Register("isCreating", "()Z", "GetIsCreatingHandler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Use this method to find out if the surface is in the process of being
created from Callback methods.</summary>
<value>To be added.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
</Docs>
</Member>
<Member MemberName="LockCanvas">
<MemberSignature Language="C#" Value="public Android.Graphics.Canvas? LockCanvas ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Android.Graphics.Canvas LockCanvas() cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Views.ISurfaceHolder.LockCanvas" />
<MemberSignature Language="F#" Value="abstract member LockCanvas : unit -> Android.Graphics.Canvas" Usage="iSurfaceHolder.LockCanvas " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("lockCanvas", "()Landroid/graphics/Canvas;", "GetLockCanvasHandler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("lockCanvas", "()Landroid/graphics/Canvas;", "GetLockCanvasHandler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Android.Graphics.Canvas</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Start editing the pixels in the surface.</summary>
<returns>Canvas Use to draw into the surface.</returns>
<remarks>
<para>Start editing the pixels in the surface. The returned Canvas can be used
to draw into the surface's bitmap. A null is returned if the surface has
not been created or otherwise cannot be edited. You will usually need
to implement <c>Callback#surfaceCreated Callback.surfaceCreated</c>
to find out when the Surface is available for use.</para>
<para>The content of the Surface is never preserved between unlockCanvas() and
lockCanvas(), for this reason, every pixel within the Surface area
must be written. The only exception to this rule is when a dirty
rectangle is specified, in which case, non-dirty pixels will be
preserved.</para>
<para>If you call this repeatedly when the Surface is not ready (before
<c>Callback#surfaceCreated Callback.surfaceCreated</c> or after
<c>Callback#surfaceDestroyed Callback.surfaceDestroyed</c>), your calls
will be throttled to a slow rate in order to avoid consuming CPU.</para>
<para>If null is not returned, this function internally holds a lock until
the corresponding <c>#unlockCanvasAndPost</c> call, preventing
<c>SurfaceView</c> from creating, destroying, or modifying the surface
while it is being drawn. This can be more convenient than accessing
the Surface directly, as you do not need to do special synchronization
with a drawing thread in <c>Callback#surfaceDestroyed
Callback.surfaceDestroyed</c>.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/SurfaceHolder#lockCanvas()" title="Reference documentation">Java documentation for <code>android.view.SurfaceHolder.lockCanvas()</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
</Docs>
</Member>
<Member MemberName="LockCanvas">
<MemberSignature Language="C#" Value="public Android.Graphics.Canvas? LockCanvas (Android.Graphics.Rect? dirty);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Android.Graphics.Canvas LockCanvas(class Android.Graphics.Rect dirty) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Views.ISurfaceHolder.LockCanvas(Android.Graphics.Rect)" />
<MemberSignature Language="F#" Value="abstract member LockCanvas : Android.Graphics.Rect -> Android.Graphics.Canvas" Usage="iSurfaceHolder.LockCanvas dirty" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("lockCanvas", "(Landroid/graphics/Rect;)Landroid/graphics/Canvas;", "GetLockCanvas_Landroid_graphics_Rect_Handler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("lockCanvas", "(Landroid/graphics/Rect;)Landroid/graphics/Canvas;", "GetLockCanvas_Landroid_graphics_Rect_Handler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Android.Graphics.Canvas</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dirty" Type="Android.Graphics.Rect" />
</Parameters>
<Docs>
<param name="dirty">Area of the Surface that will be modified.</param>
<summary>Just like <c>#lockCanvas()</c> but allows specification of a dirty rectangle.</summary>
<returns>Canvas Use to draw into the surface.</returns>
<remarks>
<para>Just like <c>#lockCanvas()</c> but allows specification of a dirty rectangle.
Every
pixel within that rectangle must be written; however pixels outside
the dirty rectangle will be preserved by the next call to lockCanvas().</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/SurfaceHolder#lockCanvas(android.graphics.Rect)" title="Reference documentation">Java documentation for <code>android.view.SurfaceHolder.lockCanvas(android.graphics.Rect)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
<altmember cref="M:Android.Views.ISurfaceHolder.LockCanvas" />
</Docs>
</Member>
<Member MemberName="LockHardwareCanvas">
<MemberSignature Language="C#" Value="public virtual Android.Graphics.Canvas? LockHardwareCanvas ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Android.Graphics.Canvas LockHardwareCanvas() cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Views.ISurfaceHolder.LockHardwareCanvas" />
<MemberSignature Language="F#" Value="abstract member LockHardwareCanvas : unit -> Android.Graphics.Canvas
override this.LockHardwareCanvas : unit -> Android.Graphics.Canvas" Usage="iSurfaceHolder.LockHardwareCanvas " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("lockHardwareCanvas", "()Landroid/graphics/Canvas;", "GetLockHardwareCanvasHandler:Android.Views.ISurfaceHolder, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=26)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("lockHardwareCanvas", "()Landroid/graphics/Canvas;", "GetLockHardwareCanvasHandler:Android.Views.ISurfaceHolder, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=26)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android26.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Android.Graphics.Canvas</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Just like <c>#lockCanvas()</c> but the returned canvas is hardware-accelerated.</summary>
<returns>Canvas Use to draw into the surface.</returns>
<remarks>
<para>Just like <c>#lockCanvas()</c> but the returned canvas is hardware-accelerated.</para>
<para>See the <see href="https://developer.android.com/guide/topics/graphics/hardware-accel.html#unsupported">
unsupported drawing operations</see> for a list of what is and isn't
supported in a hardware-accelerated canvas.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/SurfaceHolder#lockHardwareCanvas()" title="Reference documentation">Java documentation for <code>android.view.SurfaceHolder.lockHardwareCanvas()</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="RemoveCallback">
<MemberSignature Language="C#" Value="public void RemoveCallback (Android.Views.ISurfaceHolderCallback? callback);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void RemoveCallback(class Android.Views.ISurfaceHolderCallback callback) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Views.ISurfaceHolder.RemoveCallback(Android.Views.ISurfaceHolderCallback)" />
<MemberSignature Language="F#" Value="abstract member RemoveCallback : Android.Views.ISurfaceHolderCallback -> unit" Usage="iSurfaceHolder.RemoveCallback callback" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("removeCallback", "(Landroid/view/SurfaceHolder$Callback;)V", "GetRemoveCallback_Landroid_view_SurfaceHolder_Callback_Handler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("removeCallback", "(Landroid/view/SurfaceHolder$Callback;)V", "GetRemoveCallback_Landroid_view_SurfaceHolder_Callback_Handler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="callback" Type="Android.Views.ISurfaceHolderCallback" />
</Parameters>
<Docs>
<param name="callback">The Callback interface to remove.</param>
<summary>Removes a previously added Callback interface from this holder.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/SurfaceHolder#removeCallback(android.view.Callback)" title="Reference documentation">Java documentation for <code>android.view.SurfaceHolder.removeCallback(android.view.Callback)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
</Docs>
</Member>
<Member MemberName="SetFixedSize">
<MemberSignature Language="C#" Value="public void SetFixedSize (int width, int height);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SetFixedSize(int32 width, int32 height) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Views.ISurfaceHolder.SetFixedSize(System.Int32,System.Int32)" />
<MemberSignature Language="F#" Value="abstract member SetFixedSize : int * int -> unit" Usage="iSurfaceHolder.SetFixedSize (width, height)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("setFixedSize", "(II)V", "GetSetFixedSize_IIHandler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("setFixedSize", "(II)V", "GetSetFixedSize_IIHandler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="width" Type="System.Int32" />
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<param name="width">The surface's width.</param>
<param name="height">The surface's height.</param>
<summary>Make the surface a fixed size.</summary>
<remarks>
<para>Make the surface a fixed size. It will never change from this size.
When working with a <c>SurfaceView</c>, this must be called from the
same thread running the SurfaceView's window.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/SurfaceHolder#setFixedSize(int,%20int)" title="Reference documentation">Java documentation for <code>android.view.SurfaceHolder.setFixedSize(int, int)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
</Docs>
</Member>
<Member MemberName="SetFormat">
<MemberSignature Language="C#" Value="public void SetFormat (Android.Graphics.Format format);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SetFormat(valuetype Android.Graphics.Format format) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Views.ISurfaceHolder.SetFormat(Android.Graphics.Format)" />
<MemberSignature Language="F#" Value="abstract member SetFormat : Android.Graphics.Format -> unit" Usage="iSurfaceHolder.SetFormat format" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("setFormat", "(I)V", "GetSetFormat_IHandler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("setFormat", "(I)V", "GetSetFormat_IHandler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="Android.Graphics.Format">
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.GeneratedEnum]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.GeneratedEnum>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="format">A constant from PixelFormat.</param>
<summary>Set the desired PixelFormat of the surface.</summary>
<remarks>
<para>Set the desired PixelFormat of the surface. The default is OPAQUE.
When working with a <c>SurfaceView</c>, this must be called from the
same thread running the SurfaceView's window.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/SurfaceHolder#setFormat(int)" title="Reference documentation">Java documentation for <code>android.view.SurfaceHolder.setFormat(int)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
<altmember cref="T:Android.Graphics.PixelFormat" />
</Docs>
</Member>
<Member MemberName="SetKeepScreenOn">
<MemberSignature Language="C#" Value="public void SetKeepScreenOn (bool screenOn);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SetKeepScreenOn(bool screenOn) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Views.ISurfaceHolder.SetKeepScreenOn(System.Boolean)" />
<MemberSignature Language="F#" Value="abstract member SetKeepScreenOn : bool -> unit" Usage="iSurfaceHolder.SetKeepScreenOn screenOn" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("setKeepScreenOn", "(Z)V", "GetSetKeepScreenOn_ZHandler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("setKeepScreenOn", "(Z)V", "GetSetKeepScreenOn_ZHandler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="screenOn" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="screenOn">Set to true to force the screen to stay on, false
to allow it to turn off.</param>
<summary>Enable or disable option to keep the screen turned on while this
surface is displayed.</summary>
<remarks>
<para>Enable or disable option to keep the screen turned on while this
surface is displayed. The default is false, allowing it to turn off.
This is safe to call from any thread.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/SurfaceHolder#setKeepScreenOn(boolean)" title="Reference documentation">Java documentation for <code>android.view.SurfaceHolder.setKeepScreenOn(boolean)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
</Docs>
</Member>
<Member MemberName="SetSizeFromLayout">
<MemberSignature Language="C#" Value="public void SetSizeFromLayout ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SetSizeFromLayout() cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Views.ISurfaceHolder.SetSizeFromLayout" />
<MemberSignature Language="F#" Value="abstract member SetSizeFromLayout : unit -> unit" Usage="iSurfaceHolder.SetSizeFromLayout " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("setSizeFromLayout", "()V", "GetSetSizeFromLayoutHandler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("setSizeFromLayout", "()V", "GetSetSizeFromLayoutHandler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Allow the surface to resized based on layout of its container (this is
the default).</summary>
<remarks>
<para>Allow the surface to resized based on layout of its container (this is
the default). When this is enabled, you should monitor
<c>Callback#surfaceChanged</c> for changes to the size of the surface.
When working with a <c>SurfaceView</c>, this must be called from the
same thread running the SurfaceView's window.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/SurfaceHolder#setSizeFromLayout()" title="Reference documentation">Java documentation for <code>android.view.SurfaceHolder.setSizeFromLayout()</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
</Docs>
</Member>
<Member MemberName="SetType">
<MemberSignature Language="C#" Value="public void SetType (Android.Views.SurfaceType type);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SetType(valuetype Android.Views.SurfaceType type) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Views.ISurfaceHolder.SetType(Android.Views.SurfaceType)" />
<MemberSignature Language="F#" Value="abstract member SetType : Android.Views.SurfaceType -> unit" Usage="iSurfaceHolder.SetType type" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("setType", "(I)V", "GetSetType_IHandler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("setType", "(I)V", "GetSetType_IHandler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("deprecated")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("deprecated")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="Android.Views.SurfaceType">
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.GeneratedEnum]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.GeneratedEnum>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="type">To be added.</param>
<summary>Sets the surface's type.</summary>
<remarks>
<para>Sets the surface's type.</para>
<para>This member is deprecated. this is ignored, this value is set automatically when needed.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/SurfaceHolder#setType(int)" title="Reference documentation">Java documentation for <code>android.view.SurfaceHolder.setType(int)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
</Docs>
</Member>
<Member MemberName="Surface">
<MemberSignature Language="C#" Value="public Android.Views.Surface? Surface { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Android.Views.Surface Surface" />
<MemberSignature Language="DocId" Value="P:Android.Views.ISurfaceHolder.Surface" />
<MemberSignature Language="F#" Value="member this.Surface : Android.Views.Surface" Usage="Android.Views.ISurfaceHolder.Surface" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[get: Android.Runtime.Register("getSurface", "()Landroid/view/Surface;", "GetGetSurfaceHandler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<get: Android.Runtime.Register("getSurface", "()Landroid/view/Surface;", "GetGetSurfaceHandler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Android.Views.Surface</ReturnType>
</ReturnValue>
<Docs>
<summary>Direct access to the surface object.</summary>
<value>To be added.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
</Docs>
</Member>
<Member MemberName="SurfaceFrame">
<MemberSignature Language="C#" Value="public Android.Graphics.Rect? SurfaceFrame { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Android.Graphics.Rect SurfaceFrame" />
<MemberSignature Language="DocId" Value="P:Android.Views.ISurfaceHolder.SurfaceFrame" />
<MemberSignature Language="F#" Value="member this.SurfaceFrame : Android.Graphics.Rect" Usage="Android.Views.ISurfaceHolder.SurfaceFrame" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[get: Android.Runtime.Register("getSurfaceFrame", "()Landroid/graphics/Rect;", "GetGetSurfaceFrameHandler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<get: Android.Runtime.Register("getSurfaceFrame", "()Landroid/graphics/Rect;", "GetGetSurfaceFrameHandler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Android.Graphics.Rect</ReturnType>
</ReturnValue>
<Docs>
<summary>Retrieve the current size of the surface.</summary>
<value>To be added.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
</Docs>
</Member>
<Member MemberName="UnlockCanvasAndPost">
<MemberSignature Language="C#" Value="public void UnlockCanvasAndPost (Android.Graphics.Canvas? canvas);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void UnlockCanvasAndPost(class Android.Graphics.Canvas canvas) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Views.ISurfaceHolder.UnlockCanvasAndPost(Android.Graphics.Canvas)" />
<MemberSignature Language="F#" Value="abstract member UnlockCanvasAndPost : Android.Graphics.Canvas -> unit" Usage="iSurfaceHolder.UnlockCanvasAndPost canvas" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("unlockCanvasAndPost", "(Landroid/graphics/Canvas;)V", "GetUnlockCanvasAndPost_Landroid_graphics_Canvas_Handler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("unlockCanvasAndPost", "(Landroid/graphics/Canvas;)V", "GetUnlockCanvasAndPost_Landroid_graphics_Canvas_Handler:Android.Views.ISurfaceHolderInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="canvas" Type="Android.Graphics.Canvas" />
</Parameters>
<Docs>
<param name="canvas">The Canvas previously returned by lockCanvas().</param>
<summary>Finish editing pixels in the surface.</summary>
<remarks>
<para>Finish editing pixels in the surface. After this call, the surface's
current pixels will be shown on the screen, but its content is lost,
in particular there is no guarantee that the content of the Surface
will remain unchanged when lockCanvas() is called again.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/SurfaceHolder#unlockCanvasAndPost(android.graphics.Canvas)" title="Reference documentation">Java documentation for <code>android.view.SurfaceHolder.unlockCanvasAndPost(android.graphics.Canvas)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
<altmember cref="M:Android.Views.ISurfaceHolder.LockCanvas" />
</Docs>
</Member>
</Members>
</Type>