Mir
display_configuration.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2013 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify it
5  * under the terms of the GNU Lesser General Public License version 3,
6  * as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Alexandros Frantzis <alexandros.frantzis@canonical.com>
17  */
18 
19 #ifndef MIR_GRAPHICS_DISPLAY_CONFIGURATION_H_
20 #define MIR_GRAPHICS_DISPLAY_CONFIGURATION_H_
21 
22 #include "mir/int_wrapper.h"
23 #include "mir/geometry/size.h"
24 #include "mir/geometry/rectangle.h"
25 #include "mir/geometry/point.h"
26 #include "mir_toolkit/common.h"
27 
28 #include <functional>
29 #include <vector>
30 #include <memory>
31 
32 namespace mir
33 {
34 namespace graphics
35 {
36 namespace detail { struct GraphicsConfCardIdTag; struct GraphicsConfOutputIdTag; }
37 
40 
45 {
46  DisplayConfigurationCardId id;
48 };
49 
54 {
55  unknown,
56  vga,
57  dvii,
58  dvid,
59  dvia,
60  composite,
61  svideo,
62  lvds,
63  component,
64  ninepindin,
66  hdmia,
67  hdmib,
68  tv,
69  edp,
70  virt,
71 };
72 
77 {
79  double vrefresh_hz;
80 };
81 
86 {
88  DisplayConfigurationOutputId id;
90  DisplayConfigurationCardId card_id;
94  std::vector<MirPixelFormat> pixel_formats;
96  std::vector<DisplayConfigurationMode> modes;
102  bool connected;
104  bool used;
114 
116  float scale;
119 
122  geometry::Rectangle extents() const;
123  bool valid() const;
124 };
125 
131 {
132  DisplayConfigurationOutputId const& id;
133  DisplayConfigurationCardId const& card_id;
135  std::vector<MirPixelFormat> const& pixel_formats;
136  std::vector<DisplayConfigurationMode> const& modes;
137  uint32_t const& preferred_mode_index;
139  bool const& connected;
140  bool& used;
146  float& scale;
148 
150  geometry::Rectangle extents() const;
151 };
152 
153 std::ostream& operator<<(std::ostream& out, DisplayConfigurationCard const& val);
154 bool operator==(DisplayConfigurationCard const& val1, DisplayConfigurationCard const& val2);
155 bool operator!=(DisplayConfigurationCard const& val1, DisplayConfigurationCard const& val2);
156 
157 std::ostream& operator<<(std::ostream& out, DisplayConfigurationMode const& val);
158 bool operator==(DisplayConfigurationMode const& val1, DisplayConfigurationMode const& val2);
159 bool operator!=(DisplayConfigurationMode const& val1, DisplayConfigurationMode const& val2);
160 
161 std::ostream& operator<<(std::ostream& out, DisplayConfigurationOutput const& val);
164 
169 {
170 public:
171  virtual ~DisplayConfiguration() = default;
172 
174  virtual void for_each_card(std::function<void(DisplayConfigurationCard const&)> f) const = 0;
176  virtual void for_each_output(std::function<void(DisplayConfigurationOutput const&)> f) const = 0;
177  virtual void for_each_output(std::function<void(UserDisplayConfigurationOutput&)> f) = 0;
178 
179  virtual std::unique_ptr<DisplayConfiguration> clone() const = 0;
180 
181  virtual bool valid() const;
182 
183 protected:
184  DisplayConfiguration() = default;
185  DisplayConfiguration(DisplayConfiguration const& c) = delete;
186  DisplayConfiguration& operator=(DisplayConfiguration const& c) = delete;
187 };
188 
189 bool operator==(DisplayConfiguration const& lhs, DisplayConfiguration const& rhs);
190 bool operator!=(DisplayConfiguration const& lhs, DisplayConfiguration const& rhs);
191 
192 std::ostream& operator<<(std::ostream& out, DisplayConfiguration const& val);
193 
194 }
195 }
196 
197 #endif /* MIR_GRAPHICS_DISPLAY_CONFIGURATION_H_ */
Definition: size.h:30
Mirror of a DisplayConfigurationOutput, with some fields limited to being read-only, preventing users from changing things they shouldn&#39;t.
Definition: display_configuration.h:130
All things Mir.
Definition: atomic_callback.h:25
uint32_t const & preferred_mode_index
Definition: display_configuration.h:137
Configuration information for a display card.
Definition: display_configuration.h:44
DisplayConfigurationOutputType const & type
Definition: display_configuration.h:134
Configuration information for a display output mode.
Definition: display_configuration.h:76
geometry::Size const & physical_size_mm
Definition: display_configuration.h:138
bool & used
Definition: display_configuration.h:140
std::vector< DisplayConfigurationMode > modes
The modes supported by the output.
Definition: display_configuration.h:96
Definition: point.h:30
DisplayConfigurationOutputId id
The output&#39;s id.
Definition: display_configuration.h:88
DisplayConfigurationOutputType type
The type of the output.
Definition: display_configuration.h:92
IntWrapper< detail::GraphicsConfOutputIdTag > DisplayConfigurationOutputId
Definition: display_configuration.h:39
bool operator==(BufferProperties const &lhs, BufferProperties const &rhs)
Definition: buffer_properties.h:71
float scale
Requested scale factor for this output, for HiDPI support.
Definition: display_configuration.h:116
std::vector< MirPixelFormat > pixel_formats
The pixel formats supported by the output.
Definition: display_configuration.h:94
uint32_t preferred_mode_index
The index in the &#39;modes&#39; vector of the preferred output mode.
Definition: display_configuration.h:98
MirFormFactor form_factor
Form factor of this output; phone display, tablet, monitor, TV, projector...
Definition: display_configuration.h:118
MirPixelFormat & current_format
Definition: display_configuration.h:143
double vrefresh_hz
Definition: display_configuration.h:79
DisplayConfigurationCardId card_id
The id of the card the output is connected to.
Definition: display_configuration.h:90
MirOrientation
Direction relative to the "natural" orientation of the display.
Definition: common.h:164
std::ostream & operator<<(std::ostream &out, DisplayConfigurationCard const &val)
Definition: display_configuration.cpp:81
geometry::Size physical_size_mm
The physical size of the output.
Definition: display_configuration.h:100
DisplayConfigurationOutputType
The type of a display output.
Definition: display_configuration.h:53
bool operator!=(BufferProperties const &lhs, BufferProperties const &rhs)
Definition: buffer_properties.h:78
MirFormFactor & form_factor
Definition: display_configuration.h:147
MirOrientation & orientation
Definition: display_configuration.h:145
geometry::Size size
Definition: display_configuration.h:78
MirPowerMode
Definition: common.h:101
bool const & connected
Definition: display_configuration.h:139
MirPowerMode power_mode
Current power mode.
Definition: display_configuration.h:112
MirOrientation orientation
Definition: display_configuration.h:113
MirFormFactor
Form factor associated with a physical output.
Definition: common.h:205
MirPixelFormat
32-bit pixel formats (8888): The order of components in the enum matches the order of the components ...
Definition: common.h:134
bool connected
Whether the output is connected.
Definition: display_configuration.h:102
bool used
Whether the output is used in the configuration.
Definition: display_configuration.h:104
Configuration information for a display output.
Definition: display_configuration.h:85
DisplayConfigurationCardId id
Definition: display_configuration.h:46
IntWrapper< detail::GraphicsConfCardIdTag > DisplayConfigurationCardId
Definition: display_configuration.h:38
Definition: rectangle.h:33
size_t max_simultaneous_outputs
Definition: display_configuration.h:47
geometry::Point top_left
The top left point of this output in the virtual coordinate space.
Definition: display_configuration.h:106
geometry::Point & top_left
Definition: display_configuration.h:141
DisplayConfigurationOutputId const & id
Definition: display_configuration.h:132
std::vector< DisplayConfigurationMode > const & modes
Definition: display_configuration.h:136
DisplayConfigurationCardId const & card_id
Definition: display_configuration.h:133
uint32_t current_mode_index
The index in the &#39;modes&#39; vector of the current output mode.
Definition: display_configuration.h:108
uint32_t & current_mode_index
Definition: display_configuration.h:142
float & scale
Definition: display_configuration.h:146
Interface to a configuration of display cards and outputs.
Definition: display_configuration.h:168
MirPixelFormat current_format
The current output pixel format.
Definition: display_configuration.h:110
MirPowerMode & power_mode
Definition: display_configuration.h:144
std::vector< MirPixelFormat > const & pixel_formats
Definition: display_configuration.h:135

Copyright © 2012-2015 Canonical Ltd.
Generated on Thu Sep 8 14:50:19 UTC 2016