interface/wx/vidmode.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        vidmode.h
   3 // Purpose:     interface of wxVideoMode
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @struct wxVideoMode
  11
  12     Determines the sizes and locations of displays connected to the system.
  13
  14     @library{wxcore}
  15     @category{cfg}
  16
  17     @stdobjects
  18     ::wxDefaultVideoMode
  19
  20     @see wxClientDisplayRect(), wxDisplaySize(), wxDisplaySizeMM()
  21 */
  22 struct wxVideoMode
  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
  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
  37     /**
  38         Returns the screen width in pixels (e.g.\ 640), 0 means unspecified.
  39     */
  40     int GetWidth() const;
  41
  42     /**
  43         Returns the screen height in pixels (e.g.\ 480), 0 means unspecified.
  44     */
  45     int GetHeight() const;
  46
  47     /**
  48         Returns bits per pixel (e.g.\ 32), 1 is monochrome and 0 means
  49         unspecified/known.
  50     */
  51     int GetDepth() const;
  52
  53     /**
  54         Returns true if the object has been initialized
  55     */
  56     bool IsOk() const;
  57
  58
  59     bool operator==(const wxVideoMode& m) const;
  60     bool operator!=(const wxVideoMode& mode) const;
  61
  62
  63
  64     /**
  65         The screen width in pixels (e.g.\ 640), 0 means unspecified.
  66     */
  67     int w;
  68
  69     /**
  70         The screen height in pixels (e.g.\ 480), 0 means unspecified.
  71     */
  72     int h;
  73
  74     /**
  75         Bits per pixel (e.g.\ 32), 1 is monochrome and 0 means
  76         unspecified/known.
  77     */
  78     int bpp;
  79
  80     /**
  81         Refresh frequency in Hz, 0 means unspecified/unknown.
  82     */
  83     int refresh;
  84 };
  85
  86 /**
  87     A global wxVideoMode instance used by wxDisplay.
  88 */
  89 const wxVideoMode wxDefaultVideoMode;
  90