display_info.h revision 5d1f7b1de12d16ceb2c938c56701a3e8bfa558f7
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/gfx/display.h" 13#include "ui/gfx/insets.h" 14#include "ui/gfx/rect.h" 15 16namespace ash { 17namespace internal { 18 19// A struct that represents the display's mode info. 20struct 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. 37class 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 int64 id() const { return id_; } 85 86 // The name of the display. 87 const std::string& name() const { return name_; } 88 89 // True if the display EDID has the overscan flag. This does not create the 90 // actual overscan automatically, but used in the message. 91 bool has_overscan() const { return has_overscan_; } 92 93 void set_rotation(gfx::Display::Rotation rotation) { rotation_ = rotation; } 94 gfx::Display::Rotation rotation() const { return rotation_; } 95 96 void set_touch_support(gfx::Display::TouchSupport support) { 97 touch_support_ = support; 98 } 99 gfx::Display::TouchSupport touch_support() const { return touch_support_; } 100 101 // Gets/Sets the device scale factor of the display. 102 float device_scale_factor() const { return device_scale_factor_; } 103 void set_device_scale_factor(float scale) { device_scale_factor_ = scale; } 104 105 // The native bounds for the display. The size of this can be 106 // different from the |size_in_pixel| when overscan insets are set 107 // and/or |configured_ui_scale_| is set. 108 const gfx::Rect& bounds_in_native() const { 109 return bounds_in_native_; 110 } 111 112 // The size for the display in pixels. 113 const gfx::Size& size_in_pixel() const { return size_in_pixel_; } 114 115 // The overscan insets for the display in DIP. 116 const gfx::Insets& overscan_insets_in_dip() const { 117 return overscan_insets_in_dip_; 118 } 119 120 // Sets/gets configured ui scale. This can be different from the ui 121 // scale actually used when the scale is 2.0 and DSF is 2.0. 122 // (the effective ui scale is 1.0 in this case). 123 float configured_ui_scale() const { return configured_ui_scale_; } 124 void set_configured_ui_scale(float scale) { configured_ui_scale_ = scale; } 125 126 // Returns the ui scale used for the device scale factor. This 127 // return 1.0f if the ui scale and dsf are both set to 2.0. 128 float GetEffectiveUIScale() const; 129 130 // Copy the display info except for fields that can be modified by a 131 // user (|rotation_| and |configured_ui_scale_|). |rotation_| and 132 // |configured_ui_scale_| are copied when the |another_info| isn't native one. 133 void Copy(const DisplayInfo& another_info); 134 135 // Update the |bounds_in_native_| and |size_in_pixel_| using 136 // given |bounds_in_native|. 137 void SetBounds(const gfx::Rect& bounds_in_native); 138 139 // Update the |bounds_in_native| according to the current overscan 140 // and rotation settings. 141 void UpdateDisplaySize(); 142 143 // Sets/Clears the overscan insets. 144 void SetOverscanInsets(const gfx::Insets& insets_in_dip); 145 gfx::Insets GetOverscanInsetsInPixel() const; 146 147 void set_native(bool native) { native_ = native; } 148 bool native() const { return native_; } 149 150 const std::vector<DisplayMode>& display_modes() const { 151 return display_modes_; 152 } 153 void set_display_modes(std::vector<DisplayMode>& display_modes) { 154 display_modes_.swap(display_modes); 155 } 156 157 // Returns a string representation of the DisplayInfo, excluding display 158 // modes. 159 std::string ToString() const; 160 161 // Returns a string representation of the DisplayInfo, including display 162 // modes. 163 std::string ToFullString() const; 164 165 private: 166 int64 id_; 167 std::string name_; 168 bool has_overscan_; 169 gfx::Display::Rotation rotation_; 170 gfx::Display::TouchSupport touch_support_; 171 172 // This specifies the device's pixel density. (For example, a 173 // display whose DPI is higher than the threshold is considered to have 174 // device_scale_factor = 2.0 on Chrome OS). This is used by the 175 // grapics layer to choose and draw appropriate images and scale 176 // layers properly. 177 float device_scale_factor_; 178 gfx::Rect bounds_in_native_; 179 180 // The size of the display in use. The size can be different from the size 181 // of |bounds_in_native_| if the display has overscan insets and/or rotation. 182 gfx::Size size_in_pixel_; 183 gfx::Insets overscan_insets_in_dip_; 184 185 // The pixel scale of the display. This is used to simply expand (or 186 // shrink) the desktop over the native display resolution (useful in 187 // HighDPI display). Note that this should not be confused with the 188 // device scale factor, which specifies the pixel density of the 189 // display. The actuall scale value to be used depends on the device 190 // scale factor. See |GetEffectiveScaleFactor()|. 191 float configured_ui_scale_; 192 193 // True if this comes from native platform (DisplayChangeObserver). 194 bool native_; 195 196 // The list of modes supported by this display. 197 std::vector<DisplayMode> display_modes_; 198}; 199 200} // namespace internal 201} // namespace ash 202 203#endif // ASH_DISPLAY_DISPLAY_INFO_H_ 204