]>
Commit | Line | Data |
---|---|---|
1 | ///////////////////////////////////////////////////////////////////////////// | |
2 | // Name: vidmode.h | |
3 | // Purpose: interface of wxVideoMode | |
4 | // Author: wxWidgets team | |
5 | // RCS-ID: $Id: display.h 52634 2008-03-20 13:45:17Z VS $ | |
6 | // Licence: wxWindows license | |
7 | ///////////////////////////////////////////////////////////////////////////// | |
8 | ||
9 | /** | |
10 | @struct wxVideoMode | |
11 | @wxheader{display.h} | |
12 | ||
13 | Determines the sizes and locations of displays connected to the system. | |
14 | ||
15 | @library{wxcore} | |
16 | @category{misc} | |
17 | ||
18 | @stdobjects | |
19 | ::wxDefaultVideoMode | |
20 | ||
21 | @see wxClientDisplayRect(), wxDisplaySize(), wxDisplaySizeMM() | |
22 | */ | |
23 | struct wxVideoMode | |
24 | { | |
25 | public: | |
26 | /** | |
27 | Constructs this class using the given parameters. | |
28 | */ | |
29 | wxVideoMode(int width = 0, int height = 0, int depth = 0, int freq = 0); | |
30 | ||
31 | bool operator==(const wxVideoMode& m) const | |
32 | bool operator!=(const wxVideoMode& mode) const | |
33 | ||
34 | /** | |
35 | Returns true if this mode matches the other one in the sense that all | |
36 | non zero fields of the other mode have the same value in this one | |
37 | (except for refresh which is allowed to have a greater value). | |
38 | */ | |
39 | bool Matches(const wxVideoMode& other) const; | |
40 | ||
41 | /** | |
42 | Returns the screen width in pixels (e.g. 640), 0 means unspecified. | |
43 | */ | |
44 | int GetWidth() const; | |
45 | ||
46 | /** | |
47 | Returns the screen height in pixels (e.g. 480), 0 means unspecified. | |
48 | */ | |
49 | int GetHeight() const; | |
50 | ||
51 | /** | |
52 | Returns bits per pixel (e.g. 32), 1 is monochrome and 0 means | |
53 | unspecified/known. | |
54 | */ | |
55 | int GetDepth() const; | |
56 | ||
57 | /** | |
58 | Returns true if the object has been initialized | |
59 | */ | |
60 | bool IsOk() const; | |
61 | ||
62 | /** | |
63 | The screen width in pixels (e.g. 640), 0 means unspecified. | |
64 | */ | |
65 | int w; | |
66 | ||
67 | /** | |
68 | The screen height in pixels (e.g. 480), 0 means unspecified. | |
69 | */ | |
70 | int h; | |
71 | ||
72 | /** | |
73 | Bits per pixel (e.g. 32), 1 is monochrome and 0 means | |
74 | unspecified/known. | |
75 | */ | |
76 | int bpp; | |
77 | ||
78 | /** | |
79 | Refresh frequency in Hz, 0 means unspecified/unknown. | |
80 | */ | |
81 | int refresh; | |
82 | }; | |
83 | ||
84 | /** | |
85 | A global wxVideoMode instance used by wxDisplay. | |
86 | */ | |
87 | wxVideoMode wxDefaultVideoMode; | |
88 |