Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
wisp
GitHub Repository: wisp/impinj-reader-app
Path: blob/master/Resources/taoframework-2.1.0/bin/Tao.Platform.Windows.xml
178 views
1
<?xml version="1.0"?>
2
<doc>
3
<assembly>
4
<name>Tao.Platform.Windows</name>
5
</assembly>
6
<members>
7
<member name="T:Tao.Platform.Windows.WinNt">
8
<summary>
9
WinNT binding for .NET, implementing Windows NT-specific functionality.
10
</summary>
11
</member>
12
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_INTEL_386">
13
<summary>
14
Intel i386 processor.
15
</summary>
16
</member>
17
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_INTEL_486">
18
<summary>
19
Intel i486 processor.
20
</summary>
21
</member>
22
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_INTEL_PENTIUM">
23
<summary>
24
Intel Pentium processor.
25
</summary>
26
</member>
27
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_INTEL_IA64">
28
<summary>
29
Intel IA64 processor.
30
</summary>
31
</member>
32
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_AMD_X8664">
33
<summary>
34
AMD X86 64 processor.
35
</summary>
36
</member>
37
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_MIPS_R4000">
38
<summary>
39
MIPS R4000, R4101, R3910 processor.
40
</summary>
41
</member>
42
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_ALPHA_21064">
43
<summary>
44
Alpha 210 64 processor.
45
</summary>
46
</member>
47
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_PPC_601">
48
<summary>
49
PPC 601 processor.
50
</summary>
51
</member>
52
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_PPC_603">
53
<summary>
54
PPC 603 processor.
55
</summary>
56
</member>
57
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_PPC_604">
58
<summary>
59
PPC 604 processor.
60
</summary>
61
</member>
62
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_PPC_620">
63
<summary>
64
PPC 620 processor.
65
</summary>
66
</member>
67
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_HITACHI_SH3">
68
<summary>
69
Hitachi SH3 processor.
70
</summary>
71
</member>
72
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_HITACHI_SH3E">
73
<summary>
74
Hitachi SH3E processor.
75
</summary>
76
</member>
77
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_HITACHI_SH4">
78
<summary>
79
Hitachi SH4 processor.
80
</summary>
81
</member>
82
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_MOTOROLA_821">
83
<summary>
84
Motorola 821 processor.
85
</summary>
86
</member>
87
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_SHx_SH3">
88
<summary>
89
SHx SH3 processor.
90
</summary>
91
</member>
92
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_SHx_SH4">
93
<summary>
94
SHx SH4 processor.
95
</summary>
96
</member>
97
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_STRONGARM">
98
<summary>
99
StrongARM processor.
100
</summary>
101
</member>
102
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARM720">
103
<summary>
104
ARM 720 processor.
105
</summary>
106
</member>
107
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARM820">
108
<summary>
109
ARM 820 processor.
110
</summary>
111
</member>
112
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARM920">
113
<summary>
114
ARM 920 processor.
115
</summary>
116
</member>
117
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARM_7TDMI">
118
<summary>
119
ARM 7TDMI processor.
120
</summary>
121
</member>
122
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_OPTIL">
123
<summary>
124
MSIL processor.
125
</summary>
126
</member>
127
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_INTEL">
128
<summary>
129
Intel architecture.
130
</summary>
131
</member>
132
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_MIPS">
133
<summary>
134
MIPS architecture.
135
</summary>
136
</member>
137
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_ALPHA">
138
<summary>
139
Alpha architecture.
140
</summary>
141
</member>
142
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_PPC">
143
<summary>
144
PPC architecture.
145
</summary>
146
</member>
147
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_SHX">
148
<summary>
149
SHX architecture.
150
</summary>
151
</member>
152
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_ARM">
153
<summary>
154
ARM architecture.
155
</summary>
156
</member>
157
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_IA64">
158
<summary>
159
IA64 architecture.
160
</summary>
161
</member>
162
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_ALPHA64">
163
<summary>
164
Alpha64 architecture.
165
</summary>
166
</member>
167
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_MSIL">
168
<summary>
169
MSIL architecture.
170
</summary>
171
</member>
172
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_AMD64">
173
<summary>
174
AMD64 architecture.
175
</summary>
176
</member>
177
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_IA32_ON_WIN64">
178
<summary>
179
IA32 On Win64 architecture.
180
</summary>
181
</member>
182
<member name="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_UNKNOWN">
183
<summary>
184
Unknown architecture.
185
</summary>
186
</member>
187
<member name="F:Tao.Platform.Windows.WinNt.PF_FLOATING_POINT_PRECISION_ERRATA">
188
<summary>
189
In rare circumstances, on a Pentium, a floating-point precision error can occur.
190
</summary>
191
</member>
192
<member name="F:Tao.Platform.Windows.WinNt.PF_FLOATING_POINT_EMULATED">
193
<summary>
194
Floating-point operations are emulated using a software emulator.
195
</summary>
196
</member>
197
<member name="F:Tao.Platform.Windows.WinNt.PF_COMPARE_EXCHANGE_DOUBLE">
198
<summary>
199
The compare and exchange double operation is available (Pentium, MIPS, and Alpha).
200
</summary>
201
</member>
202
<member name="F:Tao.Platform.Windows.WinNt.PF_MMX_INSTRUCTIONS_AVAILABLE">
203
<summary>
204
The MMX instruction set is available.
205
</summary>
206
</member>
207
<member name="F:Tao.Platform.Windows.WinNt.PF_PPC_MOVEMEM_64BIT_OK">
208
<summary>
209
Unknown.
210
</summary>
211
</member>
212
<member name="F:Tao.Platform.Windows.WinNt.PF_ALPHA_BYTE_INSTRUCTIONS">
213
<summary>
214
Unknown.
215
</summary>
216
</member>
217
<member name="F:Tao.Platform.Windows.WinNt.PF_XMMI_INSTRUCTIONS_AVAILABLE">
218
<summary>
219
The SSE instruction set is available.
220
</summary>
221
</member>
222
<member name="F:Tao.Platform.Windows.WinNt.PF_3DNOW_INSTRUCTIONS_AVAILABLE">
223
<summary>
224
The 3D-Now instruction set is available.
225
</summary>
226
</member>
227
<member name="F:Tao.Platform.Windows.WinNt.PF_RDTSC_INSTRUCTION_AVAILABLE">
228
<summary>
229
The RDTSC instruction is available.
230
</summary>
231
</member>
232
<member name="F:Tao.Platform.Windows.WinNt.PF_PAE_ENABLED">
233
<summary>
234
The processor is PAE-enabled.
235
</summary>
236
</member>
237
<member name="F:Tao.Platform.Windows.WinNt.PF_XMMI64_INSTRUCTIONS_AVAILABLE">
238
<summary>
239
The SSE2 instruction set is available.
240
</summary>
241
</member>
242
<member name="T:Tao.Platform.Windows.Kernel">
243
<summary>
244
Kernel binding for .NET, implementing Windows-specific kernel functionality.
245
</summary>
246
<remarks>
247
Binds functions and definitions in kernel32.dll.
248
</remarks>
249
</member>
250
<member name="F:Tao.Platform.Windows.Kernel.KERNEL_NATIVE_LIBRARY">
251
<summary>
252
Specifies Kernel32's native library archive.
253
</summary>
254
<remarks>
255
Specifies kernel32.dll for Windows.
256
</remarks>
257
</member>
258
<member name="F:Tao.Platform.Windows.Kernel.CALLING_CONVENTION">
259
<summary>
260
Specifies the calling convention.
261
</summary>
262
<remarks>
263
Specifies <see cref="F:System.Runtime.InteropServices.CallingConvention.StdCall"/>.
264
</remarks>
265
</member>
266
<member name="M:Tao.Platform.Windows.Kernel.Beep(System.Int32,System.Int32)">
267
<summary>
268
The <b>Beep</b> function generates simple tones on the speaker. The function is
269
synchronous; it does not return control to its caller until the sound finishes.
270
</summary>
271
<param name="frequency">
272
<para>
273
Frequency of the sound, in hertz. This parameter must be in the range
274
37 through 32,767 (0x25 through 0x7FFF).
275
</para>
276
<para>
277
<b>Windows 95/98/Me:</b> The <b>Beep</b> function ignores this parameter.
278
</para>
279
</param>
280
<param name="duration">
281
<para>
282
Duration of the sound, in milliseconds.
283
</para>
284
<para>
285
<b>Windows 95/98/Me:</b> The <b>Beep</b> function ignores this parameter.
286
</para>
287
</param>
288
<returns>
289
<para>
290
If the function succeeds, the return value is true.
291
</para>
292
<para>
293
If the function fails, the return value is false. To get extended error
294
information, call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.
295
</para>
296
</returns>
297
<remarks>
298
<para>
299
<b>Terminal Services:</b> The beep is redirected to the client.
300
</para>
301
<para>
302
<b>Windows 95/98/Me:</b> On computers with a sound card, the function
303
plays the default sound event. On computers without a sound card, the
304
function plays the standard system beep.
305
</para>
306
</remarks>
307
</member>
308
<member name="M:Tao.Platform.Windows.Kernel.FreeLibrary(System.IntPtr)">
309
<summary>
310
The <b>FreeLibrary</b> function decrements the reference count of the loaded
311
dynamic-link library (DLL). When the reference count reaches zero, the module
312
is unmapped from the address space of the calling process and the handle is no
313
longer valid.
314
</summary>
315
<param name="moduleHandle">
316
Handle to the loaded DLL module. The <see cref="M:Tao.Platform.Windows.Kernel.LoadLibrary(System.String)"/> or
317
<see cref="M:Tao.Platform.Windows.Kernel.GetModuleHandle(System.String)"/> function returns this handle.
318
</param>
319
<returns>
320
<para>
321
If the function succeeds, the return value is true.
322
</para>
323
<para>
324
If the function fails, the return value is false. To get extended error
325
information, call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.
326
</para>
327
</returns>
328
<remarks>
329
<para>
330
Each process maintains a reference count for each loaded library module. This
331
reference count is incremented each time <see cref="M:Tao.Platform.Windows.Kernel.LoadLibrary(System.String)"/> is called
332
and is decremented each time <b>FreeLibrary</b> is called. A DLL module
333
loaded at process initialization due to load-time dynamic linking has a
334
reference count of one. This count is incremented if the same module is
335
loaded by a call to <see cref="M:Tao.Platform.Windows.Kernel.LoadLibrary(System.String)"/>.
336
</para>
337
<para>
338
Before unmapping a library module, the system enables the DLL to detach from
339
the process by calling the DLL's <b>DllMain</b> function, if it has one, with
340
the DLL_PROCESS_DETACH value. Doing so gives the DLL an opportunity to clean
341
up resources allocated on behalf of the current process. After the
342
entry-point function returns, the library module is removed from the address
343
space of the current process.
344
</para>
345
<para>
346
It is not safe to call <b>FreeLibrary</b> from <b>DllMain</b>. For more
347
information, see the Remarks section in <b>DllMain</b>.
348
</para>
349
<para>
350
Calling <b>FreeLibrary</b> does not affect other processes using the same
351
library module.
352
</para>
353
</remarks>
354
<seealso cref="M:Tao.Platform.Windows.Kernel.GetModuleHandle(System.String)"/>
355
<seealso cref="M:Tao.Platform.Windows.Kernel.LoadLibrary(System.String)"/>
356
</member>
357
<member name="M:Tao.Platform.Windows.Kernel.GetDllDirectory(System.Int32,System.Text.StringBuilder)">
358
<summary>
359
The <b>GetDllDirectory</b> function retrieves the application-specific portion of
360
the search path used to locate DLLs for the application.
361
</summary>
362
<param name="bufferLength">
363
Size of the output buffer, in characters.
364
</param>
365
<param name="buffer">
366
Pointer to a buffer that receives the application-specific portion of the search path.
367
</param>
368
<returns>
369
<para>
370
If the function succeeds, the return value is the length of the string copied
371
to <i>buffer</i>, in characters, not including the terminating null character.
372
If the return value is greater than <i>bufferLength</i>, it specifies the size
373
of the buffer required for the path.
374
</para>
375
<para>
376
If the function fails, the return value is zero. To get extended error
377
information, call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.
378
</para>
379
</returns>
380
<seealso cref="M:Tao.Platform.Windows.Kernel.SetDllDirectory(System.String)"/>
381
</member>
382
<member name="M:Tao.Platform.Windows.Kernel.GetModuleFileName(System.IntPtr,System.Text.StringBuilder,System.Int32)">
383
<summary>
384
<para>
385
The <b>GetModuleFileName</b> function retrieves the fully qualified path for
386
the specified module.
387
</para>
388
<para>
389
To specify the process that contains the module, use the
390
<b>GetModuleFileNameEx</b> function.
391
</para>
392
</summary>
393
<param name="module">
394
Handle to the module whose path is being requested. If this parameter is NULL,
395
<b>GetModuleFileName</b> retrieves the path for the current module.
396
</param>
397
<param name="fileName">
398
<para>
399
Pointer to a buffer that receives a null-terminated string that specifies the
400
fully-qualified path of the module. If the length of the path exceeds the
401
size specified by the <i>size</i> parameter, the function succeeds and the
402
string is truncated to <i>size</i> characters and null terminated.
403
</para>
404
<para>
405
The path can have the prefix "\\?\", depending on how the module was loaded.
406
</para>
407
</param>
408
<param name="size">
409
Size of the <i>filename</i> buffer, in TCHARs.
410
</param>
411
<returns>
412
<para>
413
If the function succeeds, the return value is the length of the string copied
414
to the buffer, in TCHARs. If the buffer is too small to hold the module name,
415
the string is truncated to <i>size</i>, and the function returns <i>size</i>.
416
</para>
417
<para>
418
If the function fails, the return value is zero. To get extended error
419
information, call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.
420
</para>
421
</returns>
422
<remarks>
423
<para>
424
If a DLL is loaded in two processes, its file name in one process may differ
425
in case from its file name in the other process.
426
</para>
427
<para>
428
For the ANSI version of the function, the number of TCHARs is the number of
429
bytes; for the Unicode version, it is the number of characters.
430
</para>
431
<para>
432
<b>Windows Me/98/95:</b> This function retrieves long file names when an
433
application's version number is greater than or equal to 4.00 and the long
434
file name is available. Otherwise, it returns only 8.3 format file names.
435
</para>
436
</remarks>
437
<seealso cref="M:Tao.Platform.Windows.Kernel.GetModuleHandle(System.String)"/>
438
<seealso cref="M:Tao.Platform.Windows.Kernel.LoadLibrary(System.String)"/>
439
</member>
440
<member name="M:Tao.Platform.Windows.Kernel.GetModuleHandle(System.String)">
441
<summary>
442
<para>
443
The <b>GetModuleHandle</b> function retrieves a module handle for the
444
specified module if the file has been mapped into the address space of the
445
calling process.
446
</para>
447
<para>
448
To avoid the race conditions described in the Remarks section, use the
449
<b>GetModuleHandleEx</b> function.
450
</para>
451
</summary>
452
<param name="moduleName">
453
<para>
454
Pointer to a null-terminated string that contains the name of the module
455
(either a .dll or .exe file). If the file name extension is omitted, the
456
default library extension .dll is appended. The file name string can include
457
a trailing point character (.) to indicate that the module name has no
458
extension. The string does not have to specify a path. When specifying a
459
path, be sure to use backslashes (\), not forward slashes (/). The name is
460
compared (case independently) to the names of modules currently mapped into
461
the address space of the calling process.
462
</para>
463
<para>
464
If this parameter is NULL, <b>GetModuleHandle</b> returns a handle to the
465
file used to create the calling process.
466
</para>
467
</param>
468
<returns>
469
<para>
470
If the function succeeds, the return value is a handle to the specified module
471
(IntPtr).
472
</para>
473
<para>
474
If the function fails, the return value is NULL (IntPtr.Zero). To get
475
extended error information, call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.
476
</para>
477
</returns>
478
<remarks>
479
<para>
480
The returned handle is not global or inheritable. It cannot be duplicated
481
or used by another process.
482
</para>
483
<para>
484
The <b>GetModuleHandle</b> function returns a handle to a mapped module
485
without incrementing its reference count. Therefore, use care when passing
486
the handle to the <see cref="M:Tao.Platform.Windows.Kernel.FreeLibrary(System.IntPtr)"/> function, because doing so can
487
cause a DLL module to be unmapped prematurely.
488
</para>
489
<para>
490
This function must be used carefully in a multithreaded application. There
491
is no guarantee that the module handle remains valid between the time this
492
function returns the handle and the time it is used. For example, a thread
493
retrieves a module handle, but before it uses the handle, a second thread
494
frees the module. If the system loads another module, it could reuse the
495
module handle that was recently freed. Therefore, first thread would have
496
a handle to a module different than the one intended.
497
</para>
498
</remarks>
499
<seealso cref="M:Tao.Platform.Windows.Kernel.FreeLibrary(System.IntPtr)"/>
500
<seealso cref="M:Tao.Platform.Windows.Kernel.GetModuleFileName(System.IntPtr,System.Text.StringBuilder,System.Int32)"/>
501
</member>
502
<member name="M:Tao.Platform.Windows.Kernel.GetProcAddress(System.IntPtr,System.String)">
503
<summary>
504
The <b>GetProcAddress</b> function retrieves the address of an exported function
505
or variable from the specified dynamic-link library (DLL).
506
</summary>
507
<param name="module">
508
Handle to the DLL module that contains the function or variable. The
509
<see cref="M:Tao.Platform.Windows.Kernel.LoadLibrary(System.String)"/> or <see cref="M:Tao.Platform.Windows.Kernel.GetModuleHandle(System.String)"/> function returns
510
this handle.
511
</param>
512
<param name="processName">
513
Pointer to a null-terminated string that specifies the function or variable name,
514
or the function's ordinal value. If this parameter is an ordinal value, it must
515
be in the low-order word; the high-order word must be zero.
516
</param>
517
<returns>
518
<para>
519
If the function succeeds, the return value is the address of the exported
520
function or variable.
521
</para>
522
<para>
523
If the function fails, the return value is NULL (IntPtr.Zero). To get
524
extended error information, call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.
525
</para>
526
</returns>
527
<remarks>
528
<para>
529
The spelling and case of a function name pointed to by <i>processName</i> must
530
be identical to that in the EXPORTS statement of the source DLL's
531
module-definition (.def) file. The exported names of functions may differ
532
from the names you use when calling these functions in your code. This
533
difference is hidden by macros used in the SDK header files.
534
</para>
535
<para>
536
The <i>processName</i> parameter can identify the DLL function by specifying
537
an ordinal value associated with the function in the EXPORTS statement.
538
<b>GetProcAddress</b> verifies that the specified ordinal is in the range 1
539
through the highest ordinal value exported in the .def file. The function
540
then uses the ordinal as an index to read the function's address from a
541
function table. If the .def file does not number the functions consecutively
542
from 1 to N (where N is the number of exported functions), an error can occur
543
where <b>GetProcAddress</b> returns an invalid, non-NULL address, even though
544
there is no function with the specified ordinal.
545
</para>
546
<para>
547
In cases where the function may not exist, the function should be specified by
548
name rather than by ordinal value.
549
</para>
550
</remarks>
551
<seealso cref="M:Tao.Platform.Windows.Kernel.FreeLibrary(System.IntPtr)"/>
552
<seealso cref="M:Tao.Platform.Windows.Kernel.GetModuleHandle(System.String)"/>
553
<seealso cref="M:Tao.Platform.Windows.Kernel.LoadLibrary(System.String)"/>
554
</member>
555
<member name="M:Tao.Platform.Windows.Kernel.GetProcessWorkingSetSize(System.IntPtr,System.Int32@,System.Int32@)">
556
<summary>
557
The <b>GetProcessWorkingSetSize</b> function retrieves the minimum and maximum
558
working set sizes of the specified process.
559
</summary>
560
<param name="process">
561
Handle to the process whose working set sizes will be obtained. The handle must
562
have the PROCESS_QUERY_INFORMATION access right.
563
</param>
564
<param name="minimumWorkingSetSize">
565
Pointer to a variable that receives the minimum working set size of the specified
566
process, in bytes. The virtual memory manager attempts to keep at least this much
567
memory resident in the process whenever the process is active.
568
</param>
569
<param name="maximumWorkingSetSize">
570
Pointer to a variable that receives the maximum working set size of the specified
571
process, in bytes. The virtual memory manager attempts to keep no more than this
572
much memory resident in the process whenever the process is active when memory is
573
in short supply.
574
</param>
575
<returns>
576
<para>
577
If the function succeeds, the return value is true.
578
</para>
579
<para>
580
If the function fails, the return value is false. To get extended error
581
information, call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.
582
</para>
583
</returns>
584
<remarks>
585
The "working set" of a process is the set of memory pages currently visible to
586
the process in physical RAM memory. These pages are resident and available for
587
an application to use without triggering a page fault. The minimum and maximum
588
working set sizes affect the virtual memory paging behavior of a process.
589
</remarks>
590
<seealso cref="M:Tao.Platform.Windows.Kernel.SetProcessWorkingSetSize(System.IntPtr,System.Int32,System.Int32)"/>
591
</member>
592
<member name="M:Tao.Platform.Windows.Kernel.GetSystemDirectory(System.Text.StringBuilder,System.Int32)">
593
<summary>
594
<para>
595
The <b>GetSystemDirectory</b> function retrieves the path of the system
596
directory. The system directory contains system such files such as
597
dynamic-link libraries, drivers, and font files.
598
</para>
599
<para>
600
This function is provided primarily for compatibility. Applications should
601
store code in the Program Files folder and persistent data in the Application
602
Data folder in the user's profile.
603
</para>
604
</summary>
605
<param name="buffer">
606
Pointer to the buffer to receive the null-terminated string containing the path.
607
This path does not end with a backslash unless the system directory is the root
608
directory. For example, if the system directory is named Windows\System on drive
609
C, the path of the system directory retrieved by this function is
610
C:\Windows\System.
611
</param>
612
<param name="size">
613
Maximum size of the buffer, in TCHARs. This value should be set to at least
614
MAX_PATH+1 to allow sufficient space for the path and the null terminator.
615
</param>
616
<returns>
617
<para>
618
If the function succeeds, the return value is the length, in TCHARs, of the
619
string copied to the buffer, not including the terminating null character. If
620
the length is greater than the size of the buffer, the return value is the
621
size of the buffer required to hold the path.
622
</para>
623
<para>
624
If the function fails, the return value is zero. To get extended error
625
information, call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.
626
</para>
627
</returns>
628
<remarks>
629
Applications should not create files in the system directory. If the user is
630
running a shared version of the operating system, the application does not have
631
write access to the system directory.
632
</remarks>
633
<seealso cref="M:Tao.Platform.Windows.Kernel.GetWindowsDirectory(System.Text.StringBuilder,System.Int32)"/>
634
</member>
635
<member name="M:Tao.Platform.Windows.Kernel.GetSystemInfo(Tao.Platform.Windows.Kernel.SYSTEM_INFO@)">
636
<summary>
637
<para>
638
The <b>GetSystemInfo</b> function returns information about the current
639
system.
640
</para>
641
<para>
642
To retrieve accurate information for a Win32-based application running on
643
WOW64, call the <b>GetNativeSystemInfo</b> function.
644
</para>
645
</summary>
646
<param name="systemInfo">
647
Pointer to a <see cref="T:Tao.Platform.Windows.Kernel.SYSTEM_INFO"/> structure that receives the information.
648
</param>
649
<seealso cref="T:Tao.Platform.Windows.Kernel.SYSTEM_INFO"/>
650
</member>
651
<member name="M:Tao.Platform.Windows.Kernel.GetSystemWindowsDirectory(System.Text.StringBuilder,System.Int32)">
652
<summary>
653
The <b>GetSystemWindowsDirectory</b> function retrieves the path of the shared
654
Windows directory on a multi-user system.
655
</summary>
656
<param name="buffer">
657
Pointer to the buffer to receive a null-terminated string containing the path.
658
This path does not end with a backslash unless the Windows directory is the root
659
directory. For example, if the Windows directory is named Windows on drive C,
660
the path of the Windows directory retrieved by this function is C:\Windows. If
661
the system was installed in the root directory of drive C, the path retrieved
662
is C:\.
663
</param>
664
<param name="size">
665
Maximum size of the buffer specified by the <i>buffer</i> parameter, in TCHARs.
666
This value should be set to at least MAX_PATH+1 to allow sufficient space for the
667
path and the null-terminating character.
668
</param>
669
<returns>
670
<para>
671
If the function succeeds, the return value is the length of the string copied
672
to the buffer, in TCHARs, not including the terminating null character.
673
</para>
674
<para>
675
If the length is greater than the size of the buffer, the return value is the
676
size of the buffer required to hold the path.
677
</para>
678
<para>
679
If the function fails, the return value is zero. To get extended error
680
information, call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.
681
</para>
682
</returns>
683
<remarks>
684
<para>
685
On a system that is running Terminal Server, each user has a unique Windows
686
directory. The system Windows directory is shared by all users, so it is the
687
directory where an application should store initialization and help files that
688
apply to all users.
689
</para>
690
<para>
691
With Terminal Services, the <b>GetSystemWindowsDirectory</b> function
692
retrieves the path of the system Windows directory, while the
693
<see cref="M:Tao.Platform.Windows.Kernel.GetWindowsDirectory(System.Text.StringBuilder,System.Int32)"/> function retrieves the path of a Windows
694
directory that is private for each user. On a single-user system,
695
<b>GetSystemWindowsDirectory</b> is the same as
696
<see cref="M:Tao.Platform.Windows.Kernel.GetWindowsDirectory(System.Text.StringBuilder,System.Int32)"/>.
697
</para>
698
<para>
699
<b>Windows NT 4.0 Terminal Server Edition:</b> To retrieve the shared
700
Windows directory, call <see cref="M:Tao.Platform.Windows.Kernel.GetSystemDirectory(System.Text.StringBuilder,System.Int32)"/> and trim the
701
"System32" element from the end of the returned path.
702
</para>
703
</remarks>
704
<seealso cref="M:Tao.Platform.Windows.Kernel.GetWindowsDirectory(System.Text.StringBuilder,System.Int32)"/>
705
</member>
706
<member name="M:Tao.Platform.Windows.Kernel.GetTickCount">
707
<summary>
708
The <b>GetTickCount</b> function retrieves the number of milliseconds that have
709
elapsed since the system was started. It is limited to the resolution of the
710
system timer. To obtain the system timer resolution, use the
711
<b>GetSystemTimeAdjustment</b> function.
712
</summary>
713
<returns>
714
The return value is the number of milliseconds that have elapsed since the system
715
was started.
716
</returns>
717
<remarks>
718
<para>
719
The elapsed time is stored as a DWORD value. Therefore, the time will wrap
720
around to zero if the system is run continuously for 49.7 days.
721
</para>
722
<para>
723
If you need a higher resolution timer, use a multimedia timer or a
724
high-resolution timer.
725
</para>
726
<para>
727
To obtain the time elapsed since the computer was started, retrieve the System
728
Up Time counter in the performance data in the registry key
729
HKEY_PERFORMANCE_DATA. The value returned is an 8-byte value.
730
</para>
731
</remarks>
732
</member>
733
<member name="M:Tao.Platform.Windows.Kernel.GetWindowsDirectory(System.Text.StringBuilder,System.Int32)">
734
<summary>
735
<para>
736
The <b>GetWindowsDirectory</b> function retrieves the path of the Windows
737
directory. The Windows directory contains such files as applications,
738
initialization files, and help files.
739
</para>
740
<para>
741
This function is provided primarily for compatibility. Applications should
742
store code in the Program Files folder and persistent data in the Application
743
Data folder in the user's profile.
744
</para>
745
</summary>
746
<param name="buffer">
747
Pointer to the buffer to receive the null-terminated string containing the path.
748
This path does not end with a backslash unless the Windows directory is the root
749
directory. For example, if the Windows directory is named Windows on drive C, the
750
path of the Windows directory retrieved by this function is C:\Windows. If the
751
system was installed in the root directory of drive C, the path retrieved is C:\.
752
</param>
753
<param name="size">
754
Maximum size of the buffer specified by the <i>buffer</i> parameter, in TCHARs.
755
This value should be set to MAX_PATH.
756
</param>
757
<returns>
758
<para>
759
If the function succeeds, the return value is the length of the string copied
760
to the buffer, in TCHARs, not including the terminating null character.
761
</para>
762
<para>
763
If the length is greater than the size of the buffer, the return value is the
764
size of the buffer required to hold the path.
765
</para>
766
<para>
767
If the function fails, the return value is zero. To get extended error
768
information, call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.
769
</para>
770
</returns>
771
<remarks>
772
<para>
773
The Windows directory is the directory where an application should store
774
initialization and help files. If the user is running a shared version of the
775
system, the Windows directory is guaranteed to be private for each user.
776
</para>
777
<para>
778
If an application creates other files that it wants to store on a per-user
779
basis, it should place them in the directory specified by the HOMEPATH
780
environment variable. This directory will be different for each user, if so
781
specified by an administrator, through the User Manager administrative tool.
782
HOMEPATH always specifies either the user's home directory, which is
783
guaranteed to be private for each user, or a default directory (for example,
784
C:\USERS\DEFAULT) where the user will have all access.
785
</para>
786
<para>
787
<b>Terminal Services:</b> If the application is running in a Terminal
788
Services environment, each user has a unique Windows directory. If an
789
application that is not Terminal-Services-aware calls this function, it
790
retrieves the path of the Windows directory on the client, not the Windows
791
directory on the server.
792
</para>
793
</remarks>
794
<seealso cref="M:Tao.Platform.Windows.Kernel.GetSystemDirectory(System.Text.StringBuilder,System.Int32)"/>
795
<seealso cref="M:Tao.Platform.Windows.Kernel.GetSystemWindowsDirectory(System.Text.StringBuilder,System.Int32)"/>
796
</member>
797
<member name="M:Tao.Platform.Windows.Kernel.GlobalMemoryStatus(Tao.Platform.Windows.Kernel.MEMORYSTATUS@)">
798
<summary>
799
<para>
800
The <b>GlobalMemoryStatus</b> function obtains information about the system's
801
current usage of both physical and virtual memory.
802
</para>
803
<para>
804
To obtain information about the extended portion of the virtual address space,
805
or if your application may run on computers with more than 4 GB of main
806
memory, use the <b>GlobalMemoryStatusEx</b> function.
807
</para>
808
</summary>
809
<param name="buffer">
810
Pointer to a <see cref="T:Tao.Platform.Windows.Kernel.MEMORYSTATUS"/> structure. The <b>GlobalMemoryStatus</b>
811
function stores information about current memory availability into this structure.
812
</param>
813
<remarks>
814
<para>
815
You can use the <b>GlobalMemoryStatus</b> function to determine how much
816
memory your application can allocate without severely impacting other
817
applications.
818
</para>
819
<para>
820
The information returned by the <b>GlobalMemoryStatus</b> function is
821
volatile. There is no guarantee that two sequential calls to this function
822
will return the same information.
823
</para>
824
<para>
825
On computers with more than 4 GB of memory, the <b>GlobalMemoryStatus</b>
826
function can return incorrect information. Windows 2000 and later report a
827
value of -1 to indicate an overflow. Earlier versions of Windows NT report a
828
value that is the real amount of memory, modulo 4 GB. For this reason, use
829
the <b>GlobalMemoryStatusEx</b> function instead.
830
</para>
831
<para>
832
On Intel x86 computers with more than 2 GB and less than 4 GB of memory, the
833
<b>GlobalMemoryStatus</b> function will always return 2 GB in the
834
<see cref="F:Tao.Platform.Windows.Kernel.MEMORYSTATUS.TotalPhys"/> member of the
835
<see cref="T:Tao.Platform.Windows.Kernel.MEMORYSTATUS"/> structure. Similarly, if the total available
836
memory is between 2 and 4 GB, the <see cref="F:Tao.Platform.Windows.Kernel.MEMORYSTATUS.AvailPhys"/> member
837
of the <see cref="T:Tao.Platform.Windows.Kernel.MEMORYSTATUS"/> structure will be rounded down to 2 GB. If
838
the executable is linked using the /LARGEADDRESSWARE linker option, then the
839
<b>GlobalMemoryStatus</b> function will return the correct amount of physical
840
memory in both members.
841
</para>
842
</remarks>
843
<seealso cref="T:Tao.Platform.Windows.Kernel.MEMORYSTATUS"/>
844
</member>
845
<member name="M:Tao.Platform.Windows.Kernel.IsProcessorFeaturePresent(System.Int32)">
846
<summary>
847
The <b>IsProcessorFeaturePresent</b> function determines whether the specified
848
processor feature is supported by the current computer.
849
</summary>
850
<param name="processorFeature">
851
<para>
852
Processor feature to be tested. This parameter can be one of the following
853
values:
854
</para>
855
<para>
856
<list type="table">
857
<listheader>
858
<term>Value</term>
859
<description>Description</description>
860
</listheader>
861
<item>
862
<term><see cref="F:Tao.Platform.Windows.WinNt.PF_3DNOW_INSTRUCTIONS_AVAILABLE"/></term>
863
<description>
864
The 3D-Now instruction set is available.
865
</description>
866
</item>
867
<item>
868
<term><see cref="F:Tao.Platform.Windows.WinNt.PF_COMPARE_EXCHANGE_DOUBLE"/></term>
869
<description>
870
The compare and exchange double operation is available (Pentium,
871
MIPS, and Alpha).
872
</description>
873
</item>
874
<item>
875
<term><see cref="F:Tao.Platform.Windows.WinNt.PF_FLOATING_POINT_EMULATED"/></term>
876
<description>
877
<para>
878
Floating-point operations are emulated using a software
879
emulator.
880
</para>
881
<para>
882
This function returns true if floating-point operations are
883
emulated; otherwise, it returns false.
884
</para>
885
<para>
886
<b>Windows NT 4.0:</b> This function returns false if
887
floating-point operations are emulated; otherwise, it returns
888
true. This behavior is a bug that is fixed in later versions.
889
</para>
890
</description>
891
</item>
892
<item>
893
<term><see cref="F:Tao.Platform.Windows.WinNt.PF_FLOATING_POINT_PRECISION_ERRATA"/></term>
894
<description>
895
<b>Pentium:</b> In rare circumstances, a floating-point precision
896
error can occur.
897
</description>
898
</item>
899
<item>
900
<term><see cref="F:Tao.Platform.Windows.WinNt.PF_MMX_INSTRUCTIONS_AVAILABLE"/></term>
901
<description>
902
The MMX instruction set is available.
903
</description>
904
</item>
905
<item>
906
<term><see cref="F:Tao.Platform.Windows.WinNt.PF_PAE_ENABLED"/></term>
907
<description>
908
The processor is PAE-enabled.
909
</description>
910
</item>
911
<item>
912
<term><see cref="F:Tao.Platform.Windows.WinNt.PF_RDTSC_INSTRUCTION_AVAILABLE"/></term>
913
<description>
914
The RDTSC instruction is available.
915
</description>
916
</item>
917
<item>
918
<term><see cref="F:Tao.Platform.Windows.WinNt.PF_XMMI_INSTRUCTIONS_AVAILABLE"/></term>
919
<description>
920
The SSE instruction set is available.
921
</description>
922
</item>
923
<item>
924
<term><see cref="F:Tao.Platform.Windows.WinNt.PF_XMMI64_INSTRUCTIONS_AVAILABLE"/></term>
925
<description>
926
The SSE2 instruction set is available.
927
</description>
928
</item>
929
</list>
930
</para>
931
</param>
932
<returns>
933
<para>
934
If the feature is supported, the return value is true.
935
</para>
936
<para>
937
If the feature is not supported, the return value is false.
938
</para>
939
</returns>
940
</member>
941
<member name="M:Tao.Platform.Windows.Kernel.LoadLibrary(System.String)">
942
<summary>
943
The <b>LoadLibrary</b> function maps the specified executable module into the
944
address space of the calling process.
945
</summary>
946
<param name="fileName">
947
<para>
948
Pointer to a null-terminated string that names the executable module (either
949
a .dll or .exe file). The name specified is the file name of the module and
950
is not related to the name stored in the library module itself, as specified
951
by the LIBRARY keyword in the module-definition (.def) file.
952
</para>
953
<para>
954
If the string specifies a path but the file does not exist in the specified
955
directory, the function fails. When specifying a path, be sure to use
956
backslashes (\), not forward slashes (/).
957
</para>
958
<para>
959
If the string does not specify a path, the function uses a standard search
960
strategy to find the file. See the Remarks for more information.
961
</para>
962
</param>
963
<returns>
964
<para>
965
If the function succeeds, the return value is a handle to the module (IntPtr).
966
</para>
967
<para>
968
If the function fails, the return value is NULL (IntPtr.Zero). To get
969
extended error information, call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.
970
</para>
971
<para>
972
<b>Windows Me/98/95:</b> If you are using <b>LoadLibrary</b> to load a module
973
that contains a resource whose numeric identifier is greater than 0x7FFF,
974
<b>LoadLibrary</b> fails. If you are attempting to load a 16-bit DLL directly
975
from 32-bit code, <b>LoadLibrary</b> fails. If you are attempting to load a
976
DLL whose subsystem version is greater than 4.0, <b>LoadLibrary</b> fails. If
977
your <b>DllMain</b> function tries to call the Unicode version of a function,
978
<b>LoadLibrary</b> fails.
979
</para>
980
</returns>
981
<remarks>
982
<para>
983
<b>LoadLibrary</b> can be used to map a DLL module and return a handle that
984
can be used in <see cref="M:Tao.Platform.Windows.Kernel.GetProcAddress(System.IntPtr,System.String)"/> to get the address of a DLL
985
function. <b>LoadLibrary</b> can also be used to map other executable
986
modules. For example, the function can specify an .exe file to get a
987
handle that can be used in <b>FindResource</b> or <b>LoadResource</b>.
988
However, do not use <b>LoadLibrary</b> to run an .exe file, use the
989
<b>CreateProcess</b> function.
990
</para>
991
<para>
992
If the module is a DLL not already mapped for the calling process, the system
993
calls the DLL's <b>DllMain</b> function with the DLL_PROCESS_ATTACH value. If
994
the DLL's entry-point function does not return TRUE, <b>LoadLibrary</b> fails
995
and returns NULL. (The system immediately calls your entry-point function
996
with DLL_PROCESS_DETACH and unloads the DLL.)
997
</para>
998
<para>
999
It is not safe to call <b>LoadLibrary</b> from <b>DllMain</b>. For more
1000
information, see the Remarks section in <b>DllMain</b>.
1001
</para>
1002
<para>
1003
Module handles are not global or inheritable. A call to <b>LoadLibrary</b> by
1004
one process does not produce a handle that another process can use — for
1005
example, in calling <see cref="M:Tao.Platform.Windows.Kernel.GetProcAddress(System.IntPtr,System.String)"/>. The other process must
1006
make its own call to <b>LoadLibrary</b> for the module before calling
1007
<see cref="M:Tao.Platform.Windows.Kernel.GetProcAddress(System.IntPtr,System.String)"/>.
1008
</para>
1009
<para>
1010
If no file name extension is specified in the <i>fileName</i> parameter, the
1011
default library extension .dll is appended. However, the file name string
1012
can include a trailing point character (.) to indicate that the module name
1013
has no extension. When no path is specified, the function searches for loaded
1014
modules whose base name matches the base name of the module to be loaded. If
1015
the name matches, the load succeeds. Otherwise, the function searches for the
1016
file in the following sequence:
1017
</para>
1018
<para>
1019
<list type="number">
1020
<item>
1021
<description>
1022
The directory from which the application loaded.
1023
</description>
1024
</item>
1025
<item>
1026
<description>
1027
The current directory.
1028
</description>
1029
</item>
1030
<item>
1031
<description>
1032
The system directory. Use the <see cref="M:Tao.Platform.Windows.Kernel.GetSystemDirectory(System.Text.StringBuilder,System.Int32)"/>
1033
function to get the path of this directory.
1034
</description>
1035
</item>
1036
<item>
1037
<description>
1038
<para>
1039
The 16-bit system directory. There is no function that
1040
obtains the path of this directory, but it is searched.
1041
</para>
1042
<para>
1043
<b>Windows Me/98/95:</b> This directory does not exist.
1044
</para>
1045
</description>
1046
</item>
1047
<item>
1048
<description>
1049
The Windows directory. Use the <see cref="M:Tao.Platform.Windows.Kernel.GetWindowsDirectory(System.Text.StringBuilder,System.Int32)"/>
1050
function to get the path of this directory.
1051
</description>
1052
</item>
1053
<item>
1054
<description>
1055
The directories that are listed in the PATH environment variable.
1056
</description>
1057
</item>
1058
</list>
1059
</para>
1060
<para>
1061
<b>Windows Server 2003, Windows XP SP1:</b> The default value of
1062
HKLM\System\CurrentControlSet\Control\Session Manager\SafeDllSearchMode is 1
1063
(current directory is searched after the system and Windows directories).
1064
</para>
1065
<para>
1066
<b>Windows XP:</b> If
1067
HKLM\System\CurrentControlSet\Control\Session Manager\SafeDllSearchMode is 1,
1068
the current directory is searched after the system and Windows directories,
1069
but before the directories in the PATH environment variable. The default
1070
value is 0 (current directory is searched before the system and Windows
1071
directories).
1072
</para>
1073
<para>
1074
The first directory searched is the one directory containing the image file
1075
used to create the calling process (for more information, see the
1076
<b>CreateProcess</b> function). Doing this allows private dynamic-link
1077
library (DLL) files associated with a process to be found without adding the
1078
process's installed directory to the PATH environment variable.
1079
</para>
1080
<para>
1081
The search path can be altered using the <see cref="M:Tao.Platform.Windows.Kernel.SetDllDirectory(System.String)"/>
1082
function. This solution is recommended instead of using
1083
<b>SetCurrentDirectory</b> or hard-coding the full path to the DLL.
1084
</para>
1085
<para>
1086
If a path is specified and there is a redirection file for the application,
1087
the function searches for the module in the application's directory. If the
1088
module exists in the application's directory, the <b>LoadLibrary</b> function
1089
ignores the specified path and loads the module from the application's
1090
directory. If the module does not exist in the application's directory,
1091
<b>LoadLibrary</b> loads the module from the specified directory.
1092
</para>
1093
</remarks>
1094
<seealso cref="M:Tao.Platform.Windows.Kernel.FreeLibrary(System.IntPtr)"/>
1095
<seealso cref="M:Tao.Platform.Windows.Kernel.GetProcAddress(System.IntPtr,System.String)"/>
1096
<seealso cref="M:Tao.Platform.Windows.Kernel.GetSystemDirectory(System.Text.StringBuilder,System.Int32)"/>
1097
<seealso cref="M:Tao.Platform.Windows.Kernel.GetWindowsDirectory(System.Text.StringBuilder,System.Int32)"/>
1098
<seealso cref="M:Tao.Platform.Windows.Kernel.SetDllDirectory(System.String)"/>
1099
</member>
1100
<member name="M:Tao.Platform.Windows.Kernel.QueryPerformanceCounter(System.Int64@)">
1101
<summary>
1102
The <b>QueryPerformanceCounter</b> function retrieves the current value of the
1103
high-resolution performance counter.
1104
</summary>
1105
<param name="performanceCount">
1106
Pointer to a variable that receives the current performance-counter value, in
1107
counts.
1108
</param>
1109
<returns>
1110
<para>
1111
If the function succeeds, the return value is true.
1112
</para>
1113
<para>
1114
If the function fails, the return value is false. To get extended error
1115
information, call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.
1116
</para>
1117
</returns>
1118
<remarks>
1119
On a multiprocessor machine, it should not matter which processor is called.
1120
However, you can get different results on different processors due to bugs in the
1121
BIOS or the HAL. To specify processor affinity for a thread, use the
1122
<b>SetThreadAffinityMask</b> function.
1123
</remarks>
1124
<seealso cref="M:Tao.Platform.Windows.Kernel.QueryPerformanceCounterFast(System.Int64@)"/>
1125
<seealso cref="M:Tao.Platform.Windows.Kernel.QueryPerformanceFrequency(System.Int64@)"/>
1126
</member>
1127
<member name="M:Tao.Platform.Windows.Kernel.QueryPerformanceCounterFast(System.Int64@)">
1128
<summary>
1129
The <b>QueryPerformanceCounterFast</b> function retrieves the current value of the
1130
high-resolution performance counter.
1131
</summary>
1132
<param name="performanceCount">
1133
Pointer to a variable that receives the current performance-counter value, in
1134
counts.
1135
</param>
1136
<returns>
1137
<para>
1138
If the function succeeds, the return value is true.
1139
</para>
1140
<para>
1141
If the function fails, the return value is false.
1142
</para>
1143
</returns>
1144
<remarks>
1145
<para>
1146
This version of <see cref="M:Tao.Platform.Windows.Kernel.QueryPerformanceCounter(System.Int64@)"/> is slightly faster. It
1147
does not set the last Windows error. Use with care.
1148
</para>
1149
<para>
1150
On a multiprocessor machine, it should not matter which processor is called.
1151
However, you can get different results on different processors due to bugs in
1152
the BIOS or the HAL. To specify processor affinity for a thread, use the
1153
<b>SetThreadAffinityMask</b> function.
1154
</para>
1155
</remarks>
1156
<seealso cref="M:Tao.Platform.Windows.Kernel.QueryPerformanceCounter(System.Int64@)"/>
1157
<seealso cref="M:Tao.Platform.Windows.Kernel.QueryPerformanceFrequency(System.Int64@)"/>
1158
</member>
1159
<member name="M:Tao.Platform.Windows.Kernel.QueryPerformanceFrequency(System.Int64@)">
1160
<summary>
1161
The <b>QueryPerformanceFrequency</b> function retrieves the frequency of the
1162
high-resolution performance counter, if one exists. The frequency cannot change
1163
while the system is running.
1164
</summary>
1165
<param name="frequency">
1166
Pointer to a variable that receives the current performance-counter frequency, in
1167
counts per second. If the installed hardware does not support a high-resolution
1168
performance counter, this parameter can be zero.
1169
</param>
1170
<returns>
1171
<para>
1172
If the installed hardware supports a high-resolution performance counter, the
1173
return value is true.
1174
</para>
1175
<para>
1176
If the function fails, the return value is false. To get extended error
1177
information, call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>. For example, if
1178
the installed hardware does not support a high-resolution performance counter,
1179
the function fails.
1180
</para>
1181
</returns>
1182
<remarks>
1183
<b>Note</b> The frequency of the high-resolution performance counter is not the
1184
processor speed.
1185
</remarks>
1186
<seealso cref="M:Tao.Platform.Windows.Kernel.QueryPerformanceCounter(System.Int64@)"/>
1187
</member>
1188
<member name="M:Tao.Platform.Windows.Kernel.SetDllDirectory(System.String)">
1189
<summary>
1190
The <b>SetDllDirectory</b> function modifies the search path used to locate DLLs
1191
for the application.
1192
</summary>
1193
<param name="pathName">
1194
Pointer to a null-terminated string that specifies the directories to be added to
1195
the search path, separated by semicolons. If this parameter is NULL, the default
1196
search path is used.
1197
</param>
1198
<returns>
1199
<para>
1200
If the function succeeds, the return value is true.
1201
</para>
1202
<para>
1203
If the function fails, the return value is false. To get extended error
1204
information, call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.
1205
</para>
1206
</returns>
1207
<remarks>
1208
<para>
1209
The <b>SetDllDirectory</b> function affects all subsequent calls to the
1210
<see cref="M:Tao.Platform.Windows.Kernel.LoadLibrary(System.String)"/> and <b>LoadLibraryEx</b> functions. After calling
1211
<b>SetDllDirectory</b>, the DLL search path is:
1212
</para>
1213
<para>
1214
<list type="number">
1215
<item>
1216
<description>
1217
The directory from which the application loaded.
1218
</description>
1219
</item>
1220
<item>
1221
<description>
1222
The directory specified by the <i>pathName</i> parameter.
1223
</description>
1224
</item>
1225
<item>
1226
<description>
1227
The system directory. Use the <see cref="M:Tao.Platform.Windows.Kernel.GetSystemDirectory(System.Text.StringBuilder,System.Int32)"/>
1228
function to get the path of this directory. The name of this
1229
directory is System32.
1230
</description>
1231
</item>
1232
<item>
1233
<description>
1234
The 16-bit system directory. There is no function that obtains
1235
the path of this directory, but it is searched. The name of this
1236
directory is System.
1237
</description>
1238
</item>
1239
<item>
1240
<description>
1241
The Windows directory. Use the <see cref="M:Tao.Platform.Windows.Kernel.GetWindowsDirectory(System.Text.StringBuilder,System.Int32)"/>
1242
function to get the path of this directory.
1243
</description>
1244
</item>
1245
<item>
1246
<description>
1247
The directories that are listed in the PATH environment variable.
1248
</description>
1249
</item>
1250
</list>
1251
</para>
1252
<para>
1253
To revert to the default search path used by <see cref="M:Tao.Platform.Windows.Kernel.LoadLibrary(System.String)"/> and
1254
<b>LoadLibraryEx</b>, call <b>SetDllDirectory</b> with NULL.
1255
</para>
1256
</remarks>
1257
<seealso cref="M:Tao.Platform.Windows.Kernel.GetDllDirectory(System.Int32,System.Text.StringBuilder)"/>
1258
<seealso cref="M:Tao.Platform.Windows.Kernel.GetSystemDirectory(System.Text.StringBuilder,System.Int32)"/>
1259
<seealso cref="M:Tao.Platform.Windows.Kernel.GetWindowsDirectory(System.Text.StringBuilder,System.Int32)"/>
1260
<seealso cref="M:Tao.Platform.Windows.Kernel.LoadLibrary(System.String)"/>
1261
</member>
1262
<member name="M:Tao.Platform.Windows.Kernel.SetProcessWorkingSetSize(System.IntPtr,System.Int32,System.Int32)">
1263
<summary>
1264
The <b>SetProcessWorkingSetSize</b> function sets the minimum and maximum working
1265
set sizes for the specified process.
1266
</summary>
1267
<param name="process">
1268
<para>
1269
Handle to the process whose working set sizes is to be set.
1270
</para>
1271
<para>
1272
The handle must have the PROCESS_SET_QUOTA access right.
1273
</para>
1274
</param>
1275
<param name="minimumWorkingSetSize">
1276
<para>
1277
Minimum working set size for the process, in bytes. The virtual memory
1278
manager attempts to keep at least this much memory resident in the
1279
process whenever the process is active.
1280
</para>
1281
<para>
1282
If both <i>minimumWorkingSetSize</i> and <i>maximumWorkingSetSize</i> have the
1283
value -1, the function temporarily trims the working set of the specified
1284
process to zero. This essentially swaps the process out of physical RAM
1285
memory.
1286
</para>
1287
</param>
1288
<param name="maximumWorkingSetSize">
1289
<para>
1290
Maximum working set size for the process, in bytes. The virtual memory
1291
manager attempts to keep no more than this much memory resident in the
1292
process whenever the process is active and memory is in short supply.
1293
</para>
1294
<para>
1295
If both <i>minimumWorkingSetSize</i> and <i>maximumWorkingSetSize</i> have the
1296
value -1, the function temporarily trims the working set of the specified
1297
process to zero. This essentially swaps the process out of physical RAM
1298
memory.
1299
</para>
1300
</param>
1301
<returns>
1302
<para>
1303
If the function succeeds, the return value is true.
1304
</para>
1305
<para>
1306
If the function fails, the return value is false. To get extended error
1307
information, call <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.
1308
</para>
1309
</returns>
1310
<remarks>
1311
<para>
1312
The working set of a process is the set of memory pages currently visible to
1313
the process in physical RAM memory. These pages are resident and available
1314
for an application to use without triggering a page fault. The minimum and
1315
maximum working set sizes affect the virtual memory paging behavior of a
1316
process.
1317
</para>
1318
<para>
1319
The working set of the specified process can be emptied by specifying the
1320
value -1 for both the minimum and maximum working set sizes.
1321
</para>
1322
<para>
1323
If the values of either <i>minimumWorkingSetSize</i> or
1324
<i>maximumWorkingSetSize</i> are greater than the process' current working
1325
set sizes, the specified process must have the SE_INC_BASE_PRIORITY_NAME
1326
privilege. Users in the Administrators and Power Users groups generally
1327
have this privilege.
1328
</para>
1329
<para>
1330
The operating system allocates working set sizes on a first-come,
1331
first-served basis. For example, if an application successfully sets 40
1332
megabytes as its minimum working set size on a 64-megabyte system, and a
1333
second application requests a 40-megabyte working set size, the operating
1334
system denies the second application's request.
1335
</para>
1336
<para>
1337
Using the <b>SetProcessWorkingSetSize</b> function to set an application's
1338
minimum and maximum working set sizes does not guarantee that the requested
1339
memory will be reserved, or that it will remain resident at all times. When
1340
the application is idle, or a low-memory situation causes a demand for memory,
1341
the operating system can reduce the application's working set. An application
1342
can use the <b>VirtualLock</b> function to lock ranges of the application's
1343
virtual address space in memory; however, that can potentially degrade the
1344
performance of the system.
1345
</para>
1346
<para>
1347
When you increase the working set size of an application, you are taking away
1348
physical memory from the rest of the system. This can degrade the performance
1349
of other applications and the system as a whole. It can also lead to failures
1350
of operations that require physical memory to be present; for example,
1351
creating processes, threads, and kernel pool. Thus, you must use the
1352
<b>SetProcessWorkingSetSize</b> function carefully. You must always consider
1353
the performance of the whole system when you are designing an application.
1354
</para>
1355
</remarks>
1356
<seealso cref="M:Tao.Platform.Windows.Kernel.GetProcessWorkingSetSize(System.IntPtr,System.Int32@,System.Int32@)"/>
1357
</member>
1358
<member name="T:Tao.Platform.Windows.Kernel.MEMORYSTATUS">
1359
<summary>
1360
<para>
1361
The <b>MEMORYSTATUS</b> structure contains information about the current state
1362
of both physical and virtual memory.
1363
</para>
1364
<para>
1365
The <see cref="M:Tao.Platform.Windows.Kernel.GlobalMemoryStatus(Tao.Platform.Windows.Kernel.MEMORYSTATUS@)"/> function stores information in a
1366
<b>MEMORYSTATUS</b> structure.
1367
</para>
1368
</summary>
1369
<remarks>
1370
<para>
1371
<b>MEMORYSTATUS</b> reflects the state of memory at the time of the call. It
1372
reflects the size of the paging file at that time. The operating system can
1373
enlarge the paging file up to the maximum size set by the administrator.
1374
</para>
1375
<para>
1376
On computers with more than 4 GB of memory, the <b>MEMORYSTATUS</b> structure
1377
can return incorrect information. Windows reports a value of -1 to indicate
1378
an overflow, while Windows NT reports a value that is the real amount of
1379
memory, modulo 4 GB. If your application is at risk for this behavior, use
1380
the <b>GlobalMemoryStatusEx</b> function instead of the
1381
<see cref="M:Tao.Platform.Windows.Kernel.GlobalMemoryStatus(Tao.Platform.Windows.Kernel.MEMORYSTATUS@)"/> function.
1382
</para>
1383
</remarks>
1384
<seealso cref="M:Tao.Platform.Windows.Kernel.GlobalMemoryStatus(Tao.Platform.Windows.Kernel.MEMORYSTATUS@)"/>
1385
</member>
1386
<member name="F:Tao.Platform.Windows.Kernel.MEMORYSTATUS.Length">
1387
<summary>
1388
Size of the <b>MEMORYSTATUS</b> data structure, in bytes. You do not need to
1389
set this member before calling the <see cref="M:Tao.Platform.Windows.Kernel.GlobalMemoryStatus(Tao.Platform.Windows.Kernel.MEMORYSTATUS@)"/> function;
1390
the function sets it.
1391
</summary>
1392
</member>
1393
<member name="F:Tao.Platform.Windows.Kernel.MEMORYSTATUS.MemoryLoad">
1394
<summary>
1395
<para>
1396
Approximate percentage of total physical memory that is in use.
1397
</para>
1398
<para>
1399
<b>Windows NT:</b> Percentage of approximately the last 1000 pages of
1400
physical memory that is in use.
1401
</para>
1402
</summary>
1403
</member>
1404
<member name="F:Tao.Platform.Windows.Kernel.MEMORYSTATUS.TotalPhys">
1405
<summary>
1406
Total size of physical memory, in bytes.
1407
</summary>
1408
</member>
1409
<member name="F:Tao.Platform.Windows.Kernel.MEMORYSTATUS.AvailPhys">
1410
<summary>
1411
Size of physical memory available, in bytes.
1412
</summary>
1413
</member>
1414
<member name="F:Tao.Platform.Windows.Kernel.MEMORYSTATUS.TotalPageFile">
1415
<summary>
1416
Size of the committed memory limit, in bytes.
1417
</summary>
1418
</member>
1419
<member name="F:Tao.Platform.Windows.Kernel.MEMORYSTATUS.AvailPageFile">
1420
<summary>
1421
Size of available memory to commit, in bytes.
1422
</summary>
1423
</member>
1424
<member name="F:Tao.Platform.Windows.Kernel.MEMORYSTATUS.TotalVirtual">
1425
<summary>
1426
Total size of the user mode portion of the virtual address space of the
1427
calling process, in bytes.
1428
</summary>
1429
</member>
1430
<member name="F:Tao.Platform.Windows.Kernel.MEMORYSTATUS.AvailVirtual">
1431
<summary>
1432
Size of unreserved and uncommitted memory in the user mode portion of the
1433
virtual address space of the calling process, in bytes.
1434
</summary>
1435
</member>
1436
<member name="T:Tao.Platform.Windows.Kernel.SYSTEM_INFO">
1437
<summary>
1438
The <b>SYSTEM_INFO</b> structure contains information about the current computer
1439
system. This includes the architecture and type of the processor, the number of
1440
processors in the system, the page size, and other such information.
1441
</summary>
1442
<seealso cref="M:Tao.Platform.Windows.Kernel.GetSystemInfo(Tao.Platform.Windows.Kernel.SYSTEM_INFO@)"/>
1443
<seealso cref="T:Tao.Platform.Windows.Kernel.SYSTEM_INFO_UNION"/>
1444
</member>
1445
<member name="F:Tao.Platform.Windows.Kernel.SYSTEM_INFO.SystemInfoUnion">
1446
<summary>
1447
Union for the OemId, ProcessorArchitecture, and Reserved fields of the
1448
SYSTEM_INFO structure. See <see cref="T:Tao.Platform.Windows.Kernel.SYSTEM_INFO_UNION"/>.
1449
</summary>
1450
</member>
1451
<member name="F:Tao.Platform.Windows.Kernel.SYSTEM_INFO.PageSize">
1452
<summary>
1453
Page size and the granularity of page protection and commitment. This is the
1454
page size used by the <b>VirtualAlloc</b> function.
1455
</summary>
1456
</member>
1457
<member name="F:Tao.Platform.Windows.Kernel.SYSTEM_INFO.MinimumApplicationAddress">
1458
<summary>
1459
Pointer to the lowest memory address accessible to applications and
1460
dynamic-link libraries (DLLs).
1461
</summary>
1462
</member>
1463
<member name="F:Tao.Platform.Windows.Kernel.SYSTEM_INFO.MaximumApplicationAddress">
1464
<summary>
1465
Pointer to the highest memory address accessible to applications and DLLs.
1466
</summary>
1467
</member>
1468
<member name="F:Tao.Platform.Windows.Kernel.SYSTEM_INFO.ActiveProcessorMask">
1469
<summary>
1470
Mask representing the set of processors configured into the system. Bit 0 is
1471
processor 0; bit 31 is processor 31.
1472
</summary>
1473
</member>
1474
<member name="F:Tao.Platform.Windows.Kernel.SYSTEM_INFO.NumberOfProcessors">
1475
<summary>
1476
Number of processors in the system.
1477
</summary>
1478
</member>
1479
<member name="F:Tao.Platform.Windows.Kernel.SYSTEM_INFO.ProcessorType">
1480
<summary>
1481
<para>
1482
An obsolete member that is retained for compatibility with Windows NT 3.5
1483
and earlier. Use the <i>SystemInfoUnion.ProcessorArchitecture</i>,
1484
<i>ProcessorLevel</i>, and <i>ProcessorRevision</i> members to determine
1485
the type of processor.
1486
</para>
1487
<para>
1488
<b>Windows Me/98/95:</b> Specifies the type of processor in the system.
1489
This member is one of the following values:
1490
</para>
1491
<para>
1492
<see cref="F:Tao.Platform.Windows.WinNt.PROCESSOR_INTEL_386"/>
1493
</para>
1494
<para>
1495
<see cref="F:Tao.Platform.Windows.WinNt.PROCESSOR_INTEL_486"/>
1496
</para>
1497
<para>
1498
<see cref="F:Tao.Platform.Windows.WinNt.PROCESSOR_INTEL_PENTIUM"/>
1499
</para>
1500
</summary>
1501
</member>
1502
<member name="F:Tao.Platform.Windows.Kernel.SYSTEM_INFO.AllocationGranularity">
1503
<summary>
1504
Granularity with which virtual memory is allocated. For example, a
1505
<b>VirtualAlloc</b> request to allocate 1 byte will reserve an address space
1506
of <i>AllocationGranularity</i> bytes. This value was hard coded as 64K in
1507
the past, but other hardware architectures may require different values.
1508
</summary>
1509
</member>
1510
<member name="F:Tao.Platform.Windows.Kernel.SYSTEM_INFO.ProcessorLevel">
1511
<summary>
1512
<para>
1513
System's architecture-dependent processor level. It should be used only
1514
for display purposes. To determine the feature set of a processor, use
1515
the <see cref="M:Tao.Platform.Windows.Kernel.IsProcessorFeaturePresent(System.Int32)"/> function.
1516
</para>
1517
<para>
1518
If <i>SystemInfoUnion.ProcessorArchitecture</i> is
1519
<see cref="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_INTEL"/>, <i>ProcessorLevel</i>
1520
is defined by the CPU vendor.
1521
</para>
1522
<para>
1523
If <i>SystemInfoUnion.ProcessorArchitecture</i> is
1524
<see cref="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_IA64"/>, <i>ProcessorLevel</i> is
1525
set to 1.
1526
</para>
1527
<para>
1528
If <i>SystemInfoUnion.ProcessorArchitecture</i> is
1529
<see cref="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_MIPS"/>, <i>ProcessorLevel</i> is
1530
of the form 00xx, where xx is an 8-bit implementation number (bits 8-15 of
1531
the PRId register). The member can be the following value:
1532
</para>
1533
<para>
1534
<list type="table">
1535
<listheader>
1536
<term>Value</term>
1537
<description>Description</description>
1538
</listheader>
1539
<item>
1540
<term>0004</term>
1541
<description>MIPS R4000</description>
1542
</item>
1543
</list>
1544
</para>
1545
<para>
1546
If <i>SystemInfoUnion.ProcessorArchitecture</i> is
1547
<see cref="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_ALPHA"/>, <i>ProcessorLevel</i>
1548
is of the form xxxx, where xxxx is a 16-bit processor version number (the
1549
low-order 16 bits of a version number from the firmware). The member can
1550
be one of the following values:
1551
</para>
1552
<para>
1553
<list type="table">
1554
<listheader>
1555
<term>Value</term>
1556
<description>Description</description>
1557
</listheader>
1558
<item>
1559
<term>21064</term>
1560
<description>Alpha 21064</description>
1561
</item>
1562
<item>
1563
<term>21066</term>
1564
<description>Alpha 21066</description>
1565
</item>
1566
<item>
1567
<term>21164</term>
1568
<description>Alpha 21164</description>
1569
</item>
1570
</list>
1571
</para>
1572
<para>
1573
If <i>SystemInfoUnion.ProcessorArchitecture</i> is
1574
<see cref="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_PPC"/>, <i>ProcessorLevel</i> is
1575
of the form xxxx, where xxxx is a 16-bit processor version number (the
1576
high-order 16 bits of the Processor Version Register). The member can be
1577
one of the following values:
1578
</para>
1579
<para>
1580
<list type="table">
1581
<listheader>
1582
<term>Value</term>
1583
<description>Description</description>
1584
</listheader>
1585
<item>
1586
<term>1</term>
1587
<description>PPC 601</description>
1588
</item>
1589
<item>
1590
<term>3</term>
1591
<description>PPC 603</description>
1592
</item>
1593
<item>
1594
<term>4</term>
1595
<description>PPC 604</description>
1596
</item>
1597
<item>
1598
<term>6</term>
1599
<description>PPC 603+</description>
1600
</item>
1601
<item>
1602
<term>9</term>
1603
<description>PPC 604+</description>
1604
</item>
1605
<item>
1606
<term>20</term>
1607
<description>PPC 620</description>
1608
</item>
1609
</list>
1610
</para>
1611
</summary>
1612
</member>
1613
<member name="F:Tao.Platform.Windows.Kernel.SYSTEM_INFO.ProcessorRevision">
1614
<summary>
1615
<para>
1616
Architecture-dependent processor revision. The following table shows how
1617
the revision value is assembled for each type of processor architecture:
1618
</para>
1619
<para>
1620
<list type="table">
1621
<listheader>
1622
<term>Processor</term>
1623
<description>Description</description>
1624
</listheader>
1625
<item>
1626
<term>Intel 80386 or 80486</term>
1627
<description>
1628
<para>
1629
A value of the form xxyz.
1630
</para>
1631
<para>
1632
If xx is equal to 0xFF, y - 0xA is the model number, and
1633
z is the stepping identifier. For example, an Intel
1634
80486-D0 system returns 0xFFD0.
1635
</para>
1636
<para>
1637
If xx is not equal to 0xFF, xx + 'A' is the stepping
1638
letter and yz is the minor stepping.
1639
</para>
1640
</description>
1641
</item>
1642
<item>
1643
<term>Intel Pentium, Cyrix, or NextGen 586</term>
1644
<description>
1645
<para>
1646
A value of the form xxyy, where xx is the model number and
1647
yy is the stepping. Display this value of 0x0201 as
1648
follows:
1649
</para>
1650
<para>
1651
Model xx, Stepping yy.
1652
</para>
1653
</description>
1654
</item>
1655
<item>
1656
<term>MIPS</term>
1657
<description>
1658
A value of the form 00xx, where xx is the 8-bit revision
1659
number of the processor (the low-order 8 bits of the
1660
PRId register).
1661
</description>
1662
</item>
1663
<item>
1664
<term>ALPHA</term>
1665
<description>
1666
<para>
1667
A value of the form xxyy, where xxyy is the low-order 16
1668
bits of the processor revision number from the firmware.
1669
Display this value as follows:
1670
</para>
1671
<para>
1672
Model A+xx, Pass yy.
1673
</para>
1674
</description>
1675
</item>
1676
<item>
1677
<term>PPC</term>
1678
<description>
1679
<para>
1680
A value of the form xxyy, where xxyy is the low-order 16
1681
bits of the processor version register. Display this
1682
value as follows:
1683
</para>
1684
<para>
1685
xx.yy.
1686
</para>
1687
</description>
1688
</item>
1689
</list>
1690
</para>
1691
</summary>
1692
</member>
1693
<member name="T:Tao.Platform.Windows.Kernel.SYSTEM_INFO_UNION">
1694
<summary>
1695
Union for the OemId, ProcessorArchitecture, and Reserved fields of the
1696
<see cref="T:Tao.Platform.Windows.Kernel.SYSTEM_INFO"/> structure.
1697
</summary>
1698
<seealso cref="T:Tao.Platform.Windows.Kernel.SYSTEM_INFO"/>
1699
</member>
1700
<member name="F:Tao.Platform.Windows.Kernel.SYSTEM_INFO_UNION.OemId">
1701
<summary>
1702
<para>
1703
An obsolete member that is retained for compatibility with Windows NT 3.5
1704
and earlier. New applications should use the <i>ProcessorArchitecture</i>
1705
branch of the union.
1706
</para>
1707
<para>
1708
<b>Windows Me/98/95:</b> The system always sets this member to zero, the
1709
value defined for <see cref="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_INTEL"/>.
1710
</para>
1711
</summary>
1712
</member>
1713
<member name="F:Tao.Platform.Windows.Kernel.SYSTEM_INFO_UNION.ProcessorArchitecture">
1714
<summary>
1715
<para>
1716
System's processor architecture. This value can be one of the following
1717
values:
1718
</para>
1719
<para>
1720
<see cref="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_UNKNOWN"/>
1721
</para>
1722
<para>
1723
<see cref="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_INTEL"/>
1724
</para>
1725
<para>
1726
<b>Windows NT 3.51:</b> <see cref="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_MIPS"/>
1727
</para>
1728
<para>
1729
<b>Windows NT 4.0 and earlier:</b>
1730
<see cref="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_ALPHA"/>
1731
</para>
1732
<para>
1733
<b>Windows NT 4.0 and earlier:</b>
1734
<see cref="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_PPC"/>
1735
</para>
1736
<para>
1737
<b>64-bit Windows:</b> <see cref="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_IA64"/>,
1738
<see cref="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_IA32_ON_WIN64"/>,
1739
<see cref="F:Tao.Platform.Windows.WinNt.PROCESSOR_ARCHITECTURE_AMD64"/>
1740
</para>
1741
</summary>
1742
</member>
1743
<member name="F:Tao.Platform.Windows.Kernel.SYSTEM_INFO_UNION.Reserved">
1744
<summary>
1745
Reserved for future use.
1746
</summary>
1747
</member>
1748
<member name="T:Tao.Platform.Windows.IlasmAttribute">
1749
<summary>
1750
Injects supplied MSIL into the method's body.
1751
</summary>
1752
<remarks>
1753
This is a hack as the C# compiler does not allow inline MSIL. This is extracted and
1754
the appropriate MSIL injected by the PostProcessTao utility.
1755
</remarks>
1756
</member>
1757
<member name="M:Tao.Platform.Windows.IlasmAttribute.#ctor(System.String)">
1758
<summary>
1759
Injects the supplied MSIL into the tagged method's body.
1760
</summary>
1761
<param name="msil">
1762
The MSIL to inject.
1763
</param>
1764
</member>
1765
<member name="M:Tao.Platform.Windows.Wgl.GetDelegate(System.String,System.Type)">
1766
<summary>
1767
Creates a System.Delegate that can be used to call an OpenGL function, core or extension.
1768
</summary>
1769
<param name="name">The name of the OpenGL function (eg. "glNewList")</param>
1770
<param name="signature">The signature of the OpenGL function.</param>
1771
<returns>
1772
A System.Delegate that can be used to call this OpenGL function, or null if the specified
1773
function name did not correspond to an OpenGL function.
1774
</returns>
1775
</member>
1776
<member name="M:Tao.Platform.Windows.Wgl.ReloadFunctions">
1777
<summary>
1778
Loads all OpenGL functions (core and extensions).
1779
</summary>
1780
<remarks>
1781
<para>
1782
This function will be automatically called the first time you use any opengl function. There is
1783
</para>
1784
<para>
1785
Call this function manually whenever you need to update OpenGL entry points.
1786
This need may arise if you change the pixelformat/visual, or in case you cannot
1787
(or do not want) to use the automatic initialization of the GL class.
1788
</para>
1789
</remarks>
1790
</member>
1791
<member name="M:Tao.Platform.Windows.Wgl.Load(System.String)">
1792
<summary>
1793
Tries to reload the given OpenGL function (core or extension).
1794
</summary>
1795
<param name="function">The name of the OpenGL function (i.e. glShaderSource)</param>
1796
<returns>True if the function was found and reloaded, false otherwise.</returns>
1797
<remarks>
1798
<para>
1799
Use this function if you require greater granularity when loading OpenGL entry points.
1800
</para>
1801
<para>
1802
While the automatic initialisation will load all OpenGL entry points, in some cases
1803
the initialisation can take place before an OpenGL Context has been established.
1804
In this case, use this function to load the entry points for the OpenGL functions
1805
you will need, or use ReloadFunctions() to load all available entry points.
1806
</para>
1807
<para>
1808
This function returns true if the given OpenGL function is supported, false otherwise.
1809
</para>
1810
<para>
1811
To query for supported extensions use the IsExtensionSupported() function instead.
1812
</para>
1813
</remarks>
1814
</member>
1815
<member name="M:Tao.Platform.Windows.Wgl.GetExtensionDelegate(System.String,System.Type)">
1816
<summary>
1817
Creates a System.Delegate that can be used to call a dynamically exported OpenGL function.
1818
</summary>
1819
<param name="name">The name of the OpenGL function (eg. "glNewList")</param>
1820
<param name="signature">The signature of the OpenGL function.</param>
1821
<returns>
1822
A System.Delegate that can be used to call this OpenGL function or null
1823
if the function is not available in the current OpenGL context.
1824
</returns>
1825
</member>
1826
<member name="M:Tao.Platform.Windows.Wgl.IsExtensionSupported(System.String)">
1827
<summary>
1828
Determines whether the specified OpenGL extension category is available in
1829
the current OpenGL context. Equivalent to IsExtensionSupported(name, true)
1830
</summary>
1831
<param name="name">The string for the OpenGL extension category (eg. "GL_ARB_multitexture")</param>
1832
<returns>True if the specified extension is available, false otherwise.</returns>
1833
</member>
1834
<member name="T:Tao.Platform.Windows.Wgl.Imports">
1835
<summary>
1836
Contains DllImports for the core OpenGL functions.
1837
</summary>
1838
</member>
1839
<member name="F:Tao.Platform.Windows.Wgl.Imports.FunctionMap">
1840
<summary>
1841
Build a string->MethodInfo map to speed up extension loading.
1842
</summary>
1843
</member>
1844
<member name="T:Tao.Platform.Windows.Winmm">
1845
<summary>
1846
Windows Multimedia binding for .NET, implementing Windows-specific multimedia
1847
functionality.
1848
</summary>
1849
<remarks>
1850
Binds functions and definitions in winmm.dll.
1851
</remarks>
1852
</member>
1853
<member name="F:Tao.Platform.Windows.Winmm.WINMM_NATIVE_LIBRARY">
1854
<summary>
1855
Specifies Winmm's native library archive.
1856
</summary>
1857
<remarks>
1858
Specifies winmm.dll for Windows.
1859
</remarks>
1860
</member>
1861
<member name="F:Tao.Platform.Windows.Winmm.CALLING_CONVENTION">
1862
<summary>
1863
Specifies the calling convention.
1864
</summary>
1865
<remarks>
1866
Specifies <see cref="F:System.Runtime.InteropServices.CallingConvention.StdCall"/>.
1867
</remarks>
1868
</member>
1869
<member name="F:Tao.Platform.Windows.Winmm.SND_SYNC">
1870
<summary>
1871
Synchronous playback of a sound event. <b>PlaySound</b> returns after the sound
1872
event completes.
1873
</summary>
1874
</member>
1875
<member name="F:Tao.Platform.Windows.Winmm.SND_ASYNC">
1876
<summary>
1877
The sound is played asynchronously and <b>PlaySound</b> returns immediately after
1878
beginning the sound. To terminate an asynchronously played waveform sound, call
1879
<b>PlaySound</b> with <i>sound</i> set to NULL.
1880
</summary>
1881
</member>
1882
<member name="F:Tao.Platform.Windows.Winmm.SND_NODEFAULT">
1883
<summary>
1884
No default sound event is used. If the sound cannot be found, <b>PlaySound</b>
1885
returns silently without playing the default sound.
1886
</summary>
1887
</member>
1888
<member name="F:Tao.Platform.Windows.Winmm.SND_MEMORY">
1889
<summary>
1890
A sound event's file is loaded in RAM. The parameter specified by <i>sound</i>
1891
must point to an image of a sound in memory.
1892
</summary>
1893
</member>
1894
<member name="F:Tao.Platform.Windows.Winmm.SND_LOOP">
1895
<summary>
1896
The sound plays repeatedly until <b>PlaySound</b> is called again with the
1897
<i>sound</i> parameter set to NULL. You must also specify the
1898
<see cref="F:Tao.Platform.Windows.Winmm.SND_ASYNC"/> flag to indicate an asynchronous sound event.
1899
</summary>
1900
</member>
1901
<member name="F:Tao.Platform.Windows.Winmm.SND_NOSTOP">
1902
<summary>
1903
<para>
1904
The specified sound event will yield to another sound event that is already
1905
playing. If a sound cannot be played because the resource needed to
1906
generate that sound is busy playing another sound, the function immediately
1907
returns FALSE without playing the requested sound.
1908
</para>
1909
<para>
1910
If this flag is not specified, <b>PlaySound</b> attempts to stop the currently
1911
playing sound so that the device can be used to play the new sound.
1912
</para>
1913
</summary>
1914
</member>
1915
<member name="F:Tao.Platform.Windows.Winmm.SND_NOWAIT">
1916
<summary>
1917
If the driver is busy, return immediately without playing the sound.
1918
</summary>
1919
</member>
1920
<member name="F:Tao.Platform.Windows.Winmm.SND_ALIAS">
1921
<summary>
1922
The <i>sound</i> parameter is a system-event alias in the registry or the WIN.INI
1923
file. Do not use with either <see cref="F:Tao.Platform.Windows.Winmm.SND_FILENAME"/> or
1924
<see cref="F:Tao.Platform.Windows.Winmm.SND_RESOURCE"/>.
1925
</summary>
1926
</member>
1927
<member name="F:Tao.Platform.Windows.Winmm.SND_ALIAS_ID">
1928
<summary>
1929
The <i>sound</i> parameter is a predefined sound identifier.
1930
</summary>
1931
</member>
1932
<member name="F:Tao.Platform.Windows.Winmm.SND_FILENAME">
1933
<summary>
1934
The <i>sound</i> parameter is a filename.
1935
</summary>
1936
</member>
1937
<member name="F:Tao.Platform.Windows.Winmm.SND_RESOURCE">
1938
<summary>
1939
The <i>sound</i> parameter is a resource identifier; <i>mod</i> must identify the
1940
instance that contains the resource.
1941
</summary>
1942
</member>
1943
<member name="F:Tao.Platform.Windows.Winmm.SND_PURGE">
1944
<summary>
1945
<para>
1946
Sounds are to be stopped for the calling task. If <i>sound</i> is not
1947
NULL, all instances of the specified sound are stopped. If <i>sound</i> is
1948
NULL, all sounds that are playing on behalf of the calling task are stopped.
1949
</para>
1950
<para>
1951
You must also specify the instance handle to stop <see cref="F:Tao.Platform.Windows.Winmm.SND_RESOURCE"/>
1952
events.
1953
</para>
1954
</summary>
1955
</member>
1956
<member name="F:Tao.Platform.Windows.Winmm.SND_APPLICATION">
1957
<summary>
1958
The sound is played using an application-specific association.
1959
</summary>
1960
</member>
1961
<member name="F:Tao.Platform.Windows.Winmm.TIMERR_BASE">
1962
<summary>
1963
Timer base identifier.
1964
</summary>
1965
</member>
1966
<member name="F:Tao.Platform.Windows.Winmm.TIMERR_NOERROR">
1967
<summary>
1968
Successful.
1969
</summary>
1970
</member>
1971
<member name="F:Tao.Platform.Windows.Winmm.TIMERR_NOCANDO">
1972
<summary>
1973
Resolution specified is out of range.
1974
</summary>
1975
</member>
1976
<member name="F:Tao.Platform.Windows.Winmm.JOY_BUTTON1">
1977
<summary>
1978
First joystick button is pressed.
1979
</summary>
1980
</member>
1981
<member name="F:Tao.Platform.Windows.Winmm.JOY_BUTTON2">
1982
<summary>
1983
Second joystick button is pressed.
1984
</summary>
1985
</member>
1986
<member name="F:Tao.Platform.Windows.Winmm.JOY_BUTTON3">
1987
<summary>
1988
Third joystick button is pressed.
1989
</summary>
1990
</member>
1991
<member name="F:Tao.Platform.Windows.Winmm.JOY_BUTTON4">
1992
<summary>
1993
Four joystick button is pressed.
1994
</summary>
1995
</member>
1996
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS_HASZ">
1997
<summary>
1998
Joystick has z-coordinate information.
1999
</summary>
2000
</member>
2001
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS_HASR">
2002
<summary>
2003
Joystick has rudder (fourth axis) information.
2004
</summary>
2005
</member>
2006
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS_HASU">
2007
<summary>
2008
Joystick has u-coordinate (fifth axis) information.
2009
</summary>
2010
</member>
2011
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS_HASV">
2012
<summary>
2013
Joystick has v-coordinate (sixth axis) information.
2014
</summary>
2015
</member>
2016
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS_HASPOV">
2017
<summary>
2018
Joystick has point-of-view information.
2019
</summary>
2020
</member>
2021
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS_POV4DIR">
2022
<summary>
2023
Joystick point-of-view supports discrete values (centered, forward, backward, left, and right).
2024
</summary>
2025
</member>
2026
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS_POVCTS">
2027
<summary>
2028
Joystick point-of-view supports continuous degree bearings.
2029
</summary>
2030
</member>
2031
<member name="F:Tao.Platform.Windows.Winmm.JOY_RETURNX">
2032
<summary></summary>
2033
</member>
2034
<member name="F:Tao.Platform.Windows.Winmm.JOY_RETURNY">
2035
<summary></summary>
2036
</member>
2037
<member name="F:Tao.Platform.Windows.Winmm.JOY_RETURNZ">
2038
<summary></summary>
2039
</member>
2040
<member name="F:Tao.Platform.Windows.Winmm.JOY_RETURNR">
2041
<summary></summary>
2042
</member>
2043
<member name="F:Tao.Platform.Windows.Winmm.JOY_RETURNU">
2044
<summary></summary>
2045
</member>
2046
<member name="F:Tao.Platform.Windows.Winmm.JOY_RETURNV">
2047
<summary></summary>
2048
</member>
2049
<member name="F:Tao.Platform.Windows.Winmm.JOY_RETURNPOV">
2050
<summary></summary>
2051
</member>
2052
<member name="F:Tao.Platform.Windows.Winmm.JOY_RETURNBUTTONS">
2053
<summary></summary>
2054
</member>
2055
<member name="F:Tao.Platform.Windows.Winmm.JOY_RETURNRAWDATA">
2056
<summary></summary>
2057
</member>
2058
<member name="F:Tao.Platform.Windows.Winmm.JOY_RETURNPOVCTS">
2059
<summary></summary>
2060
</member>
2061
<member name="F:Tao.Platform.Windows.Winmm.JOY_RETURNCENTERED">
2062
<summary></summary>
2063
</member>
2064
<member name="F:Tao.Platform.Windows.Winmm.JOY_USEDEADZONE">
2065
<summary></summary>
2066
</member>
2067
<member name="F:Tao.Platform.Windows.Winmm.JOY_RETURNALL">
2068
<summary></summary>
2069
</member>
2070
<member name="F:Tao.Platform.Windows.Winmm.JOY_CAL_READALWAYS">
2071
<summary></summary>
2072
</member>
2073
<member name="F:Tao.Platform.Windows.Winmm.JOY_CAL_READXYONLY">
2074
<summary></summary>
2075
</member>
2076
<member name="F:Tao.Platform.Windows.Winmm.JOY_CAL_READ3">
2077
<summary></summary>
2078
</member>
2079
<member name="F:Tao.Platform.Windows.Winmm.JOY_CAL_READ4">
2080
<summary></summary>
2081
</member>
2082
<member name="F:Tao.Platform.Windows.Winmm.JOY_CAL_READXONLY">
2083
<summary></summary>
2084
</member>
2085
<member name="F:Tao.Platform.Windows.Winmm.JOY_CAL_READYONLY">
2086
<summary></summary>
2087
</member>
2088
<member name="F:Tao.Platform.Windows.Winmm.JOY_CAL_READ5">
2089
<summary></summary>
2090
</member>
2091
<member name="F:Tao.Platform.Windows.Winmm.JOY_CAL_READ6">
2092
<summary></summary>
2093
</member>
2094
<member name="F:Tao.Platform.Windows.Winmm.JOY_CAL_READZONLY">
2095
<summary></summary>
2096
</member>
2097
<member name="F:Tao.Platform.Windows.Winmm.JOY_CAL_READRONLY">
2098
<summary></summary>
2099
</member>
2100
<member name="F:Tao.Platform.Windows.Winmm.JOY_CAL_READUONLY">
2101
<summary></summary>
2102
</member>
2103
<member name="F:Tao.Platform.Windows.Winmm.JOY_CAL_READVONLY">
2104
<summary></summary>
2105
</member>
2106
<member name="F:Tao.Platform.Windows.Winmm.JOY_POVCENTERED">
2107
<summary></summary>
2108
</member>
2109
<member name="F:Tao.Platform.Windows.Winmm.JOY_POVFORWARD">
2110
<summary></summary>
2111
</member>
2112
<member name="F:Tao.Platform.Windows.Winmm.JOY_POVRIGHT">
2113
<summary></summary>
2114
</member>
2115
<member name="F:Tao.Platform.Windows.Winmm.JOY_POVBACKWARD">
2116
<summary></summary>
2117
</member>
2118
<member name="F:Tao.Platform.Windows.Winmm.JOY_POVLEFT">
2119
<summary></summary>
2120
</member>
2121
<member name="F:Tao.Platform.Windows.Winmm.MMSYSERR_BASE">
2122
<summary></summary>
2123
</member>
2124
<member name="F:Tao.Platform.Windows.Winmm.MMSYSERR_NOERROR">
2125
<summary></summary>
2126
</member>
2127
<member name="F:Tao.Platform.Windows.Winmm.MMSYSERR_ERROR">
2128
<summary></summary>
2129
</member>
2130
<member name="F:Tao.Platform.Windows.Winmm.MMSYSERR_BADDEVICEID">
2131
<summary></summary>
2132
</member>
2133
<member name="F:Tao.Platform.Windows.Winmm.MMSYSERR_NOTENABLED">
2134
<summary></summary>
2135
</member>
2136
<member name="F:Tao.Platform.Windows.Winmm.MMSYSERR_ALLOCATED">
2137
<summary></summary>
2138
</member>
2139
<member name="F:Tao.Platform.Windows.Winmm.MMSYSERR_INVALHANDLE">
2140
<summary></summary>
2141
</member>
2142
<member name="F:Tao.Platform.Windows.Winmm.MMSYSERR_NODRIVER">
2143
<summary></summary>
2144
</member>
2145
<member name="F:Tao.Platform.Windows.Winmm.MMSYSERR_NOMEM">
2146
<summary></summary>
2147
</member>
2148
<member name="F:Tao.Platform.Windows.Winmm.MMSYSERR_NOTSUPPORTED">
2149
<summary></summary>
2150
</member>
2151
<member name="F:Tao.Platform.Windows.Winmm.MMSYSERR_BADERRNUM">
2152
<summary></summary>
2153
</member>
2154
<member name="F:Tao.Platform.Windows.Winmm.MMSYSERR_INVALFLAG">
2155
<summary></summary>
2156
</member>
2157
<member name="F:Tao.Platform.Windows.Winmm.MMSYSERR_INVALPARAM">
2158
<summary></summary>
2159
</member>
2160
<member name="F:Tao.Platform.Windows.Winmm.MMSYSERR_LASTERROR">
2161
<summary></summary>
2162
</member>
2163
<member name="F:Tao.Platform.Windows.Winmm.JOYERR_NOERROR">
2164
<summary></summary>
2165
</member>
2166
<member name="F:Tao.Platform.Windows.Winmm.JOYERR_PARMS">
2167
<summary></summary>
2168
</member>
2169
<member name="F:Tao.Platform.Windows.Winmm.JOYERR_NOCANDO">
2170
<summary></summary>
2171
</member>
2172
<member name="F:Tao.Platform.Windows.Winmm.JOYERR_UNPLUGGED">
2173
<summary></summary>
2174
</member>
2175
<member name="F:Tao.Platform.Windows.Winmm.JOYSTICKID1">
2176
<summary></summary>
2177
</member>
2178
<member name="F:Tao.Platform.Windows.Winmm.JOYSTICKID2">
2179
<summary></summary>
2180
</member>
2181
<member name="F:Tao.Platform.Windows.Winmm.MM_JOY1MOVE">
2182
<summary></summary>
2183
</member>
2184
<member name="F:Tao.Platform.Windows.Winmm.MM_JOY2MOVE">
2185
<summary></summary>
2186
</member>
2187
<member name="F:Tao.Platform.Windows.Winmm.MM_JOY1ZMOVE">
2188
<summary></summary>
2189
</member>
2190
<member name="F:Tao.Platform.Windows.Winmm.MM_JOY2ZMOVE">
2191
<summary></summary>
2192
</member>
2193
<member name="M:Tao.Platform.Windows.Winmm.PlaySound(System.String,System.IntPtr,System.Int32)">
2194
<summary>
2195
The <b>PlaySound</b> function plays a sound specified by the given filename,
2196
resource, or system event. (A system event may be associated with a sound in the
2197
registry or in the WIN.INI file.)
2198
</summary>
2199
<param name="sound">
2200
<para>
2201
A string that specifies the sound to play. If this parameter is NULL, any
2202
currently playing waveform sound is stopped. To stop a non-waveform sound,
2203
specify <see cref="F:Tao.Platform.Windows.Winmm.SND_PURGE"/> in the <i>soundFlags</i> parameter.
2204
</para>
2205
<para>
2206
Three flags in <i>soundFlags</i> (<see cref="F:Tao.Platform.Windows.Winmm.SND_ALIAS"/>,
2207
<see cref="F:Tao.Platform.Windows.Winmm.SND_FILENAME"/>, and <see cref="F:Tao.Platform.Windows.Winmm.SND_RESOURCE"/>) determine
2208
whether the name is interpreted as an alias for a system event, a filename, or
2209
a resource identifier. If none of these flags are specified, <b>PlaySound</b>
2210
searches the registry or the WIN.INI file for an association with the
2211
specified sound name. If an association is found, the sound event is played.
2212
If no association is found in the registry, the name is interpreted as a
2213
filename.
2214
</para>
2215
</param>
2216
<param name="mod">
2217
Handle to the executable file that contains the resource to be loaded. This
2218
parameter must be NULL unless <see cref="F:Tao.Platform.Windows.Winmm.SND_RESOURCE"/> is specified in
2219
<i>soundFlags</i>.
2220
</param>
2221
<param name="soundFlags">
2222
<para>
2223
Flags for playing the sound. The following values are defined:
2224
</para>
2225
<para>
2226
<list type="table">
2227
<listheader>
2228
<term>Value</term>
2229
<description>Description</description>
2230
</listheader>
2231
<item>
2232
<term><see cref="F:Tao.Platform.Windows.Winmm.SND_APPLICATION"/></term>
2233
<description>
2234
The sound is played using an application-specific association.
2235
</description>
2236
</item>
2237
<item>
2238
<term><see cref="F:Tao.Platform.Windows.Winmm.SND_ALIAS"/></term>
2239
<description>
2240
The <i>sound</i> parameter is a system-event alias in the registry
2241
or the WIN.INI file. Do not use with either
2242
<see cref="F:Tao.Platform.Windows.Winmm.SND_FILENAME"/> or <see cref="F:Tao.Platform.Windows.Winmm.SND_RESOURCE"/>.
2243
</description>
2244
</item>
2245
<item>
2246
<term><see cref="F:Tao.Platform.Windows.Winmm.SND_ALIAS_ID"/></term>
2247
<description>
2248
The <i>sound</i> parameter is a predefined sound identifier.
2249
</description>
2250
</item>
2251
<item>
2252
<term><see cref="F:Tao.Platform.Windows.Winmm.SND_ASYNC"/></term>
2253
<description>
2254
The sound is played asynchronously and <b>PlaySound</b> returns
2255
immediately after beginning the sound. To terminate an
2256
asynchronously played waveform sound, call <b>PlaySound</b> with
2257
<i>sound</i> set to NULL.
2258
</description>
2259
</item>
2260
<item>
2261
<term><see cref="F:Tao.Platform.Windows.Winmm.SND_FILENAME"/></term>
2262
<description>
2263
The <i>sound</i> parameter is a filename.
2264
</description>
2265
</item>
2266
<item>
2267
<term><see cref="F:Tao.Platform.Windows.Winmm.SND_LOOP"/></term>
2268
<description>
2269
The sound plays repeatedly until <b>PlaySound</b> is called again
2270
with the <i>sound</i> parameter set to NULL. You must also
2271
specify the <see cref="F:Tao.Platform.Windows.Winmm.SND_ASYNC"/> flag to indicate an
2272
asynchronous sound event.
2273
</description>
2274
</item>
2275
<item>
2276
<term><see cref="F:Tao.Platform.Windows.Winmm.SND_MEMORY"/></term>
2277
<description>
2278
A sound event's file is loaded in RAM. The parameter specified by
2279
<i>sound</i> must point to an image of a sound in memory.
2280
</description>
2281
</item>
2282
<item>
2283
<term><see cref="F:Tao.Platform.Windows.Winmm.SND_NODEFAULT"/></term>
2284
<description>
2285
No default sound event is used. If the sound cannot be found,
2286
<b>PlaySound</b> returns silently without playing the default
2287
sound.
2288
</description>
2289
</item>
2290
<item>
2291
<term><see cref="F:Tao.Platform.Windows.Winmm.SND_NOSTOP"/></term>
2292
<description>
2293
<para>
2294
The specified sound event will yield to another sound event
2295
that is already playing. If a sound cannot be played because
2296
the resource needed to generate that sound is busy playing
2297
another sound, the function immediately returns FALSE without
2298
playing the requested sound.
2299
</para>
2300
<para>
2301
If this flag is not specified, <b>PlaySound</b> attempts to
2302
stop the currently playing sound so that the device can be
2303
used to play the new sound.
2304
</para>
2305
</description>
2306
</item>
2307
<item>
2308
<term><see cref="F:Tao.Platform.Windows.Winmm.SND_NOWAIT"/></term>
2309
<description>
2310
If the driver is busy, return immediately without playing the
2311
sound.
2312
</description>
2313
</item>
2314
<item>
2315
<term><see cref="F:Tao.Platform.Windows.Winmm.SND_PURGE"/></term>
2316
<description>
2317
<para>
2318
Sounds are to be stopped for the calling task. If
2319
<i>sound</i> is not NULL, all instances of the specified sound
2320
are stopped. If <i>sound</i> is NULL, all sounds that are
2321
playing on behalf of the calling task are stopped.
2322
</para>
2323
<para>
2324
You must also specify the instance handle to stop
2325
<see cref="F:Tao.Platform.Windows.Winmm.SND_RESOURCE"/> events.
2326
</para>
2327
</description>
2328
</item>
2329
<item>
2330
<term><see cref="F:Tao.Platform.Windows.Winmm.SND_RESOURCE"/></term>
2331
<description>
2332
The <i>sound</i> parameter is a resource identifier; <i>mod</i>
2333
must identify the instance that contains the resource.
2334
</description>
2335
</item>
2336
<item>
2337
<term><see cref="F:Tao.Platform.Windows.Winmm.SND_SYNC"/></term>
2338
<description>
2339
Synchronous playback of a sound event. <b>PlaySound</b> returns
2340
after the sound event completes.
2341
</description>
2342
</item>
2343
</list>
2344
</para>
2345
</param>
2346
<returns>
2347
Returns TRUE if successful or FALSE otherwise.
2348
</returns>
2349
<remarks>
2350
<para>
2351
The sound specified by <i>sound</i> must fit into available physical memory
2352
and be playable by an installed waveform-audio device driver.
2353
<b>PlaySound</b> searches the following directories for sound files: the
2354
current directory; the Windows directory; the Windows system directory;
2355
directories listed in the PATH environment variable; and the list of
2356
directories mapped in a network. For more information about the directory
2357
search order, see the documentation for the <b>OpenFile</b> function.
2358
</para>
2359
<para>
2360
If it cannot find the specified sound, <b>PlaySound</b> uses the default
2361
system event sound entry instead. If the function can find neither the
2362
system default entry nor the default sound, it makes no sound and returns
2363
FALSE.
2364
</para>
2365
</remarks>
2366
</member>
2367
<member name="M:Tao.Platform.Windows.Winmm.timeBeginPeriod(System.Int32)">
2368
<summary>
2369
The <b>timeBeginPeriod</b> function sets the minimum timer resolution for an
2370
application or device driver.
2371
</summary>
2372
<param name="period">
2373
Minimum timer resolution, in milliseconds, for the application or device driver.
2374
</param>
2375
<returns>
2376
Returns <see cref="F:Tao.Platform.Windows.Winmm.TIMERR_NOERROR"/> if successful or
2377
<see cref="F:Tao.Platform.Windows.Winmm.TIMERR_NOCANDO"/> if the resolution specified in <i>period</i> is out
2378
of range.
2379
</returns>
2380
<remarks>
2381
<para>
2382
Call this function immediately before using timer services, and call the
2383
<see cref="M:Tao.Platform.Windows.Winmm.timeEndPeriod(System.Int32)"/> function immediately after you are finished
2384
using the timer services.
2385
</para>
2386
<para>
2387
You must match each call to <b>timeBeginPeriod</b> with a call to
2388
<see cref="M:Tao.Platform.Windows.Winmm.timeEndPeriod(System.Int32)"/>, specifying the same minimum resolution in both
2389
calls. An application can make multiple <b>timeBeginPeriod</b> calls as long
2390
as each call is matched with a call to <see cref="M:Tao.Platform.Windows.Winmm.timeEndPeriod(System.Int32)"/>.
2391
</para>
2392
</remarks>
2393
<seealso cref="M:Tao.Platform.Windows.Winmm.timeEndPeriod(System.Int32)"/>
2394
</member>
2395
<member name="M:Tao.Platform.Windows.Winmm.timeEndPeriod(System.Int32)">
2396
<summary>
2397
The <b>timeEndPeriod</b> function clears a previously set minimum timer
2398
resolution.
2399
</summary>
2400
<param name="period">
2401
Minimum timer resolution specified in the previous call to the
2402
<see cref="M:Tao.Platform.Windows.Winmm.timeBeginPeriod(System.Int32)"/> function.
2403
</param>
2404
<returns>
2405
Returns <see cref="F:Tao.Platform.Windows.Winmm.TIMERR_NOERROR"/> if successful or
2406
<see cref="F:Tao.Platform.Windows.Winmm.TIMERR_NOCANDO"/> if the resolution specified in <i>period</i> is out
2407
of range
2408
</returns>
2409
<remarks>
2410
<para>
2411
Call this function immediately after you are finished using timer services.
2412
</para>
2413
<para>
2414
You must match each call to <see cref="M:Tao.Platform.Windows.Winmm.timeBeginPeriod(System.Int32)"/> with a call to
2415
<b>timeEndPeriod</b>, specifying the same minimum resolution in both calls.
2416
An application can make multiple <see cref="M:Tao.Platform.Windows.Winmm.timeBeginPeriod(System.Int32)"/> calls as long
2417
as each call is matched with a call to <b>timeEndPeriod</b>.
2418
</para>
2419
</remarks>
2420
<seealso cref="M:Tao.Platform.Windows.Winmm.timeBeginPeriod(System.Int32)"/>
2421
</member>
2422
<member name="M:Tao.Platform.Windows.Winmm.timeGetTime">
2423
<summary>
2424
The <b>timeGetTime</b> function retrieves the system time, in milliseconds.
2425
The system time is the time elapsed since Windows was started.
2426
</summary>
2427
<returns>
2428
Returns the system time, in milliseconds.
2429
</returns>
2430
<remarks>
2431
<para>
2432
The only difference between this function and the <b>timeGetSystemTime</b>
2433
function is that <b>timeGetSystemTime</b> uses the <b>MMTIME</b> structure to
2434
return the system time. The <b>timeGetTime</b> function has less overhead
2435
than <b>timeGetSystemTime</b>.
2436
</para>
2437
<para>
2438
Note that the value returned by the <b>timeGetTime</b> function is a DWORD
2439
value. The return value wraps around to 0 every 2^32 milliseconds, which is
2440
about 49.71 days. This can cause problems in code that directly uses the
2441
<b>timeGetTime</b> return value in computations, particularly where the value
2442
is used to control code execution. You should always use the difference
2443
between two <b>timeGetTime</b> return values in computations.
2444
</para>
2445
<para>
2446
<b>Windows NT/2000:</b> The default precision of the <b>timeGetTime</b>
2447
function can be five milliseconds or more, depending on the machine. You
2448
can use the <see cref="M:Tao.Platform.Windows.Winmm.timeBeginPeriod(System.Int32)"/> and <see cref="M:Tao.Platform.Windows.Winmm.timeEndPeriod(System.Int32)"/>
2449
functions to increase the precision of <b>timeGetTime</b>. If you do so, the
2450
minimum difference between successive values returned by <b>timeGetTime</b>
2451
can be as large as the minimum period value set using
2452
<see cref="M:Tao.Platform.Windows.Winmm.timeBeginPeriod(System.Int32)"/> and <see cref="M:Tao.Platform.Windows.Winmm.timeEndPeriod(System.Int32)"/>. Use the
2453
<see cref="M:Tao.Platform.Windows.Kernel.QueryPerformanceCounter(System.Int64@)"/> and
2454
<see cref="M:Tao.Platform.Windows.Kernel.QueryPerformanceFrequency(System.Int64@)"/> functions to measure short
2455
time intervals at a high resolution.
2456
</para>
2457
<para>
2458
<b>Windows 95:</b> The default precision of the <b>timeGetTime</b> function is
2459
1 millisecond. In other words, the <b>timeGetTime</b> function can return
2460
successive values that differ by just 1 millisecond. This is true no matter
2461
what calls have been made to the <b>timeBeginPeriod</b> and
2462
<b>timeEndPeriod</b> functions.
2463
</para>
2464
</remarks>
2465
<seealso cref="M:Tao.Platform.Windows.Kernel.QueryPerformanceCounter(System.Int64@)"/>
2466
<seealso cref="M:Tao.Platform.Windows.Kernel.QueryPerformanceFrequency(System.Int64@)"/>
2467
<seealso cref="M:Tao.Platform.Windows.Winmm.timeBeginPeriod(System.Int32)"/>
2468
<seealso cref="M:Tao.Platform.Windows.Winmm.timeEndPeriod(System.Int32)"/>
2469
</member>
2470
<member name="M:Tao.Platform.Windows.Winmm.joyConfigChanged(System.Int64)">
2471
<summary>
2472
The joyConfigChanged function informs the joystick driver that the configuration has changed and should be reloaded from the registry.
2473
</summary>
2474
<param name="dwFlags">
2475
Reserved for future use. Must equal zero.
2476
</param>
2477
<returns>
2478
Returns JOYERR_NOERROR if successful. Returns JOYERR_PARMS if the parameter is non-zero.
2479
</returns>
2480
<remarks>
2481
<para>
2482
This function causes a window message to be sent to all top-level windows. This message may be defined by applications that need to respond to changes in joystick calibration by using RegisterWindowMessage with the following message ID:
2483
</para>
2484
<code>
2485
#define JOY_CONFIGCHANGED_MSGSTRING "MSJSTICK_VJOYD_MSGSTR"
2486
</code>
2487
</remarks>
2488
</member>
2489
<member name="M:Tao.Platform.Windows.Winmm.joyGetDevCaps(System.IntPtr,Tao.Platform.Windows.Winmm.JOYCAPS@,System.Int32)">
2490
<summary>
2491
The joyGetDevCaps function queries a joystick to determine its capabilities.
2492
</summary>
2493
<param name="uJoyID">
2494
Identifier of the joystick to be queried. Valid values for uJoyID range from -1 to 15. A value of -1 enables retrieval of the szRegKey member of the JOYCAPS structure whether a device is present or not. For Windows NT 4.0, valid values are limited to zero (JOYSTICKID1) and JOYSTICKID2.
2495
</param>
2496
<param name="pjc">
2497
Pointer to a <see cref="T:Tao.Platform.Windows.Winmm.JOYCAPS"/> structure to contain the capabilities of the joystick.
2498
</param>
2499
<param name="cbjc">
2500
Size, in bytes, of the JOYCAPS structure.
2501
</param>
2502
<returns>
2503
<para>
2504
Returns JOYERR_NOERROR if successful or one of the following error values:
2505
</para>
2506
<para>
2507
<see cref="F:Tao.Platform.Windows.Winmm.MMSYSERR_NODRIVER"/> - The joystick driver is not present. Windows NT/2000/XP: The specified joystick identifier is invalid.
2508
<see cref="F:Tao.Platform.Windows.Winmm.MMSYSERR_INVALPARAM"/> - An invalid parameter was passed. Windows 95/98/Me: The specified joystick identifier is invalid.
2509
</para>
2510
</returns>
2511
<remarks>
2512
<para>
2513
Use the <see cref="M:Tao.Platform.Windows.Winmm.joyGetNumDevs"/> function to determine the number of joystick devices supported by the driver.
2514
</para>
2515
<para>
2516
Windows NT/2000/XP: This method fails when passed an invalid value for the cbjc parameter.
2517
Windows 95/98/Me: This method succeeds when passed an invalid value for the cbjc parameter.
2518
</para>
2519
</remarks>
2520
<seealso cref="T:Tao.Platform.Windows.Winmm.JOYCAPS"/>
2521
<seealso cref="M:Tao.Platform.Windows.Winmm.joyGetNumDevs"/>
2522
</member>
2523
<member name="M:Tao.Platform.Windows.Winmm.joyGetNumDevs">
2524
<summary>
2525
The joyGetNumDevs function queries the joystick driver for the number of joysticks it supports.
2526
</summary>
2527
<returns>
2528
The joyGetNumDevs function returns the number of joysticks supported by the current driver or zero if no driver is installed.
2529
</returns>
2530
<remarks>
2531
<para>
2532
Use the <see cref="M:Tao.Platform.Windows.Winmm.joyGetPos(System.Int32,Tao.Platform.Windows.Winmm.JOYINFO@)"/> function to determine whether a given joystick is physically attached to the system. If the specified joystick is not connected, joyGetPos returns a <see cref="F:Tao.Platform.Windows.Winmm.JOYERR_UNPLUGGED"/> error value.
2533
</para>
2534
</remarks>
2535
</member>
2536
<member name="M:Tao.Platform.Windows.Winmm.joyGetPos(System.Int32,Tao.Platform.Windows.Winmm.JOYINFO@)">
2537
<summary>
2538
The joyGetPos function queries a joystick for its position and button status.
2539
</summary>
2540
<param name="uJoyID">
2541
Identifier of the joystick to be queried. Valid values for uJoyID range from zero (<see cref="F:Tao.Platform.Windows.Winmm.JOYSTICKID1"/>) to 15, except for Windows NT 4.0. For Windows NT 4.0, valid values are limited to <see cref="F:Tao.Platform.Windows.Winmm.JOYSTICKID1"/> and <see cref="F:Tao.Platform.Windows.Winmm.JOYSTICKID2"/>.
2542
</param>
2543
<param name="pji">
2544
Pointer to a <see cref="T:Tao.Platform.Windows.Winmm.JOYINFO"/> structure that contains the position and button status of the joystick.
2545
</param>
2546
<returns>
2547
Returns <see cref="F:Tao.Platform.Windows.Winmm.JOYERR_NOERROR"/> if successful or one of the following error values.
2548
<para>
2549
<see cref="F:Tao.Platform.Windows.Winmm.MMSYSERR_NODRIVER"/> - The joystick driver is not present.
2550
<see cref="F:Tao.Platform.Windows.Winmm.MMSYSERR_INVALPARAM"/> - An invalid parameter was passed.
2551
<see cref="F:Tao.Platform.Windows.Winmm.JOYERR_UNPLUGGED"/> - The specified joystick is not connected to the system.
2552
</para>
2553
</returns>
2554
<remarks>
2555
For devices that have four to six axes of movement, a point-of-view control, or more than four buttons, use the <see cref="M:Tao.Platform.Windows.Winmm.joyGetPosEx(System.Int32,Tao.Platform.Windows.Winmm.JOYINFOEX@)"/> function.
2556
</remarks>
2557
</member>
2558
<member name="M:Tao.Platform.Windows.Winmm.joyGetPosEx(System.Int32,Tao.Platform.Windows.Winmm.JOYINFOEX@)">
2559
<summary>
2560
The joyGetPosEx function queries a joystick for its position and button status.
2561
</summary>
2562
<param name="uJoyID">
2563
Identifier of the joystick to be queried. Valid values for uJoyID range from zero (<see cref="F:Tao.Platform.Windows.Winmm.JOYSTICKID1"/>) to 15, except for Windows NT 4.0. For Windows NT 4.0, valid values are limited to <see cref="F:Tao.Platform.Windows.Winmm.JOYSTICKID1"/> and <see cref="F:Tao.Platform.Windows.Winmm.JOYSTICKID2"/>.
2564
</param>
2565
<param name="pji">
2566
Pointer to a <see cref="T:Tao.Platform.Windows.Winmm.JOYINFOEX"/> structure that contains extended position information and button status of the joystick. You must set the dwSize and dwFlags members or joyGetPosEx will fail. The information returned from joyGetPosEx depends on the flags you specify in dwFlags.
2567
</param>
2568
<returns>
2569
Returns JOYERR_NOERROR if successful or one of the following error values.
2570
<para>
2571
Returns JOYERR_NOERROR if successful or one of the following error values.
2572
</para>
2573
<para>
2574
<see cref="F:Tao.Platform.Windows.Winmm.MMSYSERR_NODRIVER"/> - The joystick driver is not present.
2575
<see cref="F:Tao.Platform.Windows.Winmm.MMSYSERR_INVALPARAM"/> - An invalid parameter was passed. Windows 95/98/Me: The specified joystick identifier is invalid.
2576
<see cref="F:Tao.Platform.Windows.Winmm.MMSYSERR_BADDEVICEID"/> - Windows 95/98/Me: The specified joystick identifier is invalid.
2577
<see cref="F:Tao.Platform.Windows.Winmm.JOYERR_UNPLUGGED"/> - The specified joystick is not connected to the system.
2578
<see cref="F:Tao.Platform.Windows.Winmm.JOYERR_PARMS"/> - Windows NT/2000/XP: The specified joystick identifier is invalid.
2579
</para>
2580
</returns>
2581
<remarks>
2582
This function provides access to extended devices such as rudder pedals, point-of-view hats, devices with a large number of buttons, and coordinate systems using up to six axes. For joystick devices that use three axes or fewer and have fewer than four buttons, use the joyGetPos function.
2583
</remarks>
2584
</member>
2585
<member name="M:Tao.Platform.Windows.Winmm.joyGetThreshold(System.Int32,System.IntPtr)">
2586
<summary>
2587
The joyGetThreshold function queries a joystick for its current movement threshold.
2588
</summary>
2589
<param name="uJoyID">
2590
Identifier of the joystick. Valid values for uJoyID range from zero (<see cref="F:Tao.Platform.Windows.Winmm.JOYSTICKID1"/>) to 15, except for Windows NT 4.0. For Windows NT 4.0, valid values are limited to <see cref="F:Tao.Platform.Windows.Winmm.JOYSTICKID1"/> and <see cref="F:Tao.Platform.Windows.Winmm.JOYSTICKID2"/>.
2591
</param>
2592
<param name="puThreshold">
2593
Pointer to a variable that contains the movement threshold value.
2594
</param>
2595
<returns>
2596
<para>
2597
Returns JOYERR_NOERROR if successful or one of the following error values.
2598
</para>
2599
<para>
2600
<see cref="F:Tao.Platform.Windows.Winmm.MMSYSERR_NODRIVER"/> - The joystick driver is not present.
2601
<see cref="F:Tao.Platform.Windows.Winmm.MMSYSERR_INVALPARAM"/> - An invalid parameter was passed.
2602
</para>
2603
</returns>
2604
<remarks>
2605
The movement threshold is the distance the joystick must be moved before a joystick position-change message (<see cref="F:Tao.Platform.Windows.Winmm.MM_JOY1MOVE"/>, <see cref="F:Tao.Platform.Windows.Winmm.MM_JOY1ZMOVE"/>, <see cref="F:Tao.Platform.Windows.Winmm.MM_JOY2MOVE"/>, or <see cref="F:Tao.Platform.Windows.Winmm.MM_JOY2ZMOVE"/>) is sent to a window that has captured the device. The threshold is initially zero.
2606
</remarks>
2607
</member>
2608
<member name="M:Tao.Platform.Windows.Winmm.joyReleaseCapture(System.Int32)">
2609
<summary>
2610
The joyReleaseCapture function releases the specified captured joystick.
2611
</summary>
2612
<param name="uJoyID">
2613
Identifier of the joystick. Valid values for uJoyID range from zero (<see cref="F:Tao.Platform.Windows.Winmm.JOYSTICKID1"/>) to 15, except for Windows NT 4.0. For Windows NT 4.0, valid values are limited to <see cref="F:Tao.Platform.Windows.Winmm.JOYSTICKID1"/> and <see cref="F:Tao.Platform.Windows.Winmm.JOYSTICKID2"/>.
2614
</param>
2615
<returns>
2616
<para>
2617
Returns <see cref="F:Tao.Platform.Windows.Winmm.JOYERR_NOERROR"/> if successful or one of the following error values.
2618
</para>
2619
<para>
2620
<see cref="F:Tao.Platform.Windows.Winmm.MMSYSERR_NODRIVER"/> - The joystick driver is not present.
2621
<see cref="F:Tao.Platform.Windows.Winmm.MMSYSERR_INVALPARAM"/> - Windows 95/98/Me: The specified joystick device identifier uJoyID is invalid. Windows NT/2000/XP: The specified joystick identifier is valid, but the joystick has not been captured.
2622
<see cref="F:Tao.Platform.Windows.Winmm.JOYERR_PARMS"/> - Windows NT/2000/XP: The specified joystick device identifier uJoyID is invalid.
2623
</para>
2624
</returns>
2625
<remarks>
2626
Windows 95/98/Me: This method returns JOYERR_NOERROR when passed a valid joystick identifier that has not been captured.
2627
</remarks>
2628
</member>
2629
<member name="M:Tao.Platform.Windows.Winmm.joySetCapture(System.Int32,System.Int32,System.Int32,System.Boolean)">
2630
<summary>
2631
The joySetCature function captures a joystick by causing its messages to be sent to the specified window.
2632
</summary>
2633
<param name="hwnd">
2634
Handle to the window to receive the joystick messages.
2635
</param>
2636
<param name="uJoyID">
2637
Identifier of the joystick. Valid values for uJoyID range from zero (<see cref="F:Tao.Platform.Windows.Winmm.JOYSTICKID1"/>) to 15, except for Windows NT 4.0. For Windows NT 4.0, valid values are limited to <see cref="F:Tao.Platform.Windows.Winmm.JOYSTICKID1"/> and <see cref="F:Tao.Platform.Windows.Winmm.JOYSTICKID2"/>.
2638
</param>
2639
<param name="uPeriod">
2640
Polling frequency, in milliseconds.
2641
</param>
2642
<param name="fChanged">
2643
Change position flag. Specify TRUE for this parameter to send messages only when the position changes by a value greater than the joystick movement threshold. Otherwise, messages are sent at the polling frequency specified in uPeriod.
2644
</param>
2645
<returns>
2646
<para>
2647
Returns JOYERR_NOERROR if successful or one of the following error values.
2648
</para>
2649
<para>
2650
<see cref="F:Tao.Platform.Windows.Winmm.MMSYSERR_NODRIVER"/> - The joystick driver is not present.
2651
<see cref="F:Tao.Platform.Windows.Winmm.MMSYSERR_INVALPARAM"/> - Windows 95/98/Me: Invalid joystick ID or hwnd is NULL.
2652
<see cref="F:Tao.Platform.Windows.Winmm.JOYERR_NOCANDO"/> - Cannot capture joystick input because a required service (such as a Windows timer) is unavailable.
2653
<see cref="F:Tao.Platform.Windows.Winmm.JOYERR_UNPLUGGED"/> - The specified joystick is not connected to the system.
2654
<see cref="F:Tao.Platform.Windows.Winmm.JOYERR_PARMS"/> - Windows NT/2000/XP: Invalid joystick ID or hwnd is NULL.
2655
</para>
2656
</returns>
2657
<remarks>
2658
This function fails if the specified joystick is currently captured. Call the joyReleaseCapture function to release the captured joystick, or destroy the window to release the joystick automatically.
2659
</remarks>
2660
</member>
2661
<member name="M:Tao.Platform.Windows.Winmm.joySetThreshold(System.Int32,System.Int32)">
2662
<summary>
2663
The joySetThreshold function sets the movement threshold of a joystick.
2664
</summary>
2665
<param name="uJoyID">
2666
Identifier of the joystick. Valid values for uJoyID range from zero (<see cref="F:Tao.Platform.Windows.Winmm.JOYSTICKID1"/>) to 15, except for Windows NT 4.0. For Windows NT 4.0, valid values are limited to <see cref="F:Tao.Platform.Windows.Winmm.JOYSTICKID1"/> and <see cref="F:Tao.Platform.Windows.Winmm.JOYSTICKID2"/>.
2667
</param>
2668
<param name="uThreshold">
2669
New movement threshold.
2670
</param>
2671
<returns>
2672
<para>
2673
Returns JOYERR_NOERROR if successful or one of the following error values.
2674
</para>
2675
<para>
2676
<see cref="F:Tao.Platform.Windows.Winmm.MMSYSERR_NODRIVER"/> - The joystick driver is not present.
2677
<see cref="F:Tao.Platform.Windows.Winmm.JOYERR_PARMS"/> - The specified joystick device identifier uJoyID is invalid.
2678
</para>
2679
</returns>
2680
<remarks>
2681
The movement threshold is the distance the joystick must be moved before a joystick position-change message (<see cref="F:Tao.Platform.Windows.Winmm.MM_JOY1MOVE"/>, <see cref="F:Tao.Platform.Windows.Winmm.MM_JOY1ZMOVE"/>, <see cref="F:Tao.Platform.Windows.Winmm.MM_JOY2MOVE"/>, or <see cref="F:Tao.Platform.Windows.Winmm.MM_JOY2ZMOVE"/>) is sent to a window that has captured the device. The threshold is initially zero.
2682
</remarks>
2683
</member>
2684
<member name="T:Tao.Platform.Windows.Winmm.JOYCAPS">
2685
<summary>
2686
The JOYCAPS structure contains information about the joystick capabilities.
2687
</summary>
2688
<remarks>
2689
<para>
2690
<b>Requirements</b>
2691
</para>
2692
<para>
2693
Windows NT/2000/XP: Included in Windows NT 3.1 and later.
2694
Windows 95/98/Me: Included in Windows 95 and later.
2695
Header: Declared in Mmsystem.h; include Windows.h.
2696
Unicode: Declared as Unicode and ANSI structures.
2697
</para>
2698
</remarks>
2699
<seealso cref="T:Tao.Platform.Windows.Winmm.JOYINFO"/>
2700
<seealso cref="T:Tao.Platform.Windows.Winmm.JOYINFOEX"/>
2701
<seealso cref="M:Tao.Platform.Windows.Winmm.joySetCapture(System.Int32,System.Int32,System.Int32,System.Boolean)"/>
2702
</member>
2703
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.wMid">
2704
<summary>
2705
Manufacturer identifier. Manufacturer identifiers are defined in Manufacturer and Product Identifiers.
2706
</summary>
2707
</member>
2708
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.wPid">
2709
<summary>
2710
Product identifier. Product identifiers are defined in Manufacturer and Product Identifiers.
2711
</summary>
2712
</member>
2713
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.szPname">
2714
<summary>
2715
Null-terminated string containing the joystick product name.
2716
</summary>
2717
</member>
2718
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.wXmin">
2719
<summary>
2720
Minimum X-coordinate.
2721
</summary>
2722
</member>
2723
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.wXmax">
2724
<summary>
2725
Maximum X-coordinate.
2726
</summary>
2727
</member>
2728
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.wYmin">
2729
<summary>
2730
Minimum Y-coordinate.
2731
</summary>
2732
</member>
2733
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.wYmax">
2734
<summary>
2735
Maximum Y-coordinate.
2736
</summary>
2737
</member>
2738
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.wZmin">
2739
<summary>
2740
Minimum Z-coordinate.
2741
</summary>
2742
</member>
2743
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.wZmax">
2744
<summary>
2745
Maximum Z-coordinate.
2746
</summary>
2747
</member>
2748
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.wNumButtons">
2749
<summary>
2750
Number of joystick buttons.
2751
</summary>
2752
</member>
2753
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.wPeriodMin">
2754
<summary>
2755
Smallest polling frequency supported when captured by the <see cref="M:Tao.Platform.Windows.Winmm.joySetCapture(System.Int32,System.Int32,System.Int32,System.Boolean)"/> function.
2756
</summary>
2757
</member>
2758
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.wPeriodMax">
2759
<summary>
2760
Largest polling frequency supported when captured by <see cref="M:Tao.Platform.Windows.Winmm.joySetCapture(System.Int32,System.Int32,System.Int32,System.Boolean)"/>.
2761
</summary>
2762
</member>
2763
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.wRmin">
2764
<summary>
2765
Minimum rudder value. The rudder is a fourth axis of movement.
2766
</summary>
2767
</member>
2768
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.wRmax">
2769
<summary>
2770
Maximum rudder value. The rudder is a fourth axis of movement.
2771
</summary>
2772
</member>
2773
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.wUmin">
2774
<summary>
2775
Minimum u-coordinate (fifth axis) values.
2776
</summary>
2777
</member>
2778
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.wUmax">
2779
<summary>
2780
Maximum u-coordinate (fifth axis) values.
2781
</summary>
2782
</member>
2783
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.wVmin">
2784
<summary>
2785
Minimum v-coordinate (sixth axis) values.
2786
</summary>
2787
</member>
2788
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.wVmax">
2789
<summary>
2790
Maximum v-coordinate (sixth axis) values.
2791
</summary>
2792
</member>
2793
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.wCaps">
2794
<summary>
2795
Joystick capabilities The following flags define individual capabilities that a joystick might have:
2796
</summary>
2797
<remarks>
2798
<see cref="F:Tao.Platform.Windows.Winmm.JOYCAPS_HASZ"/> - Joystick has z-coordinate information.
2799
<see cref="F:Tao.Platform.Windows.Winmm.JOYCAPS_HASR"/> - Joystick has rudder (fourth axis) information.
2800
<see cref="F:Tao.Platform.Windows.Winmm.JOYCAPS_HASU"/> - Joystick has u-coordinate (fifth axis) information.
2801
<see cref="F:Tao.Platform.Windows.Winmm.JOYCAPS_HASV"/> - Joystick has v-coordinate (sixth axis) information.
2802
<see cref="F:Tao.Platform.Windows.Winmm.JOYCAPS_HASPOV"/> - Joystick has point-of-view information.
2803
<see cref="F:Tao.Platform.Windows.Winmm.JOYCAPS_POV4DIR"/> - Joystick point-of-view supports discrete values (centered, forward, backward, left, and right).
2804
<see cref="F:Tao.Platform.Windows.Winmm.JOYCAPS_POVCTS"/> - Joystick point-of-view supports continuous degree bearings.
2805
</remarks>
2806
</member>
2807
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.wMaxAxes">
2808
<summary>
2809
Maximum number of axes supported by the joystick.
2810
</summary>
2811
</member>
2812
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.wNumAxes">
2813
<summary>
2814
Number of axes currently in use by the joystick.
2815
</summary>
2816
</member>
2817
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.wMaxButtons">
2818
<summary>
2819
Maximum number of buttons supported by the joystick.
2820
</summary>
2821
</member>
2822
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.szRegKey">
2823
<summary>
2824
Null-terminated string containing the registry key for the joystick.
2825
</summary>
2826
</member>
2827
<member name="F:Tao.Platform.Windows.Winmm.JOYCAPS.szOEMVxD">
2828
<summary>
2829
Null-terminated string identifying the joystick driver OEM.
2830
</summary>
2831
</member>
2832
<member name="T:Tao.Platform.Windows.Winmm.JOYINFO">
2833
<summary>
2834
The JOYINFO structure contains information about the joystick position and button state.
2835
</summary>
2836
<remarks>
2837
<para>
2838
<b>Requirements</b>
2839
</para>
2840
<para>
2841
Windows NT/2000/XP: Included in Windows NT 3.1 and later.
2842
Windows 95/98/Me: Included in Windows 95 and later.
2843
Header: Declared in Mmsystem.h; include Windows.h.
2844
</para>
2845
</remarks>
2846
</member>
2847
<member name="F:Tao.Platform.Windows.Winmm.JOYINFO.wXpos">
2848
<summary>
2849
Current X-coordinate.
2850
</summary>
2851
</member>
2852
<member name="F:Tao.Platform.Windows.Winmm.JOYINFO.wYpos">
2853
<summary>
2854
Current Y-coordinate.
2855
</summary>
2856
</member>
2857
<member name="F:Tao.Platform.Windows.Winmm.JOYINFO.wZpos">
2858
<summary>
2859
Current Z-coordinate.
2860
</summary>
2861
</member>
2862
<member name="F:Tao.Platform.Windows.Winmm.JOYINFO.wButtons">
2863
<summary>
2864
Current state of joystick buttons.
2865
</summary>
2866
<remarks>
2867
<para>According to one or more of the following values:</para>
2868
<para>
2869
<see cref="F:Tao.Platform.Windows.Winmm.JOY_BUTTON1"/> - First joystick button is pressed.
2870
<see cref="F:Tao.Platform.Windows.Winmm.JOY_BUTTON2"/> - Second joystick button is pressed.
2871
<see cref="F:Tao.Platform.Windows.Winmm.JOY_BUTTON3"/> - Third joystick button is pressed.
2872
<see cref="F:Tao.Platform.Windows.Winmm.JOY_BUTTON4"/> - Fourth joystick button is pressed.
2873
</para>
2874
</remarks>
2875
</member>
2876
<member name="T:Tao.Platform.Windows.Winmm.JOYINFOEX">
2877
<summary>
2878
The JOYINFOEX structure contains extended information about the joystick position, point-of-view position, and button state.
2879
</summary>
2880
<remarks>
2881
<para>
2882
The value of the dwSize member is also used to identify the version number for the structure when it's passed to the <see cref="M:Tao.Platform.Windows.Winmm.joyGetPosEx(System.Int32,Tao.Platform.Windows.Winmm.JOYINFOEX@)"/> function.
2883
</para>
2884
<para>
2885
Most devices with a point-of-view control have only five positions. When the JOY_RETURNPOV flag is set, these positions are reported by using the following constants:
2886
</para>
2887
<para>
2888
<see cref="F:Tao.Platform.Windows.Winmm.JOY_POVBACKWARD"/> - Point-of-view hat is pressed backward. The value 18,000 represents an orientation of 180.00 degrees (to the rear).
2889
<see cref="F:Tao.Platform.Windows.Winmm.JOY_POVCENTERED"/> - Point-of-view hat is in the neutral position. The value -1 means the point-of-view hat has no angle to report.
2890
<see cref="F:Tao.Platform.Windows.Winmm.JOY_POVFORWARD"/> - Point-of-view hat is pressed forward. The value 0 represents an orientation of 0.00 degrees (straight ahead).
2891
<see cref="F:Tao.Platform.Windows.Winmm.JOY_POVLEFT"/> - Point-of-view hat is being pressed to the left. The value 27,000 represents an orientation of 270.00 degrees (90.00 degrees to the left).
2892
<see cref="F:Tao.Platform.Windows.Winmm.JOY_POVRIGHT"/> - Point-of-view hat is pressed to the right. The value 9,000 represents an orientation of 90.00 degrees (to the right).
2893
</para>
2894
<para>
2895
The default joystick driver currently supports these five discrete directions. If an application can accept only the defined point-of-view values, it must use the JOY_RETURNPOV flag. If an application can accept other degree readings, it should use the JOY_RETURNPOVCTS flag to obtain continuous data if it is available. The JOY_RETURNPOVCTS flag also supports the JOY_POV constants used with the JOY_RETURNPOV flag.
2896
</para>
2897
</remarks>
2898
<seealso cref="M:Tao.Platform.Windows.Winmm.joyGetPosEx(System.Int32,Tao.Platform.Windows.Winmm.JOYINFOEX@)"/>
2899
</member>
2900
<member name="F:Tao.Platform.Windows.Winmm.JOYINFOEX.dwSize">
2901
<summary>
2902
Size, in bytes, of this structure.
2903
</summary>
2904
</member>
2905
<member name="F:Tao.Platform.Windows.Winmm.JOYINFOEX.dwFlags">
2906
<summary>
2907
Flags indicating the valid information returned in this structure. Members that do not contain valid information are set to zero.
2908
</summary>
2909
<remarks>
2910
<para>
2911
<see cref="F:Tao.Platform.Windows.Winmm.JOY_RETURNALL"/> - Equivalent to setting all of the JOY_RETURN bits except JOY_RETURNRAWDATA.
2912
<see cref="F:Tao.Platform.Windows.Winmm.JOY_RETURNBUTTONS"/> - The dwButtons member contains valid information about the state of each joystick button.
2913
<see cref="F:Tao.Platform.Windows.Winmm.JOY_RETURNCENTERED"/> - Centers the joystick neutral position to the middle value of each axis of movement.
2914
<see cref="F:Tao.Platform.Windows.Winmm.JOY_RETURNPOV"/> - The dwPOV member contains valid information about the point-of-view control, expressed in discrete units.
2915
<see cref="F:Tao.Platform.Windows.Winmm.JOY_RETURNPOVCTS"/> - The dwPOV member contains valid information about the point-of-view control expressed in continuous, one-hundredth degree units.
2916
<see cref="F:Tao.Platform.Windows.Winmm.JOY_RETURNR"/> - The dwRpos member contains valid rudder pedal data. This information represents another (fourth) axis.
2917
<see cref="F:Tao.Platform.Windows.Winmm.JOY_RETURNRAWDATA"/> - Data stored in this structure is uncalibrated joystick readings.
2918
<see cref="F:Tao.Platform.Windows.Winmm.JOY_RETURNU"/> - The dwUpos member contains valid data for a fifth axis of the joystick, if such an axis is available, or returns zero otherwise.
2919
<see cref="F:Tao.Platform.Windows.Winmm.JOY_RETURNV"/> - The dwVpos member contains valid data for a sixth axis of the joystick, if such an axis is available, or returns zero otherwise.
2920
<see cref="F:Tao.Platform.Windows.Winmm.JOY_RETURNX"/> - The dwXpos member contains valid data for the x-coordinate of the joystick.
2921
<see cref="F:Tao.Platform.Windows.Winmm.JOY_RETURNY"/> - The dwYpos member contains valid data for the y-coordinate of the joystick.
2922
<see cref="F:Tao.Platform.Windows.Winmm.JOY_RETURNZ"/> - The dwZpos member contains valid data for the z-coordinate of the joystick.
2923
<see cref="F:Tao.Platform.Windows.Winmm.JOY_USEDEADZONE"/> - Expands the range for the neutral position of the joystick and calls this range the dead zone. The joystick driver returns a constant value for all positions in the dead zone.
2924
</para>
2925
<para>
2926
The following flags provide data to calibrate a joystick and are intended for custom calibration applications.
2927
</para>
2928
<para>
2929
<see cref="F:Tao.Platform.Windows.Winmm.JOY_CAL_READ3"/> - Read the x-, y-, and z-coordinates and store the raw values in dwXpos, dwYpos, and dwZpos.
2930
<see cref="F:Tao.Platform.Windows.Winmm.JOY_CAL_READ4"/> - Read the rudder information and the x-, y-, and z-coordinates and store the raw values in dwXpos, dwYpos, dwZpos, and dwRpos.
2931
<see cref="F:Tao.Platform.Windows.Winmm.JOY_CAL_READ5"/> - Read the rudder information and the x-, y-, z-, and u-coordinates and store the raw values in dwXpos, dwYpos, dwZpos, dwRpos, and dwUpos.
2932
<see cref="F:Tao.Platform.Windows.Winmm.JOY_CAL_READ6"/> - Read the raw v-axis data if a joystick mini driver is present that will provide the data. Returns zero otherwise.
2933
<see cref="F:Tao.Platform.Windows.Winmm.JOY_CAL_READALWAYS"/> - Read the joystick port even if the driver does not detect a device.
2934
<see cref="F:Tao.Platform.Windows.Winmm.JOY_CAL_READRONLY"/> - Read the rudder information if a joystick mini-driver is present that will provide the data and store the raw value in dwRpos. Return zero otherwise.
2935
<see cref="F:Tao.Platform.Windows.Winmm.JOY_CAL_READXONLY"/> - Read the x-coordinate and store the raw (uncalibrated) value in dwXpos.
2936
<see cref="F:Tao.Platform.Windows.Winmm.JOY_CAL_READXYONLY"/> - Reads the x- and y-coordinates and place the raw values in dwXpos and dwYpos.
2937
<see cref="F:Tao.Platform.Windows.Winmm.JOY_CAL_READYONLY"/> - Reads the y-coordinate and store the raw value in dwYpos.
2938
<see cref="F:Tao.Platform.Windows.Winmm.JOY_CAL_READZONLY"/> - Read the z-coordinate and store the raw value in dwZpos.
2939
<see cref="F:Tao.Platform.Windows.Winmm.JOY_CAL_READUONLY"/> - Read the u-coordinate if a joystick mini-driver is present that will provide the data and store the raw value in dwUpos. Return zero otherwise.
2940
<see cref="F:Tao.Platform.Windows.Winmm.JOY_CAL_READVONLY"/> - Read the v-coordinate if a joystick mini-driver is present that will provide the data and store the raw value in dwVpos. Return zero otherwise.
2941
</para>
2942
</remarks>
2943
</member>
2944
<member name="F:Tao.Platform.Windows.Winmm.JOYINFOEX.dwXpos">
2945
<summary>
2946
Current X-coordinate.
2947
</summary>
2948
</member>
2949
<member name="F:Tao.Platform.Windows.Winmm.JOYINFOEX.dwYpos">
2950
<summary>
2951
Current Y-coordinate.
2952
</summary>
2953
</member>
2954
<member name="F:Tao.Platform.Windows.Winmm.JOYINFOEX.dwZpos">
2955
<summary>
2956
Current Z-coordinate.
2957
</summary>
2958
</member>
2959
<member name="F:Tao.Platform.Windows.Winmm.JOYINFOEX.dwRpos">
2960
<summary>
2961
Current position of the rudder or fourth joystick axis.
2962
</summary>
2963
</member>
2964
<member name="F:Tao.Platform.Windows.Winmm.JOYINFOEX.dwUpos">
2965
<summary>
2966
Current fifth axis position.
2967
</summary>
2968
</member>
2969
<member name="F:Tao.Platform.Windows.Winmm.JOYINFOEX.dwVpos">
2970
<summary>
2971
Current sixth axis position.
2972
</summary>
2973
</member>
2974
<member name="F:Tao.Platform.Windows.Winmm.JOYINFOEX.dwButtons">
2975
<summary>
2976
Current state of the 32 joystick buttons. The value of this member can be set to any combination of JOY_BUTTONn flags, where n is a value in the range of 1 through 32 corresponding to the button that is pressed.
2977
</summary>
2978
</member>
2979
<member name="F:Tao.Platform.Windows.Winmm.JOYINFOEX.dwButtonNumber">
2980
<summary>
2981
Current button number that is pressed.
2982
</summary>
2983
</member>
2984
<member name="F:Tao.Platform.Windows.Winmm.JOYINFOEX.dwPOV">
2985
<summary>
2986
Current position of the point-of-view control. Values for this member are in the range 0 through 35,900. These values represent the angle, in degrees, of each view multiplied by 100.
2987
</summary>
2988
</member>
2989
<member name="F:Tao.Platform.Windows.Winmm.JOYINFOEX.dwReserved1">
2990
<summary>
2991
Reserved; do not use.
2992
</summary>
2993
</member>
2994
<member name="F:Tao.Platform.Windows.Winmm.JOYINFOEX.dwReserved2">
2995
<summary>
2996
Reserved; do not use.
2997
</summary>
2998
</member>
2999
<member name="T:Tao.Platform.Windows.User">
3000
<summary>
3001
User binding for .NET, implementing Windows-specific user functionality.
3002
</summary>
3003
<remarks>
3004
Binds functions and definitions in user32.dll.
3005
</remarks>
3006
</member>
3007
<member name="F:Tao.Platform.Windows.User.USER_NATIVE_LIBRARY">
3008
<summary>
3009
Specifies User32's native library archive.
3010
</summary>
3011
<remarks>
3012
Specifies user32.dll for Windows.
3013
</remarks>
3014
</member>
3015
<member name="F:Tao.Platform.Windows.User.CALLING_CONVENTION">
3016
<summary>
3017
Specifies the calling convention.
3018
</summary>
3019
<remarks>
3020
Specifies <see cref="F:System.Runtime.InteropServices.CallingConvention.StdCall"/>.
3021
</remarks>
3022
</member>
3023
<member name="F:Tao.Platform.Windows.User.CS_VREDRAW">
3024
<summary>
3025
3026
</summary>
3027
</member>
3028
<member name="F:Tao.Platform.Windows.User.CS_HREDRAW">
3029
<summary>
3030
3031
</summary>
3032
</member>
3033
<member name="F:Tao.Platform.Windows.User.CS_DBLCLKS">
3034
<summary>
3035
3036
</summary>
3037
</member>
3038
<member name="F:Tao.Platform.Windows.User.CS_OWNDC">
3039
<summary>
3040
3041
</summary>
3042
</member>
3043
<member name="F:Tao.Platform.Windows.User.CS_CLASSDC">
3044
<summary>
3045
3046
</summary>
3047
</member>
3048
<member name="F:Tao.Platform.Windows.User.CS_PARENTDC">
3049
<summary>
3050
3051
</summary>
3052
</member>
3053
<member name="F:Tao.Platform.Windows.User.CS_NOCLOSE">
3054
<summary>
3055
3056
</summary>
3057
</member>
3058
<member name="F:Tao.Platform.Windows.User.CS_SAVEBITS">
3059
<summary>
3060
3061
</summary>
3062
</member>
3063
<member name="F:Tao.Platform.Windows.User.CS_BYTEALIGNCLIENT">
3064
<summary>
3065
3066
</summary>
3067
</member>
3068
<member name="F:Tao.Platform.Windows.User.CS_BYTEALIGNWINDOW">
3069
<summary>
3070
3071
</summary>
3072
</member>
3073
<member name="F:Tao.Platform.Windows.User.CS_GLOBALCLASS">
3074
<summary>
3075
3076
</summary>
3077
</member>
3078
<member name="F:Tao.Platform.Windows.User.CS_IME">
3079
<summary>
3080
3081
</summary>
3082
</member>
3083
<member name="F:Tao.Platform.Windows.User.CS_DROPSHADOW">
3084
<summary>
3085
3086
</summary>
3087
</member>
3088
<member name="F:Tao.Platform.Windows.User.CDS_UPDATEREGISTRY">
3089
<summary>
3090
3091
</summary>
3092
</member>
3093
<member name="F:Tao.Platform.Windows.User.CDS_TEST">
3094
<summary>
3095
3096
</summary>
3097
</member>
3098
<member name="F:Tao.Platform.Windows.User.CDS_FULLSCREEN">
3099
<summary>
3100
3101
</summary>
3102
</member>
3103
<member name="F:Tao.Platform.Windows.User.DISP_CHANGE_SUCCESSFUL">
3104
<summary>
3105
3106
</summary>
3107
</member>
3108
<member name="F:Tao.Platform.Windows.User.DISP_CHANGE_RESTART">
3109
<summary>
3110
3111
</summary>
3112
</member>
3113
<member name="F:Tao.Platform.Windows.User.DISP_CHANGE_FAILED">
3114
<summary>
3115
3116
</summary>
3117
</member>
3118
<member name="F:Tao.Platform.Windows.User.ENUM_CURRENT_SETTINGS">
3119
<summary>
3120
3121
</summary>
3122
</member>
3123
<member name="M:Tao.Platform.Windows.User.ChangeDisplaySettings(Tao.Platform.Windows.Gdi.DEVMODE@,System.Int32)">
3124
<summary>
3125
<para>
3126
The <b>ChangeDisplaySettings</b> function changes the settings of the default
3127
display device to the specified graphics mode.
3128
</para>
3129
<para>
3130
To change the settings of a specified display device, use the
3131
<b>ChangeDisplaySettingsEx</b> function.
3132
</para>
3133
</summary>
3134
<param name="devMode">
3135
<para>
3136
Pointer to a <see cref="T:Tao.Platform.Windows.Gdi.DEVMODE"/> structure that describes the new
3137
graphics mode. If <i>devMode</i> is NULL, all the values currently in the
3138
registry will be used for the display setting. Passing NULL for the
3139
<i>devMode</i> parameter and 0 for the <i>flags</i> parameter is the easiest
3140
way to return to the default mode after a dynamic mode change.
3141
</para>
3142
<para>
3143
The <see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmSize"/> member of <see cref="T:Tao.Platform.Windows.Gdi.DEVMODE"/>
3144
must be initialized to the size, in bytes, of the <see cref="T:Tao.Platform.Windows.Gdi.DEVMODE"/>
3145
structure. The <see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmDriverExtra"/> member of
3146
<see cref="T:Tao.Platform.Windows.Gdi.DEVMODE"/> must be initialized to indicate the number of bytes
3147
of private driver data following the <see cref="T:Tao.Platform.Windows.Gdi.DEVMODE"/> structure. In
3148
addition, you can use any or all of the following members of the
3149
<see cref="T:Tao.Platform.Windows.Gdi.DEVMODE"/> structure:
3150
</para>
3151
<para>
3152
<list type="table">
3153
<listheader>
3154
<term>Value</term>
3155
<description>Description</description>
3156
</listheader>
3157
<item>
3158
<term><see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmBitsPerPel"/></term>
3159
<description>Bits per pixel.</description>
3160
</item>
3161
<item>
3162
<term><see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmPelsWidth"/></term>
3163
<description>Pixel width.</description>
3164
</item>
3165
<item>
3166
<term><see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmPelsHeight"/></term>
3167
<description>Pixel height.</description>
3168
</item>
3169
<item>
3170
<term><see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmDisplayFlags"/></term>
3171
<description>Mode flags.</description>
3172
</item>
3173
<item>
3174
<term><see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmDisplayFrequency"/></term>
3175
<description>Mode frequency.</description>
3176
</item>
3177
<item>
3178
<term>dmPosition</term>
3179
<description>
3180
<b>Windows 98/Me, Windows 2000/XP:</b> Position of the device in
3181
a multimonitor configuration.
3182
</description>
3183
</item>
3184
</list>
3185
</para>
3186
<para>
3187
In addition to using one or more of the preceding <see cref="T:Tao.Platform.Windows.Gdi.DEVMODE"/>
3188
members, you must also set one or more of the following values in the
3189
<see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmFields"/> member to change the display setting:
3190
</para>
3191
<para>
3192
<list type="table">
3193
<listheader>
3194
<term>Value</term>
3195
<description>Description</description>
3196
</listheader>
3197
<item>
3198
<term><see cref="F:Tao.Platform.Windows.Gdi.DM_BITSPERPEL"/></term>
3199
<description>
3200
Use the <see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmBitsPerPel"/> value.
3201
</description>
3202
</item>
3203
<item>
3204
<term><see cref="F:Tao.Platform.Windows.Gdi.DM_PELSWIDTH"/></term>
3205
<description>
3206
Use the <see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmPelsWidth"/> value.
3207
</description>
3208
</item>
3209
<item>
3210
<term><see cref="F:Tao.Platform.Windows.Gdi.DM_PELSHEIGHT"/></term>
3211
<description>
3212
Use the <see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmPelsHeight"/> value.
3213
</description>
3214
</item>
3215
<item>
3216
<term><see cref="F:Tao.Platform.Windows.Gdi.DM_DISPLAYFLAGS"/></term>
3217
<description>
3218
Use the <see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmDisplayFlags"/> value.
3219
</description>
3220
</item>
3221
<item>
3222
<term><see cref="F:Tao.Platform.Windows.Gdi.DM_DISPLAYFREQUENCY"/></term>
3223
<description>
3224
Use the <see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmDisplayFrequency"/> value.
3225
</description>
3226
</item>
3227
<item>
3228
<term>see cref="Gdi.DM_POSITION" </term>
3229
<description>
3230
<b>Windows 98/Me, Windows 2000/XP:</b> Use the dmPosition value.
3231
</description>
3232
</item>
3233
</list>
3234
</para>
3235
</param>
3236
<param name="flags">
3237
<para>
3238
Indicates how the graphics mode should be changed. This parameter can be one
3239
of the following values:
3240
</para>
3241
<para>
3242
<list type="table">
3243
<listheader>
3244
<term>Value</term>
3245
<description>Description</description>
3246
</listheader>
3247
<item>
3248
<term>0</term>
3249
<description>
3250
The graphics mode for the current screen will be changed
3251
dynamically.
3252
</description>
3253
</item>
3254
<item>
3255
<term>see cref="Gdi.CDS_FULLSCREEN" </term>
3256
<description>
3257
<para>
3258
The mode is temporary in nature.
3259
</para>
3260
<para>
3261
<b>Windows NT/2000/XP:</b> If you change to and from another
3262
desktop, this mode will not be reset.
3263
</para>
3264
</description>
3265
</item>
3266
<item>
3267
<term>see cref="Gdi.CDS_GLOBAL" </term>
3268
<description>
3269
The settings will be saved in the global settings area so that
3270
they will affect all users on the machine. Otherwise, only the
3271
settings for the user are modified. This flag is only valid when
3272
specified with the see cref="Gdi.CDS_UPDATEREGISTRY" flag.
3273
</description>
3274
</item>
3275
<item>
3276
<term>see cref="Gdi.CDS_NORESET" </term>
3277
<description>
3278
The settings will be saved in the registry, but will not take
3279
affect. This flag is only valid when specified with the
3280
see cref="Gdi.CDS_UPDATEREGISTRY" flag.
3281
</description>
3282
</item>
3283
<item>
3284
<term>see cref="Gdi.CDS_RESET" </term>
3285
<description>
3286
The settings should be changed, even if the requested settings are
3287
the same as the current settings.
3288
</description>
3289
</item>
3290
<item>
3291
<term>see cref="Gdi.CDS_SET_PRIMARY" </term>
3292
<description>
3293
This device will become the primary device.
3294
</description>
3295
</item>
3296
<item>
3297
<term>see cref="Gdi.CDS_TEST" </term>
3298
<description>
3299
The system tests if the requested graphics mode could be set.
3300
</description>
3301
</item>
3302
<item>
3303
<term>see cref="Gdi.CDS_UPDATEREGISTRY" </term>
3304
<description>
3305
The graphics mode for the current screen will be changed
3306
dynamically and the graphics mode will be updated in the registry.
3307
The mode information is stored in the USER profile.
3308
</description>
3309
</item>
3310
</list>
3311
</para>
3312
<para>
3313
Specifying see cref="Gdi.CDS_TEST" allows an application to determine
3314
which graphics modes are actually valid, without causing the system to
3315
change to that graphics mode.
3316
</para>
3317
<para>
3318
If see cref="Gdi.CDS_UPDATEREGISTRY" is specified and it is possible to
3319
change the graphics mode dynamically, the information is stored in the
3320
registry and see cref="Gdi.DISP_CHANGE_SUCCESSFUL" is returned. If it is
3321
not possible to change the graphics mode dynamically, the information is
3322
stored in the registry and see cref="Gdi.DISP_CHANGE_RESTART" is returned.
3323
</para>
3324
<para>
3325
<b>Windows NT/2000/XP:</b> If see cref="Gdi.CDS_UPDATEREGISTRY" is
3326
specified and the information could not be stored in the registry, the
3327
graphics mode is not changed and see cref="Gdi.DISP_CHANGE_NOTUPDATED" is
3328
returned.
3329
</para>
3330
</param>
3331
<returns>
3332
<para>
3333
The <b>ChangeDisplaySettings</b> function returns one of the following values:
3334
</para>
3335
<para>
3336
<list type="table">
3337
<listheader>
3338
<term>Value</term>
3339
<description>Description</description>
3340
</listheader>
3341
<item>
3342
<term>see cref="Gdi.DISP_CHANGE_SUCCESSFUL" </term>
3343
<description>
3344
The settings change was successful.
3345
</description>
3346
</item>
3347
<item>
3348
<term>see cref="Gdi.DISP_CHANGE_BADDUALVIEW" </term>
3349
<description>
3350
<b>Windows XP:</b> The settings change was unsuccessful because
3351
system is DualView capable.
3352
</description>
3353
</item>
3354
<item>
3355
<term>see cref="Gdi.DISP_CHANGE_BADFLAGS" </term>
3356
<description>
3357
An invalid set of flags was passed in.
3358
</description>
3359
</item>
3360
<item>
3361
<term>see cref="Gdi.DISP_CHANGE_BADMODE" </term>
3362
<description>
3363
The graphics mode is not supported.
3364
</description>
3365
</item>
3366
<item>
3367
<term>see cref="Gdi.DISP_CHANGE_BADPARAM" </term>
3368
<description>
3369
An invalid parameter was passed in. This can include an invalid
3370
flag or combination of flags.
3371
</description>
3372
</item>
3373
<item>
3374
<term>see cref="Gdi.DISP_CHANGE_FAILED" </term>
3375
<description>
3376
The display driver failed the specified graphics mode.
3377
</description>
3378
</item>
3379
<item>
3380
<term>see cref="Gdi.DISP_CHANGE_NOTUPDATED" </term>
3381
<description>
3382
<b>Windows NT/2000/XP:</b> Unable to write settings to the
3383
registry.
3384
</description>
3385
</item>
3386
<item>
3387
<term>see cref="Gdi.DISP_CHANGE_RESTART" </term>
3388
<description>
3389
The computer must be restarted in order for the graphics mode to
3390
work.
3391
</description>
3392
</item>
3393
</list>
3394
</para>
3395
</returns>
3396
<remarks>
3397
<para>
3398
To ensure that the <see cref="T:Tao.Platform.Windows.Gdi.DEVMODE"/> structure passed to
3399
<b>ChangeDisplaySettings</b> is valid and contains only values supported by
3400
the display driver, use the <see cref="T:Tao.Platform.Windows.Gdi.DEVMODE"/> returned by the
3401
<see cref="M:Tao.Platform.Windows.User.EnumDisplaySettings(System.String,System.Int32,Tao.Platform.Windows.Gdi.DEVMODE@)"/> function.
3402
</para>
3403
<para>
3404
When the display mode is changed dynamically, the <b>WM_DISPLAYCHANGE</b>
3405
message is sent to all running applications with the following message
3406
parameters:
3407
</para>
3408
<para>
3409
<list type="table">
3410
<listheader>
3411
<term>Value</term>
3412
<description>Description</description>
3413
</listheader>
3414
<item>
3415
<term>wParam</term>
3416
<description>New bits per pixel.</description>
3417
</item>
3418
<item>
3419
<term>LOWORD(lParam)</term>
3420
<description>New pixel width.</description>
3421
</item>
3422
<item>
3423
<term>HIWORD(lParam)</term>
3424
<description>New pixel height.</description>
3425
</item>
3426
</list>
3427
</para>
3428
<para>
3429
<b>Windows 95/98/Me:</b> If the calling thread has any windows,
3430
<b>ChangeDisplaySettings</b> sends them the <b>WM_DISPLAYCHANGE</b> message
3431
immediately (for windows in all other threads, the message is sent when the
3432
thread can receive nonqueued messages). This may cause the shell to get its
3433
message too soon and could squash icons. To avoid this problem, have
3434
<b>ChangeDisplaySettings</b> do resolution switching by calling on a thread
3435
with no windows, for example, a new thread.
3436
</para>
3437
</remarks>
3438
seealso cref="CreateDC"
3439
<seealso cref="T:Tao.Platform.Windows.Gdi.DEVMODE"/>
3440
<seealso cref="M:Tao.Platform.Windows.User.EnumDisplaySettings(System.String,System.Int32,Tao.Platform.Windows.Gdi.DEVMODE@)"/>
3441
</member>
3442
<member name="M:Tao.Platform.Windows.User.ChangeDisplaySettings(System.IntPtr,System.Int32)">
3443
<summary>
3444
<para>
3445
The <b>ChangeDisplaySettings</b> function changes the settings of the default
3446
display device to the specified graphics mode.
3447
</para>
3448
<para>
3449
To change the settings of a specified display device, use the
3450
<b>ChangeDisplaySettingsEx</b> function.
3451
</para>
3452
</summary>
3453
<param name="devMode">
3454
<para>
3455
Pointer to a <see cref="T:Tao.Platform.Windows.Gdi.DEVMODE"/> structure that describes the new
3456
graphics mode. If <i>devMode</i> is NULL, all the values currently in the
3457
registry will be used for the display setting. Passing NULL for the
3458
<i>devMode</i> parameter and 0 for the <i>flags</i> parameter is the easiest
3459
way to return to the default mode after a dynamic mode change.
3460
</para>
3461
<para>
3462
The <see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmSize"/> member of <see cref="T:Tao.Platform.Windows.Gdi.DEVMODE"/>
3463
must be initialized to the size, in bytes, of the <see cref="T:Tao.Platform.Windows.Gdi.DEVMODE"/>
3464
structure. The <see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmDriverExtra"/> member of
3465
<see cref="T:Tao.Platform.Windows.Gdi.DEVMODE"/> must be initialized to indicate the number of bytes
3466
of private driver data following the <see cref="T:Tao.Platform.Windows.Gdi.DEVMODE"/> structure. In
3467
addition, you can use any or all of the following members of the
3468
<see cref="T:Tao.Platform.Windows.Gdi.DEVMODE"/> structure:
3469
</para>
3470
<para>
3471
<list type="table">
3472
<listheader>
3473
<term>Value</term>
3474
<description>Description</description>
3475
</listheader>
3476
<item>
3477
<term><see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmBitsPerPel"/></term>
3478
<description>Bits per pixel.</description>
3479
</item>
3480
<item>
3481
<term><see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmPelsWidth"/></term>
3482
<description>Pixel width.</description>
3483
</item>
3484
<item>
3485
<term><see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmPelsHeight"/></term>
3486
<description>Pixel height.</description>
3487
</item>
3488
<item>
3489
<term><see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmDisplayFlags"/></term>
3490
<description>Mode flags.</description>
3491
</item>
3492
<item>
3493
<term><see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmDisplayFrequency"/></term>
3494
<description>Mode frequency.</description>
3495
</item>
3496
<item>
3497
<term>dmPosition</term>
3498
<description>
3499
<b>Windows 98/Me, Windows 2000/XP:</b> Position of the device in
3500
a multimonitor configuration.
3501
</description>
3502
</item>
3503
</list>
3504
</para>
3505
<para>
3506
In addition to using one or more of the preceding <see cref="T:Tao.Platform.Windows.Gdi.DEVMODE"/>
3507
members, you must also set one or more of the following values in the
3508
<see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmFields"/> member to change the display setting:
3509
</para>
3510
<para>
3511
<list type="table">
3512
<listheader>
3513
<term>Value</term>
3514
<description>Description</description>
3515
</listheader>
3516
<item>
3517
<term><see cref="F:Tao.Platform.Windows.Gdi.DM_BITSPERPEL"/></term>
3518
<description>
3519
Use the <see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmBitsPerPel"/> value.
3520
</description>
3521
</item>
3522
<item>
3523
<term><see cref="F:Tao.Platform.Windows.Gdi.DM_PELSWIDTH"/></term>
3524
<description>
3525
Use the <see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmPelsWidth"/> value.
3526
</description>
3527
</item>
3528
<item>
3529
<term><see cref="F:Tao.Platform.Windows.Gdi.DM_PELSHEIGHT"/></term>
3530
<description>
3531
Use the <see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmPelsHeight"/> value.
3532
</description>
3533
</item>
3534
<item>
3535
<term><see cref="F:Tao.Platform.Windows.Gdi.DM_DISPLAYFLAGS"/></term>
3536
<description>
3537
Use the <see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmDisplayFlags"/> value.
3538
</description>
3539
</item>
3540
<item>
3541
<term><see cref="F:Tao.Platform.Windows.Gdi.DM_DISPLAYFREQUENCY"/></term>
3542
<description>
3543
Use the <see cref="F:Tao.Platform.Windows.Gdi.DEVMODE.dmDisplayFrequency"/> value.
3544
</description>
3545
</item>
3546
<item>
3547
<term>see cref="Gdi.DM_POSITION" /&gt;</term>
3548
<description>
3549
<b>Windows 98/Me, Windows 2000/XP:</b> Use the dmPosition value.
3550
</description>
3551
</item>
3552
</list>
3553
</para>
3554
</param>
3555
<param name="flags">
3556
<para>
3557
Indicates how the graphics mode should be changed. This parameter can be one
3558
of the following values:
3559
</para>
3560
<para>
3561
<list type="table">
3562
<listheader>
3563
<term>Value</term>
3564
<description>Description</description>
3565
</listheader>
3566
<item>
3567
<term>0</term>
3568
<description>
3569
The graphics mode for the current screen will be changed
3570
dynamically.
3571
</description>
3572
</item>
3573
<item>
3574
<term>see cref="Gdi.CDS_FULLSCREEN" </term>
3575
<description>
3576
<para>
3577
The mode is temporary in nature.
3578
</para>
3579
<para>
3580
<b>Windows NT/2000/XP:</b> If you change to and from another
3581
desktop, this mode will not be reset.
3582
</para>
3583
</description>
3584
</item>
3585
<item>
3586
<term>see cref="Gdi.CDS_GLOBAL" </term>
3587
<description>
3588
The settings will be saved in the global settings area so that
3589
they will affect all users on the machine. Otherwise, only the
3590
settings for the user are modified. This flag is only valid when
3591
specified with the see cref="Gdi.CDS_UPDATEREGISTRY" flag.
3592
</description>
3593
</item>
3594
<item>
3595
<term>see cref="Gdi.CDS_NORESET" </term>
3596
<description>
3597
The settings will be saved in the registry, but will not take
3598
affect. This flag is only valid when specified with the
3599
see cref="Gdi.CDS_UPDATEREGISTRY" flag.
3600
</description>
3601
</item>
3602
<item>
3603
<term>see cref="Gdi.CDS_RESET" </term>
3604
<description>
3605
The settings should be changed, even if the requested settings are
3606
the same as the current settings.
3607
</description>
3608
</item>
3609
<item>
3610
<term>see cref="Gdi.CDS_SET_PRIMARY" </term>
3611
<description>
3612
This device will become the primary device.
3613
</description>
3614
</item>
3615
<item>
3616
<term>see cref="Gdi.CDS_TEST" /&gt;</term>
3617
<description>
3618
The system tests if the requested graphics mode could be set.
3619
</description>
3620
</item>
3621
<item>
3622
<term>see cref="Gdi.CDS_UPDATEREGISTRY" /&gt;</term>
3623
<description>
3624
The graphics mode for the current screen will be changed
3625
dynamically and the graphics mode will be updated in the registry.
3626
The mode information is stored in the USER profile.
3627
</description>
3628
</item>
3629
</list>
3630
</para>
3631
<para>
3632
Specifying see cref="Gdi.CDS_TEST" /&gt; allows an application to determine
3633
which graphics modes are actually valid, without causing the system to
3634
change to that graphics mode.
3635
</para>
3636
<para>
3637
If see cref="Gdi.CDS_UPDATEREGISTRY" /&gt; is specified and it is possible to
3638
change the graphics mode dynamically, the information is stored in the
3639
registry and see cref="Gdi.DISP_CHANGE_SUCCESSFUL" /&gt; is returned. If it is
3640
not possible to change the graphics mode dynamically, the information is
3641
stored in the registry and see cref="Gdi.DISP_CHANGE_RESTART" /&gt; is returned.
3642
</para>
3643
<para>
3644
<b>Windows NT/2000/XP:</b> If see cref="Gdi.CDS_UPDATEREGISTRY" /&gt; is
3645
specified and the information could not be stored in the registry, the
3646
graphics mode is not changed and see cref="Gdi.DISP_CHANGE_NOTUPDATED" /&gt; is
3647
returned.
3648
</para>
3649
</param>
3650
<returns>
3651
<para>
3652
The <b>ChangeDisplaySettings</b> function returns one of the following values:
3653
</para>
3654
<para>
3655
<list type="table">
3656
<listheader>
3657
<term>Value</term>
3658
<description>Description</description>
3659
</listheader>
3660
<item>
3661
<term>see cref="Gdi.DISP_CHANGE_SUCCESSFUL" /&gt;</term>
3662
<description>
3663
The settings change was successful.
3664
</description>
3665
</item>
3666
<item>
3667
<term>see cref="Gdi.DISP_CHANGE_BADDUALVIEW" /&gt;</term>
3668
<description>
3669
<b>Windows XP:</b> The settings change was unsuccessful because
3670
system is DualView capable.
3671
</description>
3672
</item>
3673
<item>
3674
<term>see cref="Gdi.DISP_CHANGE_BADFLAGS" /&gt;</term>
3675
<description>
3676
An invalid set of flags was passed in.
3677
</description>
3678
</item>
3679
<item>
3680
<term>see cref="Gdi.DISP_CHANGE_BADMODE" </term>
3681
<description>
3682
The graphics mode is not supported.
3683
</description>
3684
</item>
3685
<item>
3686
<term>see cref="Gdi.DISP_CHANGE_BADPARAM" </term>
3687
<description>
3688
An invalid parameter was passed in. This can include an invalid
3689
flag or combination of flags.
3690
</description>
3691
</item>
3692
<item>
3693
<term>see cref="Gdi.DISP_CHANGE_FAILED" /&gt;</term>
3694
<description>
3695
The display driver failed the specified graphics mode.
3696
</description>
3697
</item>
3698
<item>
3699
<term>see cref="Gdi.DISP_CHANGE_NOTUPDATED" /&gt;</term>
3700
<description>
3701
<b>Windows NT/2000/XP:</b> Unable to write settings to the
3702
registry.
3703
</description>
3704
</item>
3705
<item>
3706
<term>see cref="Gdi.DISP_CHANGE_RESTART" /&gt;</term>
3707
<description>
3708
The computer must be restarted in order for the graphics mode to
3709
work.
3710
</description>
3711
</item>
3712
</list>
3713
</para>
3714
</returns>
3715
<remarks>
3716
<para>
3717
To ensure that the <see cref="T:Tao.Platform.Windows.Gdi.DEVMODE"/> structure passed to
3718
<b>ChangeDisplaySettings</b> is valid and contains only values supported by
3719
the display driver, use the <see cref="T:Tao.Platform.Windows.Gdi.DEVMODE"/> returned by the
3720
<see cref="M:Tao.Platform.Windows.User.EnumDisplaySettings(System.String,System.Int32,Tao.Platform.Windows.Gdi.DEVMODE@)"/> function.
3721
</para>
3722
<para>
3723
When the display mode is changed dynamically, the <b>WM_DISPLAYCHANGE</b>
3724
message is sent to all running applications with the following message
3725
parameters:
3726
</para>
3727
<para>
3728
<list type="table">
3729
<listheader>
3730
<term>Value</term>
3731
<description>Description</description>
3732
</listheader>
3733
<item>
3734
<term>wParam</term>
3735
<description>New bits per pixel.</description>
3736
</item>
3737
<item>
3738
<term>LOWORD(lParam)</term>
3739
<description>New pixel width.</description>
3740
</item>
3741
<item>
3742
<term>HIWORD(lParam)</term>
3743
<description>New pixel height.</description>
3744
</item>
3745
</list>
3746
</para>
3747
<para>
3748
<b>Windows 95/98/Me:</b> If the calling thread has any windows,
3749
<b>ChangeDisplaySettings</b> sends them the <b>WM_DISPLAYCHANGE</b> message
3750
immediately (for windows in all other threads, the message is sent when the
3751
thread can receive nonqueued messages). This may cause the shell to get its
3752
message too soon and could squash icons. To avoid this problem, have
3753
<b>ChangeDisplaySettings</b> do resolution switching by calling on a thread
3754
with no windows, for example, a new thread.
3755
</para>
3756
</remarks>
3757
seealso cref="CreateDC" /&gt;
3758
<seealso cref="T:Tao.Platform.Windows.Gdi.DEVMODE"/>
3759
<seealso cref="M:Tao.Platform.Windows.User.EnumDisplaySettings(System.String,System.Int32,Tao.Platform.Windows.Gdi.DEVMODE@)"/>
3760
</member>
3761
<member name="M:Tao.Platform.Windows.User.EnumDisplaySettings(System.String,System.Int32,Tao.Platform.Windows.Gdi.DEVMODE@)">
3762
<summary>
3763
3764
</summary>
3765
<param name="deviceName"></param>
3766
<param name="modeNumber"></param>
3767
<param name="devMode"></param>
3768
<returns></returns>
3769
</member>
3770
<member name="M:Tao.Platform.Windows.User.GetDC(System.IntPtr)">
3771
<summary>
3772
<para>
3773
The <b>GetDC</b> function retrieves a handle to a display device context (DC)
3774
for the client area of a specified window or for the entire screen. You can
3775
use the returned handle in subsequent GDI functions to draw in the DC.
3776
</para>
3777
<para>
3778
The see cref="GetDCEx" /&gt; function is an extension to <b>GetDC</b>, which
3779
gives an application more control over how and whether clipping occurs in the
3780
client area.
3781
</para>
3782
</summary>
3783
<param name="windowHandle">
3784
<para>
3785
Handle to the window whose DC is to be retrieved. If this value is null,
3786
<b>GetDC</b> retrieves the DC for the entire screen.
3787
</para>
3788
<para>
3789
<b>Windows 98/Me, Windows 2000/XP:</b> To get the DC for a specific display
3790
monitor, use the see cref="EnumDisplayMonitors" /&gt; and
3791
see cref="Gdi.CreateDC" /&gt; functions.
3792
</para>
3793
</param>
3794
<returns>
3795
<para>
3796
If the function succeeds, the return value is a handle to the DC for the
3797
specified window's client area.
3798
</para>
3799
<para>
3800
If the function fails, the return value is null.
3801
</para>
3802
<para>
3803
<b>Windows NT/2000/XP:</b> To get extended error information, call
3804
<see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.
3805
</para>
3806
</returns>
3807
<remarks>
3808
<para>
3809
The <b>GetDC</b> function retrieves a common, class, or private DC depending
3810
on the class style of the specified window. For class and private DCs,
3811
<b>GetDC</b> leaves the previously assigned attributes unchanged. However,
3812
for common DCs, <b>GetDC</b> assigns default attributes to the DC each time
3813
it is retrieved. For example, the default font is System, which is a bitmap
3814
font. Because of this, the handle for a common DC returned by <b>GetDC</b>
3815
does not tell you what font, color, or brush was used when the window was
3816
drawn. To determine the font, call see cref="GetTextFace" /&gt;.
3817
</para>
3818
<para>
3819
Note that the handle to the DC can only be used by a single thread at any one
3820
time.
3821
</para>
3822
<para>
3823
After painting with a common DC, the <see cref="M:Tao.Platform.Windows.User.ReleaseDC(System.IntPtr,System.IntPtr)"/> function must
3824
be called to release the DC. Class and private DCs do not have to be
3825
released. <see cref="M:Tao.Platform.Windows.User.ReleaseDC(System.IntPtr,System.IntPtr)"/> must be called from the same thread that
3826
called <b>GetDC</b>. The number of DCs is limited only by available memory.
3827
</para>
3828
<para>
3829
<b>Windows 95/98/Me:</b> There are only 5 common DCs available per thread,
3830
thus failure to release a DC can prevent other applications from accessing
3831
one.
3832
</para>
3833
</remarks>
3834
seealso cref="GetDCEx" /&gt;
3835
<seealso cref="M:Tao.Platform.Windows.User.ReleaseDC(System.IntPtr,System.IntPtr)"/>
3836
seealso cref="GetTextFace" /&gt;
3837
seealso cref="GetWindowDC" /&gt;
3838
</member>
3839
<member name="M:Tao.Platform.Windows.User.ReleaseDC(System.IntPtr,System.IntPtr)">
3840
<summary>
3841
<para>
3842
The <b>ReleaseDC</b> function releases a device context (DC), freeing it for
3843
use by other applications. The effect of the <b>ReleaseDC</b> function
3844
depends on the type of DC. It frees only common and window DCs. It has no
3845
effect on class or private DCs.
3846
</para>
3847
</summary>
3848
<param name="windowHandle">
3849
<para>
3850
Handle to the window whose DC is to be released.
3851
</para>
3852
</param>
3853
<param name="deviceContext">
3854
<para>
3855
Handle to the DC to be released.
3856
</para>
3857
</param>
3858
<returns>
3859
<para>
3860
The return value indicates whether the DC was released. If the DC was
3861
released, the return value is true.
3862
</para>
3863
<para>
3864
If the DC was not released, the return value is false.
3865
</para>
3866
</returns>
3867
<remarks>
3868
<para>
3869
The application must call the <b>ReleaseDC</b> function for each call to the
3870
see cref="GetWindowDC" /&gt; function and for each call to the
3871
<see cref="M:Tao.Platform.Windows.User.GetDC(System.IntPtr)"/> function that retrieves a common DC.
3872
</para>
3873
<para>
3874
An application cannot use the <b>ReleaseDC</b> function to release a DC that
3875
was created by calling the see cref="Gdi.CreateDC" /&gt; function; instead, it
3876
must use the see cref="Gdi.DeleteDC" /&gt; function. <b>ReleaseDC</b> must be
3877
called from the same thread that called <b>GetDC</b>.
3878
</para>
3879
</remarks>
3880
seealso cref="Gdi.CreateDC" /&gt;
3881
seealso cref="Gdi.DeleteDC" /&gt;
3882
<seealso cref="M:Tao.Platform.Windows.User.GetDC(System.IntPtr)"/>
3883
seealso cref="GetWindowDC" /&gt;
3884
</member>
3885
<member name="M:Tao.Platform.Windows.User.SetParent(System.IntPtr,System.IntPtr)">
3886
<summary>
3887
3888
</summary>
3889
<param name="hWndChild"></param>
3890
<param name="hWndNewParent"></param>
3891
<returns></returns>
3892
</member>
3893
<member name="M:Tao.Platform.Windows.User.FindWindow(System.String,System.String)">
3894
<summary>
3895
3896
</summary>
3897
<param name="lpClassName"></param>
3898
<param name="lpWindowName"></param>
3899
<returns></returns>
3900
</member>
3901
<member name="M:Tao.Platform.Windows.User.ShowWindow(System.IntPtr,System.Int32)">
3902
<summary>
3903
3904
</summary>
3905
<param name="hWnd"></param>
3906
<param name="nCmdShow"></param>
3907
<returns></returns>
3908
</member>
3909
<member name="M:Tao.Platform.Windows.User.SetWindowPos(System.IntPtr,System.IntPtr,System.Int32,System.Int32,System.Int32,System.Int32,System.UInt32)">
3910
<summary>
3911
3912
</summary>
3913
<param name="hWnd"></param>
3914
<param name="hWndInsertAfter"></param>
3915
<param name="X"></param>
3916
<param name="Y"></param>
3917
<param name="cx"></param>
3918
<param name="cy"></param>
3919
<param name="uFlags"></param>
3920
<returns></returns>
3921
</member>
3922
<member name="T:Tao.Platform.Windows.User.SHOWWINDOW">
3923
<summary>
3924
3925
</summary>
3926
</member>
3927
<member name="F:Tao.Platform.Windows.User.SHOWWINDOW.SW_HIDE">
3928
<summary>
3929
3930
</summary>
3931
</member>
3932
<member name="F:Tao.Platform.Windows.User.SHOWWINDOW.SW_SHOWNORMAL">
3933
<summary>
3934
3935
</summary>
3936
</member>
3937
<member name="F:Tao.Platform.Windows.User.SHOWWINDOW.SW_NORMAL">
3938
<summary>
3939
3940
</summary>
3941
</member>
3942
<member name="F:Tao.Platform.Windows.User.SHOWWINDOW.SW_SHOWMINIMIZED">
3943
<summary>
3944
3945
</summary>
3946
</member>
3947
<member name="F:Tao.Platform.Windows.User.SHOWWINDOW.SW_SHOWMAXIMIZED">
3948
<summary>
3949
3950
</summary>
3951
</member>
3952
<member name="F:Tao.Platform.Windows.User.SHOWWINDOW.SW_MAXIMIZE">
3953
<summary>
3954
3955
</summary>
3956
</member>
3957
<member name="F:Tao.Platform.Windows.User.SHOWWINDOW.SW_SHOWNOACTIVATE">
3958
<summary>
3959
3960
</summary>
3961
</member>
3962
<member name="F:Tao.Platform.Windows.User.SHOWWINDOW.SW_SHOW">
3963
<summary>
3964
3965
</summary>
3966
</member>
3967
<member name="F:Tao.Platform.Windows.User.SHOWWINDOW.SW_MINIMIZE">
3968
<summary>
3969
3970
</summary>
3971
</member>
3972
<member name="F:Tao.Platform.Windows.User.SHOWWINDOW.SW_SHOWMINNOACTIVE">
3973
<summary>
3974
3975
</summary>
3976
</member>
3977
<member name="F:Tao.Platform.Windows.User.SHOWWINDOW.SW_SHOWNA">
3978
<summary>
3979
3980
</summary>
3981
</member>
3982
<member name="F:Tao.Platform.Windows.User.SHOWWINDOW.SW_RESTORE">
3983
<summary>
3984
3985
</summary>
3986
</member>
3987
<member name="F:Tao.Platform.Windows.User.SHOWWINDOW.SW_SHOWDEFAULT">
3988
<summary>
3989
3990
</summary>
3991
</member>
3992
<member name="F:Tao.Platform.Windows.User.SHOWWINDOW.SW_FORCEMINIMIZE">
3993
<summary>
3994
3995
</summary>
3996
</member>
3997
<member name="F:Tao.Platform.Windows.User.SHOWWINDOW.SW_MAX">
3998
<summary>
3999
4000
</summary>
4001
</member>
4002
<member name="T:Tao.Platform.Windows.SimpleOpenGlControl">
4003
<summary>
4004
Provides a simple OpenGL control allowing quick development of Windows Forms-based
4005
OpenGL applications.
4006
</summary>
4007
</member>
4008
<member name="M:Tao.Platform.Windows.SimpleOpenGlControl.#ctor">
4009
<summary>
4010
Constructor. Creates contexts and sets properties.
4011
</summary>
4012
</member>
4013
<member name="M:Tao.Platform.Windows.SimpleOpenGlControl.Dispose(System.Boolean)">
4014
<summary>
4015
Disposes the control.
4016
</summary>
4017
<param name="disposing">Was the disposed manually called?</param>
4018
</member>
4019
<member name="M:Tao.Platform.Windows.SimpleOpenGlControl.InitializeBackground">
4020
<summary>
4021
Loads the bitmap from the assembly's manifest resource.
4022
</summary>
4023
</member>
4024
<member name="M:Tao.Platform.Windows.SimpleOpenGlControl.InitializeComponent">
4025
<summary>
4026
Required for designer support.
4027
</summary>
4028
</member>
4029
<member name="M:Tao.Platform.Windows.SimpleOpenGlControl.InitializeStyles">
4030
<summary>
4031
Initializes the control's styles.
4032
</summary>
4033
</member>
4034
<member name="M:Tao.Platform.Windows.SimpleOpenGlControl.DestroyContexts">
4035
<summary>
4036
4037
</summary>
4038
</member>
4039
<member name="M:Tao.Platform.Windows.SimpleOpenGlControl.Draw">
4040
<summary>
4041
Sends an see cref="UserControl.Invalidate" command to this control, thus
4042
forcing a redraw to occur.
4043
</summary>
4044
</member>
4045
<member name="M:Tao.Platform.Windows.SimpleOpenGlControl.InitializeContexts">
4046
<summary>
4047
Creates the OpenGL contexts.
4048
</summary>
4049
</member>
4050
<member name="M:Tao.Platform.Windows.SimpleOpenGlControl.MakeCurrent">
4051
<summary>
4052
4053
</summary>
4054
</member>
4055
<member name="M:Tao.Platform.Windows.SimpleOpenGlControl.SwapBuffers">
4056
<summary>
4057
4058
</summary>
4059
</member>
4060
<member name="M:Tao.Platform.Windows.SimpleOpenGlControl.OnPaint(System.Windows.Forms.PaintEventArgs)">
4061
<summary>
4062
Paints the control.
4063
</summary>
4064
<param name="e">The paint event arguments.</param>
4065
</member>
4066
<member name="M:Tao.Platform.Windows.SimpleOpenGlControl.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
4067
<summary>
4068
Paints the background.
4069
</summary>
4070
<param name="e"></param>
4071
</member>
4072
<member name="P:Tao.Platform.Windows.SimpleOpenGlControl.LogScaleX">
4073
<summary>
4074
Gets the number of logical pixels or dots per inch (dpi) in X-direction
4075
</summary>
4076
</member>
4077
<member name="P:Tao.Platform.Windows.SimpleOpenGlControl.LogScaleY">
4078
<summary>
4079
Gets the number of logical pixels or dots per inch (dpi) in Y-direction
4080
</summary>
4081
</member>
4082
<member name="P:Tao.Platform.Windows.SimpleOpenGlControl.AccumBits">
4083
<summary>
4084
Gets and sets the OpenGL control's accumulation buffer depth.
4085
</summary>
4086
</member>
4087
<member name="P:Tao.Platform.Windows.SimpleOpenGlControl.ColorBits">
4088
<summary>
4089
Gets and sets the OpenGL control's color buffer depth.
4090
</summary>
4091
</member>
4092
<member name="P:Tao.Platform.Windows.SimpleOpenGlControl.DepthBits">
4093
<summary>
4094
Gets and sets the OpenGL control's depth buffer (Z-buffer) depth.
4095
</summary>
4096
</member>
4097
<member name="P:Tao.Platform.Windows.SimpleOpenGlControl.StencilBits">
4098
<summary>
4099
Gets and sets the OpenGL control's stencil buffer depth.
4100
</summary>
4101
</member>
4102
<member name="P:Tao.Platform.Windows.SimpleOpenGlControl.AutoCheckErrors">
4103
<summary>
4104
Gets and sets the OpenGL control's automatic sending of a glGetError command
4105
after drawing.
4106
</summary>
4107
</member>
4108
<member name="P:Tao.Platform.Windows.SimpleOpenGlControl.AutoFinish">
4109
<summary>
4110
Gets and sets the OpenGL control's automatic sending of a glFinish command
4111
after drawing.
4112
</summary>
4113
</member>
4114
<member name="P:Tao.Platform.Windows.SimpleOpenGlControl.AutoMakeCurrent">
4115
<summary>
4116
Gets and sets the OpenGL control's automatic forcing of the rendering context to
4117
be current before drawing.
4118
</summary>
4119
</member>
4120
<member name="P:Tao.Platform.Windows.SimpleOpenGlControl.AutoSwapBuffers">
4121
<summary>
4122
Gets and sets the OpenGL control's automatic sending of a SwapBuffers command
4123
after drawing.
4124
</summary>
4125
</member>
4126
<member name="P:Tao.Platform.Windows.SimpleOpenGlControl.CreateParams">
4127
<summary>
4128
Overrides the control's class style parameters.
4129
</summary>
4130
</member>
4131
<member name="T:Tao.Platform.Windows.Gdi">
4132
<summary>
4133
GDI binding for .NET, implementing Windows-specific GDI functionality.
4134
</summary>
4135
<remarks>
4136
Binds functions and definitions in gdi32.dll.
4137
</remarks>
4138
</member>
4139
<member name="F:Tao.Platform.Windows.Gdi.GDI_NATIVE_LIBRARY">
4140
<summary>
4141
Specifies GDI's native library archive.
4142
</summary>
4143
<remarks>
4144
Specifies gdi32.dll for Windows.
4145
</remarks>
4146
</member>
4147
<member name="F:Tao.Platform.Windows.Gdi.CALLING_CONVENTION">
4148
<summary>
4149
Specifies the calling convention.
4150
</summary>
4151
<remarks>
4152
Specifies <see cref="F:System.Runtime.InteropServices.CallingConvention.StdCall"/>.
4153
</remarks>
4154
</member>
4155
<member name="F:Tao.Platform.Windows.Gdi.LPD_TYPE_RGBA">
4156
<summary>
4157
RGBA pixels. Each pixel has four components: red, green, blue, and alpha.
4158
</summary>
4159
</member>
4160
<member name="F:Tao.Platform.Windows.Gdi.LPD_TYPE_COLORINDEX">
4161
<summary>
4162
Color-index pixels. Each pixel uses a color-index value.
4163
</summary>
4164
</member>
4165
<member name="F:Tao.Platform.Windows.Gdi.LPD_DOUBLEBUFFER">
4166
<summary>
4167
The layer plane is double-buffered. A layer plane can be double-buffered
4168
even when the main plane is single-buffered and vice versa.
4169
</summary>
4170
</member>
4171
<member name="F:Tao.Platform.Windows.Gdi.LPD_STEREO">
4172
<summary>
4173
The layer plane is stereoscopic. A layer plane can be stereoscopic even
4174
when the main plane is monoscopic and vice versa.
4175
</summary>
4176
</member>
4177
<member name="F:Tao.Platform.Windows.Gdi.LPD_SUPPORT_GDI">
4178
<summary>
4179
The layer plane supports GDI drawing. The current implementation of OpenGL
4180
doesn't support this flag.
4181
</summary>
4182
</member>
4183
<member name="F:Tao.Platform.Windows.Gdi.LPD_SUPPORT_OPENGL">
4184
<summary>
4185
The layer plane supports OpenGL drawing.
4186
</summary>
4187
</member>
4188
<member name="F:Tao.Platform.Windows.Gdi.LPD_SHARE_DEPTH">
4189
<summary>
4190
The layer plane shares the depth buffer with the main plane.
4191
</summary>
4192
</member>
4193
<member name="F:Tao.Platform.Windows.Gdi.LPD_SHARE_STENCIL">
4194
<summary>
4195
The layer plane shares the stencil buffer with the main plane.
4196
</summary>
4197
</member>
4198
<member name="F:Tao.Platform.Windows.Gdi.LPD_SHARE_ACCUM">
4199
<summary>
4200
The layer plane shares the accumulation buffer with the main plane.
4201
</summary>
4202
</member>
4203
<member name="F:Tao.Platform.Windows.Gdi.LPD_SWAP_EXCHANGE">
4204
<summary>
4205
In a double-buffered layer plane, swapping the color buffer exchanges the
4206
front buffer and back buffer contents. The back buffer then contains the
4207
contents of the front buffer before the swap. This flag is a hint only and
4208
might not be provided by a driver.
4209
</summary>
4210
</member>
4211
<member name="F:Tao.Platform.Windows.Gdi.LPD_SWAP_COPY">
4212
<summary>
4213
In a double-buffered layer plane, swapping the color buffer copies the back
4214
buffer contents to the front buffer. The swap does not affect the back
4215
buffer contents. This flag is a hint only and might not be provided by a driver.
4216
</summary>
4217
</member>
4218
<member name="F:Tao.Platform.Windows.Gdi.LPD_TRANSPARENT">
4219
<summary>
4220
Contains a transparent color or index value that enables underlying layers
4221
to show through this layer. All layer planes, except the lowest-numbered
4222
underlay layer, have a transparent color or index.
4223
</summary>
4224
</member>
4225
<member name="F:Tao.Platform.Windows.Gdi.PFD_TYPE_RGBA">
4226
<summary>
4227
RGBA pixels. Each pixel has four components in this order: red, green, blue,
4228
and alpha.
4229
</summary>
4230
</member>
4231
<member name="F:Tao.Platform.Windows.Gdi.PFD_TYPE_COLORINDEX">
4232
<summary>
4233
Color-index pixels. Each pixel uses a color-index value.
4234
</summary>
4235
</member>
4236
<member name="F:Tao.Platform.Windows.Gdi.PFD_MAIN_PLANE">
4237
<summary>
4238
The layer is the main plane.
4239
</summary>
4240
</member>
4241
<member name="F:Tao.Platform.Windows.Gdi.PFD_OVERLAY_PLANE">
4242
<summary>
4243
The layer is the overlay plane.
4244
</summary>
4245
</member>
4246
<member name="F:Tao.Platform.Windows.Gdi.PFD_UNDERLAY_PLANE">
4247
<summary>
4248
The layer is the underlay plane.
4249
</summary>
4250
</member>
4251
<member name="F:Tao.Platform.Windows.Gdi.PFD_DOUBLEBUFFER">
4252
<summary>
4253
<para>
4254
The buffer is double-buffered. This flag and <see cref="F:Tao.Platform.Windows.Gdi.PFD_SUPPORT_GDI"/>
4255
are mutually exclusive in the current generic implementation.
4256
</para>
4257
</summary>
4258
</member>
4259
<member name="F:Tao.Platform.Windows.Gdi.PFD_STEREO">
4260
<summary>
4261
<para>
4262
The buffer is stereoscopic. This flag is not supported in the current
4263
generic implementation.
4264
</para>
4265
</summary>
4266
</member>
4267
<member name="F:Tao.Platform.Windows.Gdi.PFD_DRAW_TO_WINDOW">
4268
<summary>
4269
<para>
4270
The buffer can draw to a window or device surface.
4271
</para>
4272
</summary>
4273
</member>
4274
<member name="F:Tao.Platform.Windows.Gdi.PFD_DRAW_TO_BITMAP">
4275
<summary>
4276
<para>
4277
The buffer can draw to a memory bitmap.
4278
</para>
4279
</summary>
4280
</member>
4281
<member name="F:Tao.Platform.Windows.Gdi.PFD_SUPPORT_GDI">
4282
<summary>
4283
<para>
4284
The buffer supports GDI drawing. This flag and
4285
<see cref="F:Tao.Platform.Windows.Gdi.PFD_DOUBLEBUFFER"/> are mutually exclusive in the current generic
4286
implementation.
4287
</para>
4288
</summary>
4289
</member>
4290
<member name="F:Tao.Platform.Windows.Gdi.PFD_SUPPORT_OPENGL">
4291
<summary>
4292
<para>
4293
The buffer supports OpenGL drawing.
4294
</para>
4295
</summary>
4296
</member>
4297
<member name="F:Tao.Platform.Windows.Gdi.PFD_GENERIC_FORMAT">
4298
<summary>
4299
<para>
4300
The pixel format is supported by the GDI software implementation, which is
4301
also known as the generic implementation. If this bit is clear, the pixel
4302
format is supported by a device driver or hardware.
4303
</para>
4304
</summary>
4305
</member>
4306
<member name="F:Tao.Platform.Windows.Gdi.PFD_NEED_PALETTE">
4307
<summary>
4308
<para>
4309
The buffer uses RGBA pixels on a palette-managed device. A logical palette
4310
is required to achieve the best results for this pixel type. Colors in the
4311
palette should be specified according to the values of the <b>cRedBits</b>,
4312
<b>cRedShift</b>, <b>cGreenBits</b>, <b>cGreenShift</b>, <b>cBluebits</b>,
4313
and <b>cBlueShift</b> members. The palette should be created and realized in
4314
the device context before calling <see cref="M:Tao.Platform.Windows.Wgl.wglMakeCurrent(System.IntPtr,System.IntPtr)"/>.
4315
</para>
4316
</summary>
4317
</member>
4318
<member name="F:Tao.Platform.Windows.Gdi.PFD_NEED_SYSTEM_PALETTE">
4319
<summary>
4320
<para>
4321
Defined in the pixel format descriptors of hardware that supports one
4322
hardware palette in 256-color mode only. For such systems to use
4323
hardware acceleration, the hardware palette must be in a fixed order
4324
(for example, 3-3-2) when in RGBA mode or must match the logical palette
4325
when in color-index mode.
4326
</para>
4327
<para>
4328
When this flag is set, you must call see cref="SetSystemPaletteUse" /> in
4329
your program to force a one-to-one mapping of the logical palette and the
4330
system palette. If your OpenGL hardware supports multiple hardware palettes
4331
and the device driver can allocate spare hardware palettes for OpenGL, this
4332
flag is typically clear.
4333
</para>
4334
<para>
4335
This flag is not set in the generic pixel formats.
4336
</para>
4337
</summary>
4338
</member>
4339
<member name="F:Tao.Platform.Windows.Gdi.PFD_SWAP_EXCHANGE">
4340
<summary>
4341
<para>
4342
Specifies the content of the back buffer in the double-buffered main color
4343
plane following a buffer swap. Swapping the color buffers causes the
4344
exchange of the back buffer's content with the front buffer's content.
4345
Following the swap, the back buffer's content contains the front buffer's
4346
content before the swap. <b>PFD_SWAP_EXCHANGE</b> is a hint only and might
4347
not be provided by a driver.
4348
</para>
4349
</summary>
4350
</member>
4351
<member name="F:Tao.Platform.Windows.Gdi.PFD_SWAP_COPY">
4352
<summary>
4353
<para>
4354
Specifies the content of the back buffer in the double-buffered main color
4355
plane following a buffer swap. Swapping the color buffers causes the content
4356
of the back buffer to be copied to the front buffer. The content of the back
4357
buffer is not affected by the swap. <b>PFD_SWAP_COPY</b> is a hint only and
4358
might not be provided by a driver.
4359
</para>
4360
</summary>
4361
</member>
4362
<member name="F:Tao.Platform.Windows.Gdi.PFD_SWAP_LAYER_BUFFERS">
4363
<summary>
4364
<para>
4365
Indicates whether a device can swap individual layer planes with pixel
4366
formats that include double-buffered overlay or underlay planes.
4367
Otherwise all layer planes are swapped together as a group. When this
4368
flag is set, <see cref="M:Tao.Platform.Windows.Wgl.wglSwapLayerBuffers(System.IntPtr,System.Int32)"/> is supported.
4369
</para>
4370
</summary>
4371
</member>
4372
<member name="F:Tao.Platform.Windows.Gdi.PFD_GENERIC_ACCELERATED">
4373
<summary>
4374
<para>
4375
The pixel format is supported by a device driver that accelerates the generic
4376
implementation. If this flag is clear and the
4377
<see cref="F:Tao.Platform.Windows.Gdi.PFD_GENERIC_FORMAT"/> flag is set, the pixel format is supported
4378
by the generic implementation only.
4379
</para>
4380
</summary>
4381
</member>
4382
<member name="F:Tao.Platform.Windows.Gdi.PFD_SUPPORT_DIRECTDRAW">
4383
<summary>
4384
<para>
4385
The buffer supports DirectDraw drawing.
4386
</para>
4387
</summary>
4388
</member>
4389
<member name="F:Tao.Platform.Windows.Gdi.PFD_DEPTH_DONTCARE">
4390
<summary>
4391
<para>
4392
The requested pixel format can either have or not have a depth buffer. To
4393
select a pixel format without a depth buffer, you must specify this flag.
4394
The requested pixel format can be with or without a depth buffer. Otherwise,
4395
only pixel formats with a depth buffer are considered.
4396
</para>
4397
</summary>
4398
</member>
4399
<member name="F:Tao.Platform.Windows.Gdi.PFD_DOUBLEBUFFER_DONTCARE">
4400
<summary>
4401
<para>
4402
The requested pixel format can be either single- or double-buffered.
4403
</para>
4404
</summary>
4405
</member>
4406
<member name="F:Tao.Platform.Windows.Gdi.PFD_STEREO_DONTCARE">
4407
<summary>
4408
<para>
4409
The requested pixel format can be either monoscopic or stereoscopic.
4410
</para>
4411
</summary>
4412
</member>
4413
<member name="F:Tao.Platform.Windows.Gdi.DM_BITSPERPEL">
4414
<summary>
4415
4416
</summary>
4417
</member>
4418
<member name="F:Tao.Platform.Windows.Gdi.DM_PELSWIDTH">
4419
<summary>
4420
4421
</summary>
4422
</member>
4423
<member name="F:Tao.Platform.Windows.Gdi.DM_PELSHEIGHT">
4424
<summary>
4425
4426
</summary>
4427
</member>
4428
<member name="F:Tao.Platform.Windows.Gdi.DM_DISPLAYFLAGS">
4429
<summary>
4430
4431
</summary>
4432
</member>
4433
<member name="F:Tao.Platform.Windows.Gdi.DM_DISPLAYFREQUENCY">
4434
<summary>
4435
4436
</summary>
4437
</member>
4438
<member name="F:Tao.Platform.Windows.Gdi.OUT_TT_PRECIS">
4439
<summary>
4440
4441
</summary>
4442
</member>
4443
<member name="F:Tao.Platform.Windows.Gdi.CLIP_DEFAULT_PRECIS">
4444
<summary>
4445
4446
</summary>
4447
</member>
4448
<member name="F:Tao.Platform.Windows.Gdi.DEFAULT_QUALITY">
4449
<summary>
4450
4451
</summary>
4452
</member>
4453
<member name="F:Tao.Platform.Windows.Gdi.DRAFT_QUALITY">
4454
<summary>
4455
4456
</summary>
4457
</member>
4458
<member name="F:Tao.Platform.Windows.Gdi.PROOF_QUALITY">
4459
<summary>
4460
4461
</summary>
4462
</member>
4463
<member name="F:Tao.Platform.Windows.Gdi.NONANTIALIASED_QUALITY">
4464
<summary>
4465
4466
</summary>
4467
</member>
4468
<member name="F:Tao.Platform.Windows.Gdi.ANTIALIASED_QUALITY">
4469
<summary>
4470
4471
</summary>
4472
</member>
4473
<member name="F:Tao.Platform.Windows.Gdi.CLEARTYPE_QUALITY">
4474
<summary>
4475
4476
</summary>
4477
</member>
4478
<member name="F:Tao.Platform.Windows.Gdi.CLEARTYPE_NATURAL_QUALITY">
4479
<summary>
4480
4481
</summary>
4482
</member>
4483
<member name="F:Tao.Platform.Windows.Gdi.DEFAULT_PITCH">
4484
<summary>
4485
4486
</summary>
4487
</member>
4488
<member name="F:Tao.Platform.Windows.Gdi.FIXED_PITCH">
4489
<summary>
4490
4491
</summary>
4492
</member>
4493
<member name="F:Tao.Platform.Windows.Gdi.VARIABLE_PITCH">
4494
<summary>
4495
4496
</summary>
4497
</member>
4498
<member name="F:Tao.Platform.Windows.Gdi.MONO_FONT">
4499
<summary>
4500
4501
</summary>
4502
</member>
4503
<member name="F:Tao.Platform.Windows.Gdi.ANSI_CHARSET">
4504
<summary>
4505
4506
</summary>
4507
</member>
4508
<member name="F:Tao.Platform.Windows.Gdi.DEFAULT_CHARSET">
4509
<summary>
4510
4511
</summary>
4512
</member>
4513
<member name="F:Tao.Platform.Windows.Gdi.SYMBOL_CHARSET">
4514
<summary>
4515
4516
</summary>
4517
</member>
4518
<member name="F:Tao.Platform.Windows.Gdi.SHIFTJIS_CHARSET">
4519
<summary>
4520
4521
</summary>
4522
</member>
4523
<member name="F:Tao.Platform.Windows.Gdi.FF_DONTCARE">
4524
<summary>
4525
4526
</summary>
4527
</member>
4528
<member name="F:Tao.Platform.Windows.Gdi.FW_BOLD">
4529
<summary>
4530
4531
</summary>
4532
</member>
4533
<member name="M:Tao.Platform.Windows.Gdi._SetPixelFormat(System.IntPtr,System.Int32,Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR@)">
4534
<summary>
4535
4536
</summary>
4537
</member>
4538
<member name="M:Tao.Platform.Windows.Gdi.ChoosePixelFormat(System.IntPtr,Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR@)">
4539
<summary>
4540
The <b>ChoosePixelFormat</b> function attempts to match an appropriate pixel format supported by a device context
4541
to a given pixel format specification.
4542
</summary>
4543
<param name="deviceContext">
4544
Specifies the device context that the function examines to determine the best match for the pixel format
4545
descriptor pointed to by <i>ppfd</i>.
4546
</param>
4547
<param name="pixelFormatDescriptor">
4548
<para>
4549
Pointer to a <see cref="T:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR"/> structure that specifies the requested pixel format.
4550
In this context, the members of the <b>PIXELFORMATDESCRIPTOR</b> structure that <i>ppfd</i>
4551
points to are used as follows:
4552
</para>
4553
<para>
4554
<b>nSize</b><br/>
4555
Specifies the size of the <b>PIXELFORMATDESCRIPTOR</b> data structure. Set this member to
4556
<c>sizeof(PIXELFORMATDESCRIPTOR)</c>.
4557
</para>
4558
<para>
4559
<b>nVersion</b><br/>
4560
Specifies the version number of the <b>PIXELFORMATDESCRIPTOR</b> data structure. Set this member to 1.
4561
</para>
4562
<para>
4563
<b>dwFlags</b><br/>
4564
A set of bit flags that specify properties of the pixel buffer. You can combine the following bit
4565
flag constants by using bitwise-OR.<br/><br/>
4566
If any of the following flags are set, the <b>ChoosePixelFormat</b> function attempts to match pixel
4567
formats that also have that flag or flags set. Otherwise, <b>ChoosePixelFormat</b> ignores that flag
4568
in the pixel formats:<br/><br/>
4569
PFD_DRAW_TO_WINDOW<br/>
4570
PFD_DRAW_TO_BITMAP<br/>
4571
PFD_SUPPORT_GDI<br/>
4572
PFD_SUPPORT_OPENGL<br/><br/>
4573
If any of the following flags are set, <b>ChoosePixelFormat</b> attempts to match pixel formats that
4574
also have that flag or flags set. Otherwise, it attempts to match pixel formats without that flag set:<br/><br/>
4575
PFD_DOUBLEBUFFER<br/>
4576
PFD_STEREO<br/><br/>
4577
If the following flag is set, the function ignores the PFD_DOUBLEBUFFER flag in the pixel formats:<br/><br/>
4578
PFD_DOUBLEBUFFER_DONTCARE<br/><br/>
4579
If the following flag is set, the function ignores the PFD_STEREO flag in the pixel formats:<br/><br/>
4580
PFD_STEREO_DONTCARE<br/>
4581
</para>
4582
<para>
4583
<b>iPixelType</b><br/>
4584
Specifies the type of pixel format for the function to consider:<br/><br/>
4585
PFD_TYPE_RGBA<br/>
4586
PFD_TYPE_COLORINDEX<br/>
4587
</para>
4588
<para>
4589
<b>cColorBits</b><br/>
4590
Zero or greater.
4591
</para>
4592
<para>
4593
<b>cRedBits</b><br/>
4594
Not used.
4595
</para>
4596
<para>
4597
<b>cRedShift</b><br/>
4598
Not used.
4599
</para>
4600
<para>
4601
<b>cGreenBits</b><br/>
4602
Not used.
4603
</para>
4604
<para>
4605
<b>cGreenShift</b><br/>
4606
Not used.
4607
</para>
4608
<para>
4609
<b>cBlueBits</b><br/>
4610
Not used.
4611
</para>
4612
<para>
4613
<b>cBlueShift</b><br/>
4614
Not used.
4615
</para>
4616
<para>
4617
<b>cAlphaBits</b><br/>
4618
Zero or greater.
4619
</para>
4620
<para>
4621
<b>cAlphaShift</b><br/>
4622
Not used.
4623
</para>
4624
<para>
4625
<b>cAccumBits</b><br/>
4626
Zero or greater.
4627
</para>
4628
<para>
4629
<b>cAccumRedBits</b><br/>
4630
Not used.
4631
</para>
4632
<para>
4633
<b>cAccumGreenBits</b><br/>
4634
Not used.
4635
</para>
4636
<para>
4637
<b>cAccumBlueBits</b><br/>
4638
Not used.
4639
</para>
4640
<para>
4641
<b>cAccumAlphaBits</b><br/>
4642
Not used.
4643
</para>
4644
<para>
4645
<b>cDepthBits</b><br/>
4646
Zero or greater.
4647
</para>
4648
<para>
4649
<b>cStencilBits</b><br/>
4650
Zero or greater.
4651
</para>
4652
<para>
4653
<b>cAuxBuffers</b><br/>
4654
Zero or greater.
4655
</para>
4656
<para>
4657
<b>iLayerType</b><br/>
4658
Specifies one of the following layer type values:<br/><br/>
4659
PFD_MAIN_PLANE<br/>
4660
PFD_OVERLAY_PLANE<br/>
4661
PFD_UNDERLAY_PLANE<br/>
4662
</para>
4663
<para>
4664
<b>bReserved</b><br/>
4665
Not used.
4666
</para>
4667
<para>
4668
<b>dwLayerMask</b><br/>
4669
Not used.
4670
</para>
4671
<para>
4672
<b>dwVisibleMask</b><br/>
4673
Not used.
4674
</para>
4675
<para>
4676
<b>dwDamageMask</b><br/>
4677
Not used.
4678
</para>
4679
</param>
4680
<returns>
4681
If the function succeeds, the return value is a pixel format index (one-based) that is the closest match
4682
to the given pixel format descriptor.<br/><br/>
4683
If the function fails, the return value is zero. To get extended error information,
4684
call see cref="Kernel.GetLastError" /&gt;.
4685
</returns>
4686
<remarks>
4687
You must ensure that the pixel format matched by the <b>ChoosePixelFormat</b> function satisfies your
4688
requirements. For example, if you request a pixel format with a 24-bit RGB color buffer but the device
4689
context offers only 8-bit RGB color buffers, the function returns a pixel format with an 8-bit RGB color
4690
buffer.<br/><br/>
4691
The following code sample shows how to use <b>ChoosePixelFormat</b> to match a specified pixel
4692
format:<br/><br/>
4693
<code>
4694
HDC hdc;
4695
int pixelFormat;
4696
Gdi.PIXELFORMATDESCRIPTOR pfd;
4697
4698
// size of this pfd
4699
pfd.nSize = (ushort) sizeof(Gdi.PIXELFORMATDESCRIPTOR);
4700
4701
// version number
4702
pfd.nVersion = 1;
4703
4704
// support window, support OpenGL, double buffered
4705
pfd.dwFlags = Gdi.PFD_DRAW_TO_WINDOW | Gdi.PFD_SUPPORT_OPENGL | Gdi.PFD_DOUBLEBUFFER;
4706
4707
// RGBA type
4708
pfd.iPixelType = Gdi.PFD_TYPE_RGBA;
4709
4710
// 24-bit color depth
4711
pfd.cColorBits = 24;
4712
4713
// color bits and shift bits ignored
4714
pfd.cRedBits = 0;
4715
pfd.cRedShift = 0;
4716
pfd.cGreenBits = 0;
4717
pfd.cGreenShift = 0;
4718
pfd.cBlueBits = 0;
4719
pfd.cBlueShift = 0;
4720
pfd.cAlphaBits = 0;
4721
pfd.cAlphaShift = 0;
4722
4723
// no accumulation buffer, accum bits ignored
4724
pfd.cAccumBits = 0;
4725
pfd.cAccumRedBits = 0;
4726
pfd.cAccumGreenBits = 0;
4727
pfd.cAccumBlueBits = 0;
4728
pfd.cAccumAlphaBits = 0;
4729
4730
// no stencil buffer
4731
pfd.cStencilBits = 0;
4732
4733
// no auxiliary buffer
4734
pfd.cAuxBuffers = 0;
4735
4736
// main layer
4737
pfd.iLayerType = Gdi.PFD_MAIN_PLANE;
4738
4739
// reserved
4740
pfd.bReserved = 0;
4741
4742
// layer masks ignored
4743
pfd.dwLayerMask = 0;
4744
pfd.dwVisibleMask = 0;
4745
pfd.dwDamageMask = 0;
4746
4747
pixelFormat = Gdi.ChoosePixelFormat(hdc, &amp;pfd);
4748
</code>
4749
</remarks>
4750
seealso cref="DescribePixelFormat" /&gt;
4751
seealso cref="GetPixelFormat" /&gt;
4752
<seealso cref="M:Tao.Platform.Windows.Gdi.SetPixelFormat(System.IntPtr,System.Int32,Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR@)"/>
4753
</member>
4754
<member name="M:Tao.Platform.Windows.Gdi.SetPixelFormat(System.IntPtr,System.Int32,Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR@)">
4755
<summary>
4756
The <b>SetPixelFormat</b> function sets the pixel format of the specified device context to the format
4757
specified by the <i>iPixelFormat</i> index.
4758
</summary>
4759
<param name="deviceContext">
4760
Specifies the device context whose pixel format the function attempts to set.
4761
</param>
4762
<param name="pixelFormat">
4763
Index that identifies the pixel format to set. The various pixel formats supported by a device
4764
context are identified by one-based indexes.
4765
</param>
4766
<param name="pixelFormatDescriptor">
4767
Pointer to a <see cref="T:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR"/> structure that contains the logical pixel
4768
format specification. The system's metafile component uses this structure to record the logical
4769
pixel format specification. The structure has no other effect upon the behavior of the
4770
<b>SetPixelFormat</b> function.
4771
</param>
4772
<returns>
4773
If the function succeeds, the return value is true.<br/><br/>
4774
If the function fails, the return value is false. To get extended error information, call
4775
see cref="Kernel.GetLastError" /&gt;.
4776
</returns>
4777
<remarks>
4778
If <i>hdc</i> references a window, calling the <b>SetPixelFormat</b> function also changes the pixel format
4779
of the window. Setting the pixel format of a window more than once can lead to significant complications
4780
for the Window Manager and for multithread applications, so it is not allowed. An application can only set
4781
the pixel format of a window one time. Once a window's pixel format is set, it cannot be changed.<br/><br/>
4782
4783
You should select a pixel format in the device context before calling the <see cref="M:Tao.Platform.Windows.Wgl.wglCreateContext(System.IntPtr)"/>
4784
function. The <b>wglCreateContext</b> function creates a rendering context for drawing on the device in the
4785
selected pixel format of the device context.<br/><br/>
4786
4787
An OpenGL window has its own pixel format. Because of this, only device contexts retrieved for the client
4788
area of an OpenGL window are allowed to draw into the window. As a result, an OpenGL window should be created
4789
with the WS_CLIPCHILDREN and WS_CLIPSIBLINGS styles. Additionally, the window class attribute should not
4790
include the CS_PARENTDC style.<br/><br/>
4791
4792
The following code example shows <b>SetPixelFormat</b> usage:<br/><br/>
4793
4794
<code>
4795
HDC hdc;
4796
int pixelFormat;
4797
Gdi.PIXELFORMATDESCRIPTOR pfd;
4798
4799
// size of this pfd
4800
pfd.nSize = (ushort) sizeof(Gdi.PIXELFORMATDESCRIPTOR);
4801
4802
// version number
4803
pfd.nVersion = 1;
4804
4805
// support window, support OpenGL, double buffered
4806
pfd.dwFlags = Gdi.PFD_DRAW_TO_WINDOW | Gdi.PFD_SUPPORT_OPENGL | Gdi.PFD_DOUBLEBUFFER;
4807
4808
// RGBA type
4809
pfd.iPixelType = Gdi.PFD_TYPE_RGBA;
4810
4811
// 24-bit color depth
4812
pfd.cColorBits = 24;
4813
4814
// color bits and shift bits ignored
4815
pfd.cRedBits = 0;
4816
pfd.cRedShift = 0;
4817
pfd.cGreenBits = 0;
4818
pfd.cGreenShift = 0;
4819
pfd.cBlueBits = 0;
4820
pfd.cBlueShift = 0;
4821
pfd.cAlphaBits = 0;
4822
pfd.cAlphaShift = 0;
4823
4824
// no accumulation buffer, accum bits ignored
4825
pfd.cAccumBits = 0;
4826
pfd.cAccumRedBits = 0;
4827
pfd.cAccumGreenBits = 0;
4828
pfd.cAccumBlueBits = 0;
4829
pfd.cAccumAlphaBits = 0;
4830
4831
// no stencil buffer
4832
pfd.cStencilBits = 0;
4833
4834
// no auxiliary buffer
4835
pfd.cAuxBuffers = 0;
4836
4837
// main layer
4838
pfd.iLayerType = Gdi.PFD_MAIN_PLANE;
4839
4840
// reserved
4841
pfd.bReserved = 0;
4842
4843
// layer masks ignored
4844
pfd.dwLayerMask = 0;
4845
pfd.dwVisibleMask = 0;
4846
pfd.dwDamageMask = 0;
4847
4848
pixelFormat = Gdi.ChoosePixelFormat(hdc, &amp;pfd);
4849
4850
// make that the pixel format of the device context
4851
Gdi.SetPixelFormat(hdc, pixelFormat, &amp;pfd);
4852
</code>
4853
</remarks>
4854
<seealso cref="M:Tao.Platform.Windows.Gdi.ChoosePixelFormat(System.IntPtr,Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR@)"/>
4855
seealso cref="DescribePixelFormat" /&gt;
4856
seealso cref="GetPixelFormat" /&gt;
4857
</member>
4858
<member name="M:Tao.Platform.Windows.Gdi.SwapBuffers(System.IntPtr)">
4859
<summary>
4860
4861
</summary>
4862
<param name="deviceContext"></param>
4863
<returns></returns>
4864
</member>
4865
<member name="M:Tao.Platform.Windows.Gdi.SwapBuffersFast(System.IntPtr)">
4866
<summary>
4867
4868
</summary>
4869
<param name="deviceContext"></param>
4870
<returns></returns>
4871
</member>
4872
<member name="M:Tao.Platform.Windows.Gdi.CreateFont(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean,System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.String)">
4873
<summary>
4874
4875
</summary>
4876
<param name="height"></param>
4877
<param name="width"></param>
4878
<param name="escapement"></param>
4879
<param name="orientation"></param>
4880
<param name="weight"></param>
4881
<param name="italic"></param>
4882
<param name="underline"></param>
4883
<param name="strikeOut"></param>
4884
<param name="charSet"></param>
4885
<param name="outputPrecision"></param>
4886
<param name="clipPrecision"></param>
4887
<param name="quality"></param>
4888
<param name="pitchAndFamily"></param>
4889
<param name="typeFace"></param>
4890
<returns></returns>
4891
</member>
4892
<member name="M:Tao.Platform.Windows.Gdi.DeleteObject(System.IntPtr)">
4893
<summary>
4894
4895
</summary>
4896
<param name="objectHandle"></param>
4897
<returns></returns>
4898
</member>
4899
<member name="M:Tao.Platform.Windows.Gdi.SelectObject(System.IntPtr,System.IntPtr)">
4900
<summary>
4901
4902
</summary>
4903
<param name="deviceContext"></param>
4904
<param name="objectHandle"></param>
4905
<returns></returns>
4906
</member>
4907
<member name="M:Tao.Platform.Windows.Gdi.GetDeviceCaps(System.IntPtr,System.Int32)">
4908
<summary>
4909
Retrieves device-specific information for the specified device.
4910
</summary>
4911
<param name="deviceContext">Handle to the DC</param>
4912
<param name="nIndex">Specifies the item to return</param>
4913
<returns></returns>
4914
</member>
4915
<member name="T:Tao.Platform.Windows.Gdi.DEVMODE">
4916
<summary>
4917
<para>
4918
The <b>DEVMODE</b> data structure contains information about the
4919
initialization and environment of a printer or a display device.
4920
</para>
4921
</summary>
4922
<remarks>
4923
<para>
4924
A device driver's private data follows the public portion of the
4925
<b>DEVMODE</b> structure. The size of the public data can vary for different
4926
versions of the structure. The <i>dmSize</i> member specifies the number of
4927
bytes of public data, and the <i>dmDriverExtra</i> member specifies the
4928
number of bytes of private data.
4929
</para>
4930
</remarks>
4931
<seealso cref="M:Tao.Platform.Windows.User.ChangeDisplaySettings(Tao.Platform.Windows.Gdi.DEVMODE@,System.Int32)"/>
4932
<seealso cref="M:Tao.Platform.Windows.User.EnumDisplaySettings(System.String,System.Int32,Tao.Platform.Windows.Gdi.DEVMODE@)"/>
4933
</member>
4934
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmDeviceName">
4935
<summary>
4936
</summary>
4937
</member>
4938
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmSpecVersion">
4939
<summary>
4940
</summary>
4941
</member>
4942
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmDriverVersion">
4943
<summary>
4944
</summary>
4945
</member>
4946
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmSize">
4947
<summary>
4948
</summary>
4949
</member>
4950
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmDriverExtra">
4951
<summary>
4952
</summary>
4953
</member>
4954
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmFields">
4955
<summary>
4956
</summary>
4957
</member>
4958
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmOrientation">
4959
<summary>
4960
4961
</summary>
4962
</member>
4963
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmPaperSize">
4964
<summary>
4965
4966
</summary>
4967
</member>
4968
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmPaperLength">
4969
<summary>
4970
4971
</summary>
4972
</member>
4973
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmPaperWidth">
4974
<summary>
4975
4976
</summary>
4977
</member>
4978
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmScale">
4979
<summary>
4980
4981
</summary>
4982
</member>
4983
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmCopies">
4984
<summary>
4985
4986
</summary>
4987
</member>
4988
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmDefaultSource">
4989
<summary>
4990
4991
</summary>
4992
</member>
4993
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmPrintQuality">
4994
<summary>
4995
4996
</summary>
4997
</member>
4998
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmColor">
4999
<summary>
5000
5001
</summary>
5002
</member>
5003
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmDuplex">
5004
<summary>
5005
5006
</summary>
5007
</member>
5008
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmYResolution">
5009
<summary>
5010
5011
</summary>
5012
</member>
5013
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmTTOption">
5014
<summary>
5015
5016
</summary>
5017
</member>
5018
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmCollate">
5019
<summary>
5020
5021
</summary>
5022
</member>
5023
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmFormName">
5024
<summary>
5025
5026
</summary>
5027
</member>
5028
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmLogPixels">
5029
<summary>
5030
5031
</summary>
5032
</member>
5033
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmBitsPerPel">
5034
<summary>
5035
</summary>
5036
</member>
5037
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmPelsWidth">
5038
<summary>
5039
</summary>
5040
</member>
5041
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmPelsHeight">
5042
<summary>
5043
</summary>
5044
</member>
5045
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmDisplayFlags">
5046
<summary>
5047
</summary>
5048
</member>
5049
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmDisplayFrequency">
5050
<summary>
5051
5052
</summary>
5053
</member>
5054
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmICMMethod">
5055
<summary>
5056
</summary>
5057
</member>
5058
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmICMIntent">
5059
<summary>
5060
</summary>
5061
</member>
5062
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmMediaType">
5063
<summary>
5064
5065
</summary>
5066
</member>
5067
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmDitherType">
5068
<summary>
5069
</summary>
5070
</member>
5071
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmReserved1">
5072
<summary>
5073
</summary>
5074
</member>
5075
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmReserved2">
5076
<summary>
5077
5078
</summary>
5079
</member>
5080
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmPanningWidth">
5081
<summary>
5082
</summary>
5083
</member>
5084
<member name="F:Tao.Platform.Windows.Gdi.DEVMODE.dmPanningHeight">
5085
<summary>
5086
</summary>
5087
</member>
5088
<member name="T:Tao.Platform.Windows.Gdi.GLYPHMETRICSFLOAT">
5089
<summary>
5090
The <b>GLYPHMETRICSFLOAT</b> structure contains information about the placement and orientation of a glyph in a
5091
character cell.
5092
</summary>
5093
<remarks>The values of <b>GLYPHMETRICSFLOAT</b> are specified as notional units.</remarks>
5094
<seealso cref="T:Tao.Platform.Windows.Gdi.POINTFLOAT"/>
5095
<seealso cref="M:Tao.Platform.Windows.Wgl.wglUseFontOutlinesA(System.IntPtr,System.Int32,System.Int32,System.Int32,System.Single,System.Single,System.Int32,Tao.Platform.Windows.Gdi.GLYPHMETRICSFLOAT[])"/>
5096
</member>
5097
<member name="F:Tao.Platform.Windows.Gdi.GLYPHMETRICSFLOAT.gmfBlackBoxX">
5098
<summary>
5099
Specifies the width of the smallest rectangle (the glyph's black box) that completely encloses the glyph.
5100
</summary>
5101
</member>
5102
<member name="F:Tao.Platform.Windows.Gdi.GLYPHMETRICSFLOAT.gmfBlackBoxY">
5103
<summary>
5104
Specifies the height of the smallest rectangle (the glyph's black box) that completely encloses the glyph.
5105
</summary>
5106
</member>
5107
<member name="F:Tao.Platform.Windows.Gdi.GLYPHMETRICSFLOAT.gmfptGlyphOrigin">
5108
<summary>
5109
Specifies the x and y coordinates of the upper-left corner of the smallest rectangle that completely encloses the glyph.
5110
</summary>
5111
</member>
5112
<member name="F:Tao.Platform.Windows.Gdi.GLYPHMETRICSFLOAT.gmfCellIncX">
5113
<summary>
5114
Specifies the horizontal distance from the origin of the current character cell to the origin of the next character cell.
5115
</summary>
5116
</member>
5117
<member name="F:Tao.Platform.Windows.Gdi.GLYPHMETRICSFLOAT.gmfCellIncY">
5118
<summary>
5119
Specifies the vertical distance from the origin of the current character cell to the origin of the next character cell.
5120
</summary>
5121
</member>
5122
<member name="T:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR">
5123
<summary>
5124
The <b>PIXELFORMATDESCRIPTOR</b> structure describes the pixel format of a drawing surface.
5125
</summary>
5126
<remarks>
5127
Please notice carefully, as documented in the members, that certain pixel format properties are not supported
5128
in the current generic implementation. The generic implementation is the Microsoft GDI software
5129
implementation of OpenGL. Hardware manufacturers may enhance parts of OpenGL, and may support some
5130
pixel format properties not supported by the generic implementation.
5131
</remarks>
5132
<seealso cref="M:Tao.Platform.Windows.Gdi.ChoosePixelFormat(System.IntPtr,Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR@)"/>
5133
seealso cref="DescribePixelFormat" /&gt;
5134
seealso cref="GetPixelFormat" /&gt;
5135
<seealso cref="M:Tao.Platform.Windows.Gdi.SetPixelFormat(System.IntPtr,System.Int32,Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR@)"/>
5136
</member>
5137
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.nSize">
5138
<summary>
5139
Specifies the size of this data structure. This value should be set to <c>sizeof(PIXELFORMATDESCRIPTOR)</c>.
5140
</summary>
5141
</member>
5142
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.nVersion">
5143
<summary>
5144
Specifies the version of this data structure. This value should be set to 1.
5145
</summary>
5146
</member>
5147
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.dwFlags">
5148
<summary>
5149
A set of bit flags that specify properties of the pixel buffer. The properties are generally not mutually exclusive;
5150
you can set any combination of bit flags, with the exceptions noted.
5151
</summary>
5152
<remarks>
5153
<para>The following bit flag constants are defined:</para>
5154
<list type="table">
5155
<listheader>
5156
<term>Value</term>
5157
<description>Meaning</description>
5158
</listheader>
5159
<item>
5160
<term>PFD_DRAW_TO_WINDOW</term>
5161
<description>The buffer can draw to a window or device surface.</description>
5162
</item>
5163
<item>
5164
<term>PFD_DRAW_TO_BITMAP</term>
5165
<description>The buffer can draw to a memory bitmap.</description>
5166
</item>
5167
<item>
5168
<term>PFD_SUPPORT_GDI</term>
5169
<description>
5170
The buffer supports GDI drawing. This flag and PFD_DOUBLEBUFFER are mutually exclusive
5171
in the current generic implementation.
5172
</description>
5173
</item>
5174
<item>
5175
<term>PFD_SUPPORT_OPENGL</term>
5176
<description>The buffer supports OpenGL drawing.</description>
5177
</item>
5178
<item>
5179
<term>PFD_GENERIC_ACCELERATED</term>
5180
<description>
5181
The pixel format is supported by a device driver that accelerates the generic implementation.
5182
If this flag is clear and the PFD_GENERIC_FORMAT flag is set, the pixel format is supported by
5183
the generic implementation only.
5184
</description>
5185
</item>
5186
<item>
5187
<term>PFD_GENERIC_FORMAT</term>
5188
<description>
5189
The pixel format is supported by the GDI software implementation, which is also known as the
5190
generic implementation. If this bit is clear, the pixel format is supported by a device
5191
driver or hardware.
5192
</description>
5193
</item>
5194
<item>
5195
<term>PFD_NEED_PALETTE</term>
5196
<description>
5197
The buffer uses RGBA pixels on a palette-managed device. A logical palette is required to achieve
5198
the best results for this pixel type. Colors in the palette should be specified according to the
5199
values of the <b>cRedBits</b>, <b>cRedShift</b>, <b>cGreenBits</b>, <b>cGreenShift</b>,
5200
<b>cBluebits</b>, and <b>cBlueShift</b> members. The palette should be created and realized in
5201
the device context before calling <see cref="M:Tao.Platform.Windows.Wgl.wglMakeCurrent(System.IntPtr,System.IntPtr)"/>.
5202
</description>
5203
</item>
5204
<item>
5205
<term>PFD_NEED_SYSTEM_PALETTE</term>
5206
<description>
5207
Defined in the pixel format descriptors of hardware that supports one hardware palette in
5208
256-color mode only. For such systems to use hardware acceleration, the hardware palette must be in
5209
a fixed order (for example, 3-3-2) when in RGBA mode or must match the logical palette when in
5210
color-index mode.
5211
5212
When this flag is set, you must call SetSystemPaletteUse in your program to force a one-to-one
5213
mapping of the logical palette and the system palette. If your OpenGL hardware supports multiple
5214
hardware palettes and the device driver can allocate spare hardware palettes for OpenGL, this
5215
flag is typically clear.
5216
5217
This flag is not set in the generic pixel formats.
5218
</description>
5219
</item>
5220
<item>
5221
<term>PFD_DOUBLEBUFFER</term>
5222
<description>
5223
The buffer is double-buffered. This flag and PFD_SUPPORT_GDI are mutually exclusive in the
5224
current generic implementation.
5225
</description>
5226
</item>
5227
<item>
5228
<term>PFD_STEREO</term>
5229
<description>
5230
The buffer is stereoscopic. This flag is not supported in the current generic implementation.
5231
</description>
5232
</item>
5233
<item>
5234
<term>PFD_SWAP_LAYER_BUFFERS</term>
5235
<description>
5236
Indicates whether a device can swap individual layer planes with pixel formats that include
5237
double-buffered overlay or underlay planes. Otherwise all layer planes are swapped together
5238
as a group. When this flag is set, <b>wglSwapLayerBuffers</b> is supported.
5239
</description>
5240
</item>
5241
</list>
5242
<para>You can specify the following bit flags when calling <see cref="M:Tao.Platform.Windows.Gdi.ChoosePixelFormat(System.IntPtr,Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR@)"/>.</para>
5243
<list type="table">
5244
<listheader>
5245
<term>Value</term>
5246
<description>Meaning</description>
5247
</listheader>
5248
<item>
5249
<term>PFD_DEPTH_DONTCARE</term>
5250
<description>
5251
The requested pixel format can either have or not have a depth buffer. To select
5252
a pixel format without a depth buffer, you must specify this flag. The requested pixel format
5253
can be with or without a depth buffer. Otherwise, only pixel formats with a depth buffer
5254
are considered.
5255
</description>
5256
</item>
5257
<item>
5258
<term>PFD_DOUBLEBUFFER_DONTCARE</term>
5259
<description>The requested pixel format can be either single- or double-buffered.</description>
5260
</item>
5261
<item>
5262
<term>PFD_STEREO_DONTCARE</term>
5263
<description>The requested pixel format can be either monoscopic or stereoscopic.</description>
5264
</item>
5265
</list>
5266
<para>
5267
With the <b>glAddSwapHintRectWIN</b> extension function, two new flags are included for the
5268
<b>PIXELFORMATDESCRIPTOR</b> pixel format structure.
5269
</para>
5270
<list type="table">
5271
<listheader>
5272
<term>Value</term>
5273
<description>Meaning</description>
5274
</listheader>
5275
<item>
5276
<term>PFD_SWAP_COPY</term>
5277
<description>
5278
Specifies the content of the back buffer in the double-buffered main color plane following
5279
a buffer swap. Swapping the color buffers causes the content of the back buffer to be copied
5280
to the front buffer. The content of the back buffer is not affected by the swap. PFD_SWAP_COPY
5281
is a hint only and might not be provided by a driver.
5282
</description>
5283
</item>
5284
<item>
5285
<term>PFD_SWAP_EXCHANGE</term>
5286
<description>
5287
Specifies the content of the back buffer in the double-buffered main color plane following a
5288
buffer swap. Swapping the color buffers causes the exchange of the back buffer's content
5289
with the front buffer's content. Following the swap, the back buffer's content contains the
5290
front buffer's content before the swap. PFD_SWAP_EXCHANGE is a hint only and might not be
5291
provided by a driver.
5292
</description>
5293
</item>
5294
</list>
5295
</remarks>
5296
</member>
5297
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.iPixelType">
5298
<summary>
5299
Specifies the type of pixel data. The following types are defined.
5300
</summary>
5301
<remarks>
5302
<list type="table">
5303
<listheader>
5304
<term>Value</term>
5305
<description>Meaning</description>
5306
</listheader>
5307
<item>
5308
<term>PFD_TYPE_RGBA</term>
5309
<description>
5310
RGBA pixels. Each pixel has four components in this order: red, green, blue, and alpha.
5311
</description>
5312
</item>
5313
<item>
5314
<term>PFD_TYPE_COLORINDEX</term>
5315
<description>Color-index pixels. Each pixel uses a color-index value.</description>
5316
</item>
5317
</list>
5318
</remarks>
5319
</member>
5320
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.cColorBits">
5321
<summary>
5322
Specifies the number of color bitplanes in each color buffer. For RGBA pixel types, it is the size
5323
of the color buffer, excluding the alpha bitplanes. For color-index pixels, it is the size of the
5324
color-index buffer.
5325
</summary>
5326
</member>
5327
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.cRedBits">
5328
<summary>
5329
Specifies the number of red bitplanes in each RGBA color buffer.
5330
</summary>
5331
</member>
5332
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.cRedShift">
5333
<summary>
5334
Specifies the shift count for red bitplanes in each RGBA color buffer.
5335
</summary>
5336
</member>
5337
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.cGreenBits">
5338
<summary>
5339
Specifies the number of green bitplanes in each RGBA color buffer.
5340
</summary>
5341
</member>
5342
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.cGreenShift">
5343
<summary>
5344
Specifies the shift count for green bitplanes in each RGBA color buffer.
5345
</summary>
5346
</member>
5347
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.cBlueBits">
5348
<summary>
5349
Specifies the number of blue bitplanes in each RGBA color buffer.
5350
</summary>
5351
</member>
5352
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.cBlueShift">
5353
<summary>
5354
Specifies the shift count for blue bitplanes in each RGBA color buffer.
5355
</summary>
5356
</member>
5357
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.cAlphaBits">
5358
<summary>
5359
Specifies the number of alpha bitplanes in each RGBA color buffer. Alpha bitplanes are not supported.
5360
</summary>
5361
</member>
5362
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.cAlphaShift">
5363
<summary>
5364
Specifies the shift count for alpha bitplanes in each RGBA color buffer. Alpha bitplanes are not supported.
5365
</summary>
5366
</member>
5367
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.cAccumBits">
5368
<summary>
5369
Specifies the total number of bitplanes in the accumulation buffer.
5370
</summary>
5371
</member>
5372
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.cAccumRedBits">
5373
<summary>
5374
Specifies the number of red bitplanes in the accumulation buffer.
5375
</summary>
5376
</member>
5377
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.cAccumGreenBits">
5378
<summary>
5379
Specifies the number of green bitplanes in the accumulation buffer.
5380
</summary>
5381
</member>
5382
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.cAccumBlueBits">
5383
<summary>
5384
Specifies the number of blue bitplanes in the accumulation buffer.
5385
</summary>
5386
</member>
5387
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.cAccumAlphaBits">
5388
<summary>
5389
Specifies the number of alpha bitplanes in the accumulation buffer.
5390
</summary>
5391
</member>
5392
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.cDepthBits">
5393
<summary>
5394
Specifies the depth of the depth (z-axis) buffer.
5395
</summary>
5396
</member>
5397
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.cStencilBits">
5398
<summary>
5399
Specifies the depth of the stencil buffer.
5400
</summary>
5401
</member>
5402
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.cAuxBuffers">
5403
<summary>
5404
Specifies the number of auxiliary buffers. Auxiliary buffers are not supported.
5405
</summary>
5406
</member>
5407
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.iLayerType">
5408
<summary>
5409
Ignored. Earlier implementations of OpenGL used this member, but it is no longer used.
5410
</summary>
5411
<remarks>Specifies the type of layer.</remarks>
5412
</member>
5413
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.bReserved">
5414
<summary>
5415
Specifies the number of overlay and underlay planes. Bits 0 through 3 specify up to 15 overlay planes and
5416
bits 4 through 7 specify up to 15 underlay planes.
5417
</summary>
5418
</member>
5419
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.dwLayerMask">
5420
<summary>
5421
Ignored. Earlier implementations of OpenGL used this member, but it is no longer used.
5422
</summary>
5423
<remarks>
5424
Specifies the layer mask. The layer mask is used in conjunction with the visible mask to determine
5425
if one layer overlays another.
5426
</remarks>
5427
</member>
5428
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.dwVisibleMask">
5429
<summary>
5430
Specifies the transparent color or index of an underlay plane. When the pixel type is RGBA, <b>dwVisibleMask</b>
5431
is a transparent RGB color value. When the pixel type is color index, it is a transparent index value.
5432
</summary>
5433
</member>
5434
<member name="F:Tao.Platform.Windows.Gdi.PIXELFORMATDESCRIPTOR.dwDamageMask">
5435
<summary>
5436
Ignored. Earlier implementations of OpenGL used this member, but it is no longer used.
5437
</summary>
5438
<remarks>
5439
Specifies whether more than one pixel format shares the same frame buffer. If the result of the bitwise
5440
AND of the damage masks between two pixel formats is nonzero, then they share the same buffers.
5441
</remarks>
5442
</member>
5443
<member name="T:Tao.Platform.Windows.Gdi.POINTFLOAT">
5444
<summary>
5445
The <b>POINTFLOAT</b> structure contains the x and y coordinates of a point.
5446
</summary>
5447
<seealso cref="T:Tao.Platform.Windows.Gdi.GLYPHMETRICSFLOAT"/>
5448
</member>
5449
<member name="F:Tao.Platform.Windows.Gdi.POINTFLOAT.X">
5450
<summary>
5451
Specifies the horizontal (x) coordinate of a point.
5452
</summary>
5453
</member>
5454
<member name="F:Tao.Platform.Windows.Gdi.POINTFLOAT.Y">
5455
<summary>
5456
Specifies the vertical (y) coordinate of a point.
5457
</summary>
5458
</member>
5459
<member name="T:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR">
5460
<summary>
5461
5462
</summary>
5463
</member>
5464
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.nSize">
5465
<summary>
5466
5467
</summary>
5468
</member>
5469
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.nVersion">
5470
<summary>
5471
5472
</summary>
5473
</member>
5474
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.dwFlags">
5475
<summary>
5476
5477
</summary>
5478
</member>
5479
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.iPixelType">
5480
<summary>
5481
5482
</summary>
5483
</member>
5484
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.cColorBits">
5485
<summary>
5486
5487
</summary>
5488
</member>
5489
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.cRedBits">
5490
<summary>
5491
5492
</summary>
5493
</member>
5494
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.cRedShift">
5495
<summary>
5496
5497
</summary>
5498
</member>
5499
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.cGreenBits">
5500
<summary>
5501
5502
</summary>
5503
</member>
5504
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.cGreenShift">
5505
<summary>
5506
5507
</summary>
5508
</member>
5509
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.cBlueBits">
5510
<summary>
5511
5512
</summary>
5513
</member>
5514
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.cBlueShift">
5515
<summary>
5516
5517
</summary>
5518
</member>
5519
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.cAlphaBits">
5520
<summary>
5521
5522
</summary>
5523
</member>
5524
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.cAlphaShift">
5525
<summary>
5526
5527
</summary>
5528
</member>
5529
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.cAccumBits">
5530
<summary>
5531
5532
</summary>
5533
</member>
5534
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.cAccumRedBits">
5535
<summary>
5536
5537
</summary>
5538
</member>
5539
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.cAccumGreenBits">
5540
<summary>
5541
5542
</summary>
5543
</member>
5544
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.cAccumBlueBits">
5545
<summary>
5546
5547
</summary>
5548
</member>
5549
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.cAccumAlphaBits">
5550
<summary>
5551
5552
</summary>
5553
</member>
5554
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.cDepthBits">
5555
<summary>
5556
5557
</summary>
5558
</member>
5559
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.cStencilBits">
5560
<summary>
5561
5562
</summary>
5563
</member>
5564
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.cAuxBuffers">
5565
<summary>
5566
5567
</summary>
5568
</member>
5569
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.iLayerPlane">
5570
<summary>
5571
5572
</summary>
5573
</member>
5574
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.bReserved">
5575
<summary>
5576
5577
</summary>
5578
</member>
5579
<member name="F:Tao.Platform.Windows.Gdi.LAYERPLANEDESCRIPTOR.crTransparent">
5580
<summary>
5581
5582
</summary>
5583
</member>
5584
<member name="T:Tao.Platform.Windows.Gdi.DevCaps">
5585
<summary>
5586
Flags for <see cref="M:Tao.Platform.Windows.Gdi.GetDeviceCaps(System.IntPtr,System.Int32)"/>
5587
</summary>
5588
</member>
5589
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.DRIVERVERSION">
5590
<summary>
5591
Device driver version
5592
</summary>
5593
</member>
5594
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.TECHNOLOGY">
5595
<summary>
5596
Device classification
5597
</summary>
5598
</member>
5599
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.HORZSIZE">
5600
<summary>
5601
Horizontal size in millimeters
5602
</summary>
5603
</member>
5604
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.VERTSIZE">
5605
<summary>
5606
Vertical size in millimeters
5607
</summary>
5608
</member>
5609
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.HORZRES">
5610
<summary>
5611
Horizontal width in pixels
5612
</summary>
5613
</member>
5614
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.VERTRES">
5615
<summary>
5616
Vertical height in pixels
5617
</summary>
5618
</member>
5619
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.BITSPIXEL">
5620
<summary>
5621
Number of bits per pixel
5622
</summary>
5623
</member>
5624
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.PLANES">
5625
<summary>
5626
Number of planes
5627
</summary>
5628
</member>
5629
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.NUMBRUSHES">
5630
<summary>
5631
Number of brushes the device has
5632
</summary>
5633
</member>
5634
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.NUMPENS">
5635
<summary>
5636
Number of pens the device has
5637
</summary>
5638
</member>
5639
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.NUMMARKERS">
5640
<summary>
5641
Number of markers the device has
5642
</summary>
5643
</member>
5644
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.NUMFONTS">
5645
<summary>
5646
Number of fonts the device has
5647
</summary>
5648
</member>
5649
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.NUMCOLORS">
5650
<summary>
5651
Number of colors the device supports
5652
</summary>
5653
</member>
5654
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.PDEVICESIZE">
5655
<summary>
5656
Size required for device descriptor
5657
</summary>
5658
</member>
5659
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.CURVECAPS">
5660
<summary>
5661
Curve capabilities
5662
</summary>
5663
</member>
5664
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.LINECAPS">
5665
<summary>
5666
Line capabilities
5667
</summary>
5668
</member>
5669
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.POLYGONALCAPS">
5670
<summary>
5671
Polygonal capabilities
5672
</summary>
5673
</member>
5674
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.TEXTCAPS">
5675
<summary>
5676
Text capabilities
5677
</summary>
5678
</member>
5679
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.CLIPCAPS">
5680
<summary>
5681
Clipping capabilities
5682
</summary>
5683
</member>
5684
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.RASTERCAPS">
5685
<summary>
5686
Bitblt capabilities
5687
</summary>
5688
</member>
5689
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.ASPECTX">
5690
<summary>
5691
Length of the X leg
5692
</summary>
5693
</member>
5694
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.ASPECTY">
5695
<summary>
5696
Length of the Y leg
5697
</summary>
5698
</member>
5699
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.ASPECTXY">
5700
<summary>
5701
Length of the hypotenuse
5702
</summary>
5703
</member>
5704
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.SHADEBLENDCAPS">
5705
<summary>
5706
Shading and Blending caps
5707
</summary>
5708
</member>
5709
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.LOGPIXELSX">
5710
<summary>
5711
Logical pixels inch in X
5712
</summary>
5713
</member>
5714
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.LOGPIXELSY">
5715
<summary>
5716
Logical pixels inch in Y
5717
</summary>
5718
</member>
5719
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.SIZEPALETTE">
5720
<summary>
5721
Number of entries in physical palette
5722
</summary>
5723
</member>
5724
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.NUMRESERVED">
5725
<summary>
5726
Number of reserved entries in palette
5727
</summary>
5728
</member>
5729
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.COLORRES">
5730
<summary>
5731
Actual color resolution
5732
</summary>
5733
</member>
5734
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.PHYSICALWIDTH">
5735
<summary>
5736
Physical Width in device units
5737
</summary>
5738
</member>
5739
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.PHYSICALHEIGHT">
5740
<summary>
5741
Physical Height in device units
5742
</summary>
5743
</member>
5744
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.PHYSICALOFFSETX">
5745
<summary>
5746
Physical Printable Area x margin
5747
</summary>
5748
</member>
5749
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.PHYSICALOFFSETY">
5750
<summary>
5751
Physical Printable Area y margin
5752
</summary>
5753
</member>
5754
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.SCALINGFACTORX">
5755
<summary>
5756
Scaling factor x
5757
</summary>
5758
</member>
5759
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.SCALINGFACTORY">
5760
<summary>
5761
Scaling factor y
5762
</summary>
5763
</member>
5764
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.VREFRESH">
5765
<summary>
5766
Current vertical refresh rate of the display device (for displays only) in Hz
5767
</summary>
5768
</member>
5769
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.DESKTOPVERTRES">
5770
<summary>
5771
Horizontal width of entire desktop in pixels
5772
</summary>
5773
</member>
5774
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.DESKTOPHORZRES">
5775
<summary>
5776
Vertical height of entire desktop in pixels
5777
</summary>
5778
</member>
5779
<member name="F:Tao.Platform.Windows.Gdi.DevCaps.BLTALIGNMENT">
5780
<summary>
5781
Preferred blt alignment
5782
</summary>
5783
</member>
5784
</members>
5785
</doc>
5786
5787