reverted wxVideoMode API breakage by r53049, finished documentation for it

[wxWidgets.git] / interface / vidmode.h

diff --git a/interface/vidmode.h b/interface/vidmode.h
index 2fcfa70c286a6244325b32965cd1c7f8cf73e4dc..43215eb0fd32b2c1fea840fbaaf05ee118d75997 100644 (file)
--- a/interface/vidmode.h
+++ b/interface/vidmode.h
@@ -7,7 +7,7 @@
 /////////////////////////////////////////////////////////////////////////////
 
 /**
-    @class wxVideoMode
+    @struct wxVideoMode
     @wxheader{display.h}
 
     Determines the sizes and locations of displays connected to the system.
@@ -20,7 +20,7 @@
 
     @see wxClientDisplayRect(), wxDisplaySize(), wxDisplaySizeMM()
 */
-class wxVideoMode
+struct wxVideoMode
 {
 public:
     /**
@@ -38,14 +38,38 @@ public:
     */
     bool Matches(const wxVideoMode& other) const;
 
+    /**
+        Returns the screen width in pixels (e.g. 640), 0 means unspecified.
+    */
     int GetWidth() const;
+
+    /**
+        Returns the screen height in pixels (e.g. 480), 0 means unspecified.
+    */
     int GetHeight() const;
+
+    /**
+        Returns bits per pixel (e.g. 32), 1 is monochrome and 0 means
+        unspecified/known.
+    */
     int GetDepth() const;
 
     /**
         Returns true if the object has been initialized
     */
     bool IsOk() const;
+
+    /// The screen width in pixels (e.g. 640), 0 means unspecified.
+    int w;
+
+    /// The screen height in pixels (e.g. 480), 0 means unspecified.
+    int h;
+
+    /// Bits per pixel (e.g. 32), 1 is monochrome and 0 means unspecified/known.
+    int bpp;
+
+    /// Refresh frequency in Hz, 0 means unspecified/unknown.
+    int refresh;
 };
 
 /**