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