-
Notifications
You must be signed in to change notification settings - Fork 0
/
AgateLib.xml
11386 lines (11235 loc) · 481 KB
/
AgateLib.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
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>AgateLib</name>
</assembly>
<members>
<member name="T:AgateLib.Serialization.Xle.XleSerializer">
<summary>
Class used to serialize data to a compact XML format.
</summary>
</member>
<member name="M:AgateLib.Serialization.Xle.XleSerializer.#ctor(System.Type)">
<summary>
Constructs the XleSerializer. Pass in the type of the object which is
the root of the object graph which needs to be serialized. This type must
implement the IXleSerializable interface.
</summary>
<param name="objectType">The type of the object to serialize.</param>
</member>
<member name="M:AgateLib.Serialization.Xle.XleSerializer.Serialize(System.IO.Stream,AgateLib.Serialization.Xle.IXleSerializable)">
<summary>
Serializes an object which implements IXleSerializable to the specified stream.
</summary>
<param name="outStream">The stream to write the XML data to.</param>
<param name="objectGraph">The object to serialize.</param>
</member>
<member name="M:AgateLib.Serialization.Xle.XleSerializer.Deserialize(System.IO.Stream)">
<summary>
Deserializes an object from the XML data in the specified stream.
</summary>
<param name="inStream">The stream containing the XML data.</param>
<returns>The deserialized object.</returns>
</member>
<member name="M:AgateLib.Serialization.Xle.XleSerializer.Deserialize``1(System.IO.Stream)">
<summary>
Deserializes an object from the XML data in the specified stream with the specified type.
</summary>
<typeparam name="T">Type to cast the return value to.</typeparam>
<param name="inStream">The stream containing the XML data.</param>
<returns>The deserialized object.</returns>
</member>
<member name="P:AgateLib.Serialization.Xle.XleSerializer.Binder">
<summary>
An object which implements the AgateLib.Serialization.Xle.ITypeBinder interface.
This object is used to convert strings to System.Type objects. The default value
for this property is an object of type AgateLib.Serialization.Xle.TypeBinder, but
it may be replaced for custom type binding.
</summary>
</member>
<member name="T:AgateLib.Resources.AgateResource">
<summary>
Class which represents a resource.
</summary>
</member>
<member name="M:AgateLib.Resources.AgateResource.#ctor(System.String)">
<summary>
Constructs a base resource object.
</summary>
<param name="name"></param>
</member>
<member name="M:AgateLib.Resources.AgateResource.BuildNodes(System.Xml.XmlElement,System.Xml.XmlDocument)">
<summary>
Serializes the AgateResource object to a subelement of parent.
</summary>
<param name="parent">The parent element of this resource.</param>
<param name="doc">The XML document used to create elements.</param>
</member>
<member name="M:AgateLib.Resources.AgateResource.Clone">
<summary>
Override to construct a copy of the resource.
</summary>
<returns></returns>
</member>
<member name="P:AgateLib.Resources.AgateResource.Name">
<summary>
Name of the resource
</summary>
</member>
<member name="P:AgateLib.Resources.AgateResource.Language">
<summary>
Language this resource is to be used for. If this is a language-independent
resource, then the Language will be "Default".
</summary>
</member>
<member name="T:AgateLib.DisplayLib.ScreenMode">
<summary>
Class which contains information about an available screen mode.
</summary>
</member>
<member name="M:AgateLib.DisplayLib.ScreenMode.#ctor(System.Int32,System.Int32,System.Int32)">
<summary>
Constructs a ScreenMode object.
</summary>
<param name="width"></param>
<param name="height"></param>
<param name="bpp"></param>
</member>
<member name="M:AgateLib.DisplayLib.ScreenMode.SelectBestMode(System.Int32,System.Int32,System.Int32)">
<summary>
Searches through the available screen resolutions and selects the one
which is the closest match for the parameters passed in.
</summary>
<param name="width"></param>
<param name="height"></param>
<param name="bpp"></param>
<returns>null if no screen mode could be found, otherwise the appropriate
ScreenMode structure.</returns>
</member>
<member name="P:AgateLib.DisplayLib.ScreenMode.Width">
<summary>
Width of the screen mode in pixels.
</summary>
</member>
<member name="P:AgateLib.DisplayLib.ScreenMode.Height">
<summary>
Height of the screen mode in pixels.
</summary>
</member>
<member name="P:AgateLib.DisplayLib.ScreenMode.Bpp">
<summary>
Bits per pixel of the screen mode.
</summary>
</member>
<member name="T:AgateLib.Sprites.SpriteFrame">
<summary>
Class for a single frame of a sprite.
This class can automatically trim the frame, so that extra space around the
object which is transparent is not drawn. This is taken advantage of if
surfaces are packed to create a tighter packing and fit more objects on
the same texture.
SpriteFrame contains a reference count. If you manually copy it, be sure
to call AddRef unless you use the Clone method.
</summary>
</member>
<member name="T:AgateLib.DisplayLib.ISpriteFrame">
<summary>
Basic interface implemented by a particular frame in a sprite.
</summary>
</member>
<member name="M:AgateLib.DisplayLib.ISpriteFrame.Draw(System.Single,System.Single,System.Single,System.Single)">
<summary>
Draws the frame.
</summary>
<param name="dest_x"></param>
<param name="dest_y"></param>
<param name="rotationCenterX"></param>
<param name="rotationCenterY"></param>
</member>
<member name="P:AgateLib.DisplayLib.ISpriteFrame.Surface">
<summary>
Gets the surface object the frame is drawn from
</summary>
</member>
<member name="P:AgateLib.DisplayLib.ISpriteFrame.SourceRect">
<summary>
Gets the source rectangle on the surface the frame is drawn from.
</summary>
</member>
<member name="M:AgateLib.Sprites.SpriteFrame.Clone">
<summary>
Copies this object.
Actually, this just returns this
object, since there are no unmanaged resources to deal with.
Be sure to Dispose the result when finished with it.
</summary>
<returns></returns>
</member>
<member name="M:AgateLib.Sprites.SpriteFrame.IsBlank">
<summary>
Returns true if the entire frame is transparent.
</summary>
</member>
<member name="M:AgateLib.Sprites.SpriteFrame.Draw(System.Single,System.Single,System.Single,System.Single)">
<summary>
Draws the sprite frame at the specified location rotated around the specified point.
</summary>
<param name="dest_x"></param>
<param name="dest_y"></param>
<param name="rotationCenterX"></param>
<param name="rotationCenterY"></param>
</member>
<member name="M:AgateLib.Sprites.SpriteFrame.ToString">
<summary>
Converst to a string.
</summary>
<returns></returns>
</member>
<member name="P:AgateLib.Sprites.SpriteFrame.SourceRect">
<summary>
Gets or sets the source rectangle for this frame.
</summary>
</member>
<member name="P:AgateLib.Sprites.SpriteFrame.Offset">
<summary>
Gets or sets the offset for drawing this frame.
</summary>
</member>
<member name="P:AgateLib.Sprites.SpriteFrame.DisplaySize">
<summary>
Gets or sets the display size.
</summary>
</member>
<member name="P:AgateLib.Sprites.SpriteFrame.Surface">
<summary>
</summary>
</member>
<member name="T:AgateLib.Sprites.IFrameList">
<summary>
Iterface implemented by a list of sprite frames.
This provides a read-only view into the frames in a sprite.
</summary>
</member>
<member name="M:AgateLib.Sprites.IFrameList.IndexOf(AgateLib.DisplayLib.ISpriteFrame)">
<summary>
Searches for a particular frame.
</summary>
<param name="item"></param>
<returns></returns>
</member>
<member name="M:AgateLib.Sprites.IFrameList.Contains(AgateLib.DisplayLib.ISpriteFrame)">
<summary>
Returns a bool indicating whether the specified frame is
contained in the list.
</summary>
<param name="item"></param>
<returns></returns>
</member>
<member name="M:AgateLib.Sprites.IFrameList.CopyTo(AgateLib.DisplayLib.ISpriteFrame[],System.Int32)">
<summary>
Copies the list of frame to a target array.
</summary>
<param name="array"></param>
<param name="arrayIndex"></param>
</member>
<member name="P:AgateLib.Sprites.IFrameList.Count">
<summary>
Returns the number of frames in the list.
</summary>
</member>
<member name="P:AgateLib.Sprites.IFrameList.Item(System.Int32)">
<summary>
Gets a frame by index.
</summary>
<param name="index"></param>
<returns></returns>
</member>
<member name="T:AgateLib.ImplementationBase.DisplayWindowImpl">
<summary>
Implementation of DisplayWindow class.
</summary>
</member>
<member name="T:AgateLib.ImplementationBase.IRenderTargetImpl">
<summary>
Defines the interface used for render targets.
SurfaceImpl and DisplayWindowImpl implement this interface.
</summary>
</member>
<member name="M:AgateLib.ImplementationBase.IRenderTargetImpl.BeginRender">
<summary>
Utility functions that can be called by the rendering system
when rendering starts and ends.
</summary>
</member>
<member name="M:AgateLib.ImplementationBase.IRenderTargetImpl.EndRender">
<summary>
Utility functions that can be called by the rendering system
when rendering starts and ends.
</summary>
</member>
<member name="P:AgateLib.ImplementationBase.IRenderTargetImpl.Size">
<summary>
Gets the Size of the render target, in pixels.
</summary>
</member>
<member name="P:AgateLib.ImplementationBase.IRenderTargetImpl.Width">
<summary>
Gets the Height of the render target, in pixels.
</summary>
</member>
<member name="P:AgateLib.ImplementationBase.IRenderTargetImpl.Height">
<summary>
Gets the Width of the render target, in pixels.
</summary>
</member>
<member name="M:AgateLib.ImplementationBase.DisplayWindowImpl.Dispose">
<summary>
Disposes of unmanaged resources.
</summary>
</member>
<member name="M:AgateLib.ImplementationBase.DisplayWindowImpl.ToggleFullScreen">
<summary>
Toggles windowed/fullscreen.
If this is unsupported, this method should silently return
(do not throw an error).
</summary>
</member>
<member name="M:AgateLib.ImplementationBase.DisplayWindowImpl.ToggleFullScreen(System.Int32,System.Int32,System.Int32)">
<summary>
Toggles windowed/fullscreen.
If this is unsupported, this method should silently return
(do not throw an error).
Attempts to match width, height and bpp as best as possible.
</summary>
<param name="width"></param>
<param name="height"></param>
<param name="bpp"></param>
</member>
<member name="M:AgateLib.ImplementationBase.DisplayWindowImpl.SetWindowed">
<summary>
Sets the display to windowed. Does nothing if the display is already
windowed. The DisplayWindow retains the same height and width as the
previous full screen resolution.
</summary>
</member>
<member name="M:AgateLib.ImplementationBase.DisplayWindowImpl.SetFullScreen">
<summary>
Sets the display to a full screen Display. This overload should use the
same resolution as the desktop environment.
</summary>
</member>
<member name="M:AgateLib.ImplementationBase.DisplayWindowImpl.SetFullScreen(System.Int32,System.Int32,System.Int32)">
<summary>
Sets the display to a full screen Display. The resolution chosen is
driver/video card/monitor dependent, but it should be fairly close to
values specified.
</summary>
<param name="width"></param>
<param name="height"></param>
<param name="bpp"></param>
</member>
<member name="M:AgateLib.ImplementationBase.DisplayWindowImpl.BeginRender">
<summary>
Utility function which may be called by the DisplayImpl when
rendering begins.
</summary>
</member>
<member name="M:AgateLib.ImplementationBase.DisplayWindowImpl.EndRender">
<summary>
Utility function which may be called by the DisplayImpl when
rendering is done.
</summary>
</member>
<member name="P:AgateLib.ImplementationBase.DisplayWindowImpl.IsClosed">
<summary>
Returns true if the DisplayWindowImpl has been closed.
This happens if the user clicks the close box, or Dispose is called.
</summary>
</member>
<member name="P:AgateLib.ImplementationBase.DisplayWindowImpl.IsFullScreen">
<summary>
Returns true if this DisplayWindowImpl is being used as a full-screen
device.
</summary>
</member>
<member name="P:AgateLib.ImplementationBase.DisplayWindowImpl.Size">
<summary>
Gets or sets the size of the render area.
</summary>
</member>
<member name="P:AgateLib.ImplementationBase.DisplayWindowImpl.Width">
<summary>
Gets or sets the width of the render area.
</summary>
</member>
<member name="P:AgateLib.ImplementationBase.DisplayWindowImpl.Height">
<summary>
Gets or sets the height of the render area.
</summary>
</member>
<member name="P:AgateLib.ImplementationBase.DisplayWindowImpl.Title">
<summary>
Gets or sets the window title.
</summary>
</member>
<member name="P:AgateLib.ImplementationBase.DisplayWindowImpl.MousePosition">
<summary>
Gets or sets the mouse position within the render area.
</summary>
</member>
<member name="T:AgateLib.ImplementationBase.AudioImpl">
<summary>
Implements Audio class factory.
</summary>
</member>
<member name="T:AgateLib.ImplementationBase.DriverImplBase">
<summary>
Base class all driver classes should implement.
</summary>
</member>
<member name="M:AgateLib.ImplementationBase.DriverImplBase.Initialize">
<summary>
Initialization beyond what the constructor does.
</summary>
</member>
<member name="M:AgateLib.ImplementationBase.DriverImplBase.Dispose">
<summary>
Disposes of unmanaged resources.
</summary>
</member>
<member name="M:AgateLib.ImplementationBase.DriverImplBase.Report(System.String)">
<summary>
Called by drivers in their Initialize routine to report
which driver was instantiated.
</summary>
<param name="text"></param>
</member>
<member name="M:AgateLib.ImplementationBase.AudioImpl.CreateSoundBuffer(System.String)">
<summary>
Creates a SoundBufferImpl object.
</summary>
<param name="filename"></param>
<returns></returns>
</member>
<member name="M:AgateLib.ImplementationBase.AudioImpl.CreateMusic(System.String)">
<summary>
Creates a MusicImpl object.
</summary>
<param name="filename"></param>
<returns></returns>
</member>
<member name="M:AgateLib.ImplementationBase.AudioImpl.CreateMusic(System.IO.Stream)">
<summary>
Creates a MusicImpl object.
</summary>
<param name="musicStream"></param>
<returns></returns>
</member>
<member name="M:AgateLib.ImplementationBase.AudioImpl.CreateSoundBufferSession(AgateLib.ImplementationBase.SoundBufferImpl)">
<summary>
Creates a SoundBufferSessionImpl object.
</summary>
<param name="buffer"></param>
<returns></returns>
</member>
<member name="M:AgateLib.ImplementationBase.AudioImpl.CreateSoundBuffer(System.IO.Stream)">
<summary>
Creates a SoundBufferImpl object.
</summary>
<param name="inStream"></param>
<returns></returns>
</member>
<member name="M:AgateLib.ImplementationBase.AudioImpl.Update">
<summary>
This function is called once a frame to allow the Audio driver to update
information. There is no need to call base.Update() if overriding this
function.
</summary>
</member>
<member name="T:AgateLib.ImplementationBase.SoundBufferImpl">
<summary>
Implements a SoundBuffer
</summary>
</member>
<member name="M:AgateLib.ImplementationBase.SoundBufferImpl.Dispose">
<summary>
Destroys unmanaged resources.
</summary>
</member>
<member name="P:AgateLib.ImplementationBase.SoundBufferImpl.Volume">
<summary>
Gets or sets the volume this audio file is playing at.
0.0 is completely quiet.
0.5 sounds like half maximum volume
1.0 is maximum volume.
</summary>
</member>
<member name="T:AgateLib.ImplementationBase.SoundBufferSessionImpl">
<summary>
Represents a playback instance.
</summary>
</member>
<member name="M:AgateLib.ImplementationBase.SoundBufferSessionImpl.Dispose">
<summary>
Destroyes unmanaged resources.
</summary>
</member>
<member name="M:AgateLib.ImplementationBase.SoundBufferSessionImpl.Play">
<summary>
Starts at the beginning.
</summary>
</member>
<member name="M:AgateLib.ImplementationBase.SoundBufferSessionImpl.Stop">
<summary>
Stops.
</summary>
</member>
<member name="P:AgateLib.ImplementationBase.SoundBufferSessionImpl.Volume">
<summary>
Gets or sets the volume this audio file is playing at.
0.0 is completely quiet.
0.5 sounds like half maximum volume
1.0 is maximum volume.
</summary>
</member>
<member name="P:AgateLib.ImplementationBase.SoundBufferSessionImpl.Pan">
<summary>
Gets or sets the left-right balance.
-1 is left speaker
0 is middle (both)
1 is right.
</summary>
</member>
<member name="P:AgateLib.ImplementationBase.SoundBufferSessionImpl.IsPlaying">
<summary>
Gets whether or not this playback instance is actually playing.
</summary>
</member>
<member name="T:AgateLib.ImplementationBase.MusicImpl">
<summary>
Class which implements a Music object.
</summary>
</member>
<member name="M:AgateLib.ImplementationBase.MusicImpl.OnSetLoop(System.Boolean)">
<summary>
Function called when IsLooping is set to a new value.
</summary>
<param name="value"></param>
</member>
<member name="M:AgateLib.ImplementationBase.MusicImpl.Dispose">
<summary>
Dispose
</summary>
</member>
<member name="M:AgateLib.ImplementationBase.MusicImpl.Play">
<summary>
Start over at beginning.
</summary>
</member>
<member name="M:AgateLib.ImplementationBase.MusicImpl.Stop">
<summary>
Stop playing.
</summary>
</member>
<member name="P:AgateLib.ImplementationBase.MusicImpl.IsLooping">
<summary>
Gets or sets whether or not this Music is looping.
</summary>
</member>
<member name="P:AgateLib.ImplementationBase.MusicImpl.Volume">
<summary>
Gets or sets the volume this audio file is playing at.
0.0 is completely quiet.
0.5 sounds like half maximum volume
1.0 is maximum volume.
</summary>
</member>
<member name="P:AgateLib.ImplementationBase.MusicImpl.Pan">
<summary>
Gets or sets the left-right balance. This may or may not be supported
by some drivers.
-1 is entirely in the left speaker,
0 is equally in both and,
1 is entirely in the right speaker.
If this is unsupported by the driver, don't allow impl.Pan to change from zero.
</summary>
</member>
<member name="P:AgateLib.ImplementationBase.MusicImpl.IsPlaying">
<summary>
Gets whether or not it's currently playing.
</summary>
</member>
<member name="T:AgateLib.Drivers.SetSystemsDialogResult">
<summary>
Enum for the results of a call to IUserSetSystem.RunDialog
</summary>
</member>
<member name="F:AgateLib.Drivers.SetSystemsDialogResult.OK">
<summary>
Value for when the user pressed OK
</summary>
</member>
<member name="F:AgateLib.Drivers.SetSystemsDialogResult.Cancel">
<summary>
Value for when the user pressed CANCEL
</summary>
</member>
<member name="T:AgateLib.Drivers.IUserSetSystems">
<summary>
Interface for asking the user which Agate drivers to invoke.
</summary>
</member>
<member name="M:AgateLib.Drivers.IUserSetSystems.AddDisplayType(AgateLib.Drivers.AgateDriverInfo)">
<summary>
Adds a Display driver to the possible options.
</summary>
<param name="info"></param>
</member>
<member name="M:AgateLib.Drivers.IUserSetSystems.AddAudioType(AgateLib.Drivers.AgateDriverInfo)">
<summary>
Adds a Audio driver to the possible options.
</summary>
<param name="info"></param>
</member>
<member name="M:AgateLib.Drivers.IUserSetSystems.AddInputType(AgateLib.Drivers.AgateDriverInfo)">
<summary>
Adds a Input driver to the possible options.
</summary>
<param name="info"></param>
</member>
<member name="M:AgateLib.Drivers.IUserSetSystems.RunDialog">
<summary>
Shows the dialog asking the user what drivers to use.
</summary>
<returns></returns>
</member>
<member name="M:AgateLib.Drivers.IUserSetSystems.SetChoices(System.Boolean,System.Boolean,System.Boolean)">
<summary>
Sets which choices the user is presented with.
</summary>
<param name="chooseDisplay"></param>
<param name="chooseAudio"></param>
<param name="chooseInput"></param>
</member>
<member name="P:AgateLib.Drivers.IUserSetSystems.DisplayType">
<summary>
gets the selected Display driver
</summary>
</member>
<member name="P:AgateLib.Drivers.IUserSetSystems.AudioType">
<summary>
Gets the selected Audio driver
</summary>
</member>
<member name="P:AgateLib.Drivers.IUserSetSystems.InputType">
<summary>
Gets the selected Input driver
</summary>
</member>
<member name="T:AgateLib.DisplayLib.PixelFormat">
<summary>
Enum which describes different pixel formats.
Order of the characters in the constant name specifies the
ordering of the bytes for the pixel data, from least to most significant.
See remarks for more information.
</summary>
<remarks>
Order of the characters in the constant name specifies the
ordering of the bytes for the pixel data, from least to most significant on
a little-endian architecture. In other words, the first character indicates
the meaning of the first byte or bits in memory.
For example, ARGB8888 indicates that the alpha channel is the least significant,
the blue channel is most significant, and each channel is eight bits long.
The alpha channel is stored first in memory, followed by red, green and blue.
</remarks>
</member>
<member name="F:AgateLib.DisplayLib.PixelFormat.Any">
<summary>
Format specifying the Agate should choose what pixel format
to use, where appropriate.
</summary>
</member>
<member name="F:AgateLib.DisplayLib.PixelFormat.ARGB8888">
<summary>
</summary>
</member>
<member name="F:AgateLib.DisplayLib.PixelFormat.ABGR8888">
<summary>
</summary>
</member>
<member name="F:AgateLib.DisplayLib.PixelFormat.BGRA8888">
<summary>
</summary>
</member>
<member name="F:AgateLib.DisplayLib.PixelFormat.RGBA8888">
<summary>
</summary>
</member>
<member name="F:AgateLib.DisplayLib.PixelFormat.XRGB8888">
<summary>
</summary>
</member>
<member name="F:AgateLib.DisplayLib.PixelFormat.XBGR8888">
<summary>
</summary>
</member>
<member name="F:AgateLib.DisplayLib.PixelFormat.RGB888">
<summary>
</summary>
</member>
<member name="F:AgateLib.DisplayLib.PixelFormat.BGR888">
<summary>
</summary>
</member>
<member name="F:AgateLib.DisplayLib.PixelFormat.RGB565">
<summary>
</summary>
</member>
<member name="F:AgateLib.DisplayLib.PixelFormat.XRGB1555">
<summary>
</summary>
</member>
<member name="F:AgateLib.DisplayLib.PixelFormat.XBGR1555">
<summary>
</summary>
</member>
<member name="F:AgateLib.DisplayLib.PixelFormat.BGR565">
<summary>
</summary>
</member>
<member name="T:AgateLib.DisplayLib.IRenderTarget">
<summary>
Defines the interface used for render targets.
Implemented by DisplayWindow and Surface
</summary>
</member>
<member name="P:AgateLib.DisplayLib.IRenderTarget.Impl">
<summary>
Gets the library implementation of the render target.
</summary>
</member>
<member name="P:AgateLib.DisplayLib.IRenderTarget.Width">
<summary>
Gets the width of the render target in pixels.
</summary>
</member>
<member name="P:AgateLib.DisplayLib.IRenderTarget.Height">
<summary>
Gets the height of the render target in pixels.
</summary>
</member>
<member name="P:AgateLib.DisplayLib.IRenderTarget.Size">
<summary>
Gets the size of the render target in pixels.
</summary>
</member>
<member name="E:AgateLib.DisplayLib.IRenderTarget.Resize">
<summary>
Event that is fired when the render target is resized.
</summary>
</member>
<member name="T:AgateLib.DisplayLib.DisplayWindow">
<summary>
A class representing a screen region which is used as a RenderTarget.
</summary>
<remarks>
Creating a DisplayWindow can be done in two ways. By specifying
a title and width and height, the DisplayWindow will create and manage
a window.
Alternatively, a control may be specified to render into.
</remarks>
</member>
<member name="M:AgateLib.DisplayLib.DisplayWindow.#ctor(AgateLib.Resources.AgateResourceCollection,System.String)">
<summary>
Constructs a DisplayWindow from a resource.
</summary>
<param name="resources"></param>
<param name="name"></param>
</member>
<member name="M:AgateLib.DisplayLib.DisplayWindow.#ctor(AgateLib.DisplayLib.CreateWindowParams)">
<summary>
Creates a DisplayWindow object using the specified CreateWindowParams to create
the window.
</summary>
<param name="windowParams"></param>
</member>
<member name="M:AgateLib.DisplayLib.DisplayWindow.CreateFromControl(System.Object)">
<summary>
Creates a DisplayWindow object using the specified System.Windows.Forms.Control
object as a render context. A DisplayWindow made in this manner cannot be made
into a full-screen DisplayWindow.
</summary>
<remarks>Calling this function is equivalent to calling
new DisplayWindow(CreateWindowParams.FromControl(control)).</remarks>
<param name="control">Windows.Forms control which should be used as the
render target.</param>
</member>
<member name="M:AgateLib.DisplayLib.DisplayWindow.CreateFullScreen(System.String,System.Int32,System.Int32)">
<summary>
Creates a DisplayWindow object which renders to the entire screen, setting
the resolution to the value specified.
</summary>
<param name="title"></param>
<param name="width"></param>
<param name="height"></param>
<returns></returns>
</member>
<member name="M:AgateLib.DisplayLib.DisplayWindow.CreateWindowed(System.String,System.Int32,System.Int32)">
<summary>
Creates a DisplayWindow object which generates a desktop window to render into.
This overload creates a window which has the default icon and is not resizeable.
</summary>
<param name="title"></param>
<param name="width"></param>
<param name="height"></param>
<returns></returns>
</member>
<member name="M:AgateLib.DisplayLib.DisplayWindow.CreateWindowed(System.String,System.Int32,System.Int32,System.Boolean)">
<summary>
Creates a DisplayWindow object which generates a desktop window to render into.
This overload creates a window which has the default icon and is not resizeable.
</summary>
<param name="title"></param>
<param name="width"></param>
<param name="height"></param>
<param name="allowResize"></param>
<returns></returns>
</member>
<member name="M:AgateLib.DisplayLib.DisplayWindow.CreateWindowed(System.String,System.Int32,System.Int32,System.Boolean,System.String)">
<summary>
Creates a DisplayWindow object which generates a desktop window to render into.
</summary>
<param name="title"></param>
<param name="width"></param>
<param name="height"></param>
<param name="iconFile"></param>
<param name="allowResize"></param>
<returns></returns>
</member>
<member name="M:AgateLib.DisplayLib.DisplayWindow.CreateNoFrame(System.String,System.Int32,System.Int32)">
<summary>
Creates a DisplayWindow object which is a desktop window with no frame or
titlebar.
</summary>
<param name="title"></param>
<param name="width"></param>
<param name="height"></param>
<returns></returns>
</member>
<member name="M:AgateLib.DisplayLib.DisplayWindow.Dispose">
<summary>
Disposes of unmanaged resources.
</summary>
</member>
<member name="M:AgateLib.DisplayLib.DisplayWindow.SetWindowed">
<summary>
Sets the display to windowed. Does nothing if the display is already
windowed. The DisplayWindow retains the same height and width as the
previous full screen resolution.
</summary>
</member>
<member name="M:AgateLib.DisplayLib.DisplayWindow.SetFullScreen">
<summary>
Sets the display to a full screen Display. This overload uses the
desktop resolution for the full-screen Display.
</summary>
<remarks>
This call is not guaranteed to work; some drivers (eg. GDI) don't support
fullscreen displays. If this fails it returns without any error
thrown. Check to see if it worked by examining IsFullScreen property.
</remarks>
</member>
<member name="M:AgateLib.DisplayLib.DisplayWindow.SetFullScreen(System.Int32,System.Int32,System.Int32)">
<summary>
Sets the display to a full screen Display. The resolution chosen is
driver/video card/monitor dependent, but it should be fairly close to
values specified.
</summary>
<remarks>
This call is not guaranteed to work; some drivers (eg. GDI) don't support
fullscreen displays. If this fails it returns without any error
thrown. Check to see if it worked by examining IsFullScreen property.
</remarks>
<param name="width"></param>
<param name="height"></param>
<param name="bpp"></param>
</member>
<member name="P:AgateLib.DisplayLib.DisplayWindow.IsClosed">
<summary>
Returns true if this DisplayWindow has been closed, either
by a call to Dispose(), or perhaps the user clicked the close
box in a form.
</summary>
</member>
<member name="P:AgateLib.DisplayLib.DisplayWindow.Size">
<summary>
Gets or sets the size of the client area in pixels.
</summary>
</member>
<member name="P:AgateLib.DisplayLib.DisplayWindow.Width">
<summary>
Gets or sets the width of the client area in pixels.
</summary>
</member>
<member name="P:AgateLib.DisplayLib.DisplayWindow.Height">
<summary>
Gets or sets the height of the client area in pixels.
</summary>
</member>
<member name="P:AgateLib.DisplayLib.DisplayWindow.MousePosition">
<summary>
Gets or sets the position of the cursor, in the
client coordinates of the window.
</summary>
</member>
<member name="P:AgateLib.DisplayLib.DisplayWindow.Impl">
<summary>
Returns the DisplayWindowImpl object.
</summary>
</member>
<member name="P:AgateLib.DisplayLib.DisplayWindow.Title">
<summary>
Gets or sets the title of the window.
</summary>
</member>
<member name="P:AgateLib.DisplayLib.DisplayWindow.IsFullScreen">
<summary>
Returns true if this window is displayed fullscreen.
</summary>
</member>
<member name="E:AgateLib.DisplayLib.DisplayWindow.Resize">
<summary>
Event raised when the window is resized by the user.
</summary>
</member>
<member name="T:AgateLib.Timing">
<summary>
Static class which handles timing. This is often used
to update object positions and animations.
</summary>
</member>
<member name="M:AgateLib.Timing.Pause">
<summary>
Increments the pause counter.
If the counter is greater than zero, the timer won't advance.
</summary>
</member>
<member name="M:AgateLib.Timing.Resume">
<summary>
Decrements the pause counter.
If the pause counter is zero the timer will begin advancing.
</summary>
</member>
<member name="M:AgateLib.Timing.ForceResume">
<summary>
Sets the pause counter to zero, causing the timer to begin advancing
regardless of how many calls to Pause() are made.
</summary>
</member>
<member name="M:AgateLib.Timing.PauseAllTimers">
<summary>
Calls Pause() on all timers, and fires the PauseAllTimersEvent.
</summary>
</member>
<member name="M:AgateLib.Timing.ResumeAllTimers">
<summary>
Calls Resume() on all timers, and fires the ResumeAllTimersEvent.
</summary>
</member>
<member name="M:AgateLib.Timing.ForceResumeAllTimers">
<summary>
Calls ForceResume on all timers, and fires the ResumeAllTimersEvent.
You probably don't want to use this one much.
</summary>
</member>
<member name="P:AgateLib.Timing.TotalSeconds">
<summary>
Returns the number of seconds since the application started.
</summary>
</member>
<member name="P:AgateLib.Timing.TotalMilliseconds">
<summary>
Returns the number of milliseconds since the application started.
</summary>
</member>
<member name="T:AgateLib.Timing.StopWatch">
<summary>
Class which represents a StopWatch.
A StopWatch can be paused and reset independently of other
StopWatches.
</summary>
</member>
<member name="M:AgateLib.Timing.StopWatch.#ctor">
<summary>
Constructs a timer object, and immediately begins
keeping track of time.
</summary>
</member>
<member name="M:AgateLib.Timing.StopWatch.#ctor(System.Boolean)">
<summary>
Constructs a timer object.
If the timer starts paused, a call to Resume() must be made
for it to begin keeping track of time.
</summary>
<param name="autostart">Pass true to immediately begin keeping track of time.
False to pause the timer initially.</param>
</member>
<member name="M:AgateLib.Timing.StopWatch.Dispose">
<summary>
Destroys this timer.
</summary>