src/ash/display/display_info.h

   1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef ASH_DISPLAY_DISPLAY_INFO_H_
   6 #define ASH_DISPLAY_DISPLAY_INFO_H_
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "ash/ash_export.h"
  12 #include "ui/display/types/display_constants.h"
  13 #include "ui/gfx/display.h"
  14 #include "ui/gfx/insets.h"
  15 #include "ui/gfx/rect.h"
  16
  17 namespace ash {
  18
  19 // A struct that represents the display's mode info.
  20 struct ASH_EXPORT DisplayMode {
  21   DisplayMode();
  22   DisplayMode(const gfx::Size& size,
  23               float refresh_rate,
  24               bool interlaced,
  25               bool native);
  26
  27   gfx::Size size;      // Physical pixel size of the display.
  28   float refresh_rate;  // Refresh rate of the display, in Hz.
  29   bool interlaced;     // True if mode is interlaced.
  30   bool native;         // True if mode is native mode of the display.
  31 };
  32
  33 // DisplayInfo contains metadata for each display. This is used to
  34 // create |gfx::Display| as well as to maintain extra infomation
  35 // to manage displays in ash environment.
  36 // This class is intentionally made copiable.
  37 class ASH_EXPORT DisplayInfo {
  38  public:
  39   // Creates a DisplayInfo from string spec. 100+200-1440x800 creates display
  40   // whose size is 1440x800 at the location (100, 200) in host coordinates.
  41   // The format is
  42   //
  43   // [origin-]widthxheight[*device_scale_factor][#resolutions list]
  44   //     [/<properties>][@ui-scale]
  45   //
  46   // where [] are optional:
  47   // - |origin| is given in x+y- format.
  48   // - |device_scale_factor| is either 2 or 1 (or empty).
  49   // - properties can combination of 'o', which adds default overscan insets
  50   //   (5%), and one rotation property where 'r' is 90 degree clock-wise
  51   //   (to the 'r'ight) 'u' is 180 degrees ('u'pside-down) and 'l' is
  52   //   270 degrees (to the 'l'eft).
  53   // - ui-scale is floating value, e.g. @1.5 or @1.25.
  54   // - |resolution list| is the list of size that is given in
  55   //   |width x height [% refresh_rate]| separated by '|'.
  56   //
  57   // A couple of examples:
  58   // "100x100"
  59   //      100x100 window at 0,0 origin. 1x device scale factor. no overscan.
  60   //      no rotation. 1.0 ui scale.
  61   // "5+5-300x200*2"
  62   //      300x200 window at 5,5 origin. 2x device scale factor.
  63   //      no overscan, no rotation. 1.0 ui scale.
  64   // "300x200/ol"
  65   //      300x200 window at 0,0 origin. 1x device scale factor.
  66   //      with 5% overscan. rotated to left (90 degree counter clockwise).
  67   //      1.0 ui scale.
  68   // "10+20-300x200/u@1.5"
  69   //      300x200 window at 10,20 origin. 1x device scale factor.
  70   //      no overscan. flipped upside-down (180 degree) and 1.5 ui scale.
  71   // "200x100#300x200|200x100%59.0|100x100%60"
  72   //      200x100 window at 0,0 origin, with 3 possible resolutions,
  73   //      300x200, 200x100 at 59 Hz, and 100x100 at 60 Hz.
  74   static DisplayInfo CreateFromSpec(const std::string& spec);
  75
  76   // Creates a DisplayInfo from string spec using given |id|.
  77   static DisplayInfo CreateFromSpecWithID(const std::string& spec,
  78                                           int64 id);
  79
  80   DisplayInfo();
  81   DisplayInfo(int64 id, const std::string& name, bool has_overscan);
  82   ~DisplayInfo();
  83
  84   // When this is set to true, Chrome switches High DPI when lower UI scale
  85   // (<1.0f) is specified on 1x device to make UI sharp, e.g, upgrade 0.6
  86   // scale on 1x DSF to 1.2 scale on 2x DSF.
  87   static void SetAllowUpgradeToHighDPI(bool enable);
  88
  89   int64 id() const { return id_; }
  90
  91   // The name of the display.
  92   const std::string& name() const { return name_; }
  93
  94   // True if the display EDID has the overscan flag. This does not create the
  95   // actual overscan automatically, but used in the message.
  96   bool has_overscan() const { return has_overscan_; }
  97
  98   void set_rotation(gfx::Display::Rotation rotation) { rotation_ = rotation; }
  99   gfx::Display::Rotation rotation() const { return rotation_; }
 100
 101   void set_touch_support(gfx::Display::TouchSupport support) {
 102     touch_support_ = support;
 103   }
 104   gfx::Display::TouchSupport touch_support() const { return touch_support_; }
 105
 106   // Gets/Sets the device scale factor of the display.
 107   float device_scale_factor() const { return device_scale_factor_; }
 108   void set_device_scale_factor(float scale) { device_scale_factor_ = scale; }
 109
 110   // The native bounds for the display. The size of this can be
 111   // different from the |size_in_pixel| when overscan insets are set
 112   // and/or |configured_ui_scale_| is set.
 113   const gfx::Rect& bounds_in_native() const {
 114     return bounds_in_native_;
 115   }
 116
 117   // The size for the display in pixels.
 118   const gfx::Size& size_in_pixel() const { return size_in_pixel_; }
 119
 120   // The overscan insets for the display in DIP.
 121   const gfx::Insets& overscan_insets_in_dip() const {
 122     return overscan_insets_in_dip_;
 123   }
 124
 125   // Sets/gets configured ui scale. This can be different from the ui
 126   // scale actually used when the scale is 2.0 and DSF is 2.0.
 127   // (the effective ui scale is 1.0 in this case).
 128   float configured_ui_scale() const { return configured_ui_scale_; }
 129   void set_configured_ui_scale(float scale) { configured_ui_scale_ = scale; }
 130
 131   // Returns the ui scale and device scale factor actually used to create
 132   // display that chrome sees. This can be different from one obtained
 133   // from dispaly or one specified by a user in following situation.
 134   // 1) DSF is 2.0f and UI scale is 2.0f. (Returns 1.0f and 1.0f respectiely)
 135   // 2) Lower UI scale (< 1.0) is specified on 1.0f DSF device
 136   // when 2x resources is available. (Returns 2.0f DSF + 1.2f UI scale
 137   // for 1.0DSF + 0.6 UI scale).
 138   float GetEffectiveDeviceScaleFactor() const;
 139   float GetEffectiveUIScale() const;
 140
 141   // Copy the display info except for fields that can be modified by a
 142   // user (|rotation_| and |configured_ui_scale_|). |rotation_| and
 143   // |configured_ui_scale_| are copied when the |another_info| isn't native one.
 144   void Copy(const DisplayInfo& another_info);
 145
 146   // Update the |bounds_in_native_| and |size_in_pixel_| using
 147   // given |bounds_in_native|.
 148   void SetBounds(const gfx::Rect& bounds_in_native);
 149
 150   // Update the |bounds_in_native| according to the current overscan
 151   // and rotation settings.
 152   void UpdateDisplaySize();
 153
 154   // Sets/Clears the overscan insets.
 155   void SetOverscanInsets(const gfx::Insets& insets_in_dip);
 156   gfx::Insets GetOverscanInsetsInPixel() const;
 157
 158   void set_native(bool native) { native_ = native; }
 159   bool native() const { return native_; }
 160
 161   const std::vector<DisplayMode>& display_modes() const {
 162     return display_modes_;
 163   }
 164   void set_display_modes(std::vector<DisplayMode>& display_modes) {
 165     display_modes_.swap(display_modes);
 166   }
 167
 168   ui::ColorCalibrationProfile color_profile() const {
 169     return color_profile_;
 170   }
 171
 172   // Sets the color profile. It will ignore if the specified |profile| is not in
 173   // |available_color_profiles_|.
 174   void SetColorProfile(ui::ColorCalibrationProfile profile);
 175
 176   // Returns true if |profile| is in |available_color_profiles_|.
 177   bool IsColorProfileAvailable(ui::ColorCalibrationProfile profile) const;
 178
 179   const std::vector<ui::ColorCalibrationProfile>&
 180       available_color_profiles() const {
 181     return available_color_profiles_;
 182   }
 183
 184   void set_available_color_profiles(
 185       const std::vector<ui::ColorCalibrationProfile>& profiles) {
 186     available_color_profiles_ = profiles;
 187   }
 188
 189   // Returns a string representation of the DisplayInfo, excluding display
 190   // modes.
 191   std::string ToString() const;
 192
 193   // Returns a string representation of the DisplayInfo, including display
 194   // modes.
 195   std::string ToFullString() const;
 196
 197  private:
 198   int64 id_;
 199   std::string name_;
 200   bool has_overscan_;
 201   gfx::Display::Rotation rotation_;
 202   gfx::Display::TouchSupport touch_support_;
 203
 204   // This specifies the device's pixel density. (For example, a
 205   // display whose DPI is higher than the threshold is considered to have
 206   // device_scale_factor = 2.0 on Chrome OS).  This is used by the
 207   // grapics layer to choose and draw appropriate images and scale
 208   // layers properly.
 209   float device_scale_factor_;
 210   gfx::Rect bounds_in_native_;
 211
 212   // The size of the display in use. The size can be different from the size
 213   // of |bounds_in_native_| if the display has overscan insets and/or rotation.
 214   gfx::Size size_in_pixel_;
 215   gfx::Insets overscan_insets_in_dip_;
 216
 217   // The pixel scale of the display. This is used to simply expand (or
 218   // shrink) the desktop over the native display resolution (useful in
 219   // HighDPI display).  Note that this should not be confused with the
 220   // device scale factor, which specifies the pixel density of the
 221   // display. The actuall scale value to be used depends on the device
 222   // scale factor.  See |GetEffectiveScaleFactor()|.
 223   float configured_ui_scale_;
 224
 225   // True if this comes from native platform (DisplayChangeObserver).
 226   bool native_;
 227
 228   // The list of modes supported by this display.
 229   std::vector<DisplayMode> display_modes_;
 230
 231   // The current profile of the color calibration.
 232   ui::ColorCalibrationProfile color_profile_;
 233
 234   // The list of available variations for the color calibration.
 235   std::vector<ui::ColorCalibrationProfile> available_color_profiles_;
 236 };
 237
 238 }  // namespace ash
 239
 240 #endif  //  ASH_DISPLAY_DISPLAY_INFO_H_