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 
31 namespace mir
32 {
33 namespace graphics
34 {
35 namespace detail { struct GraphicsConfCardIdTag; struct GraphicsConfOutputIdTag; }
36 
39 
44 {
45  DisplayConfigurationCardId id;
47 };
48 
53 {
54  unknown,
55  vga,
56  dvii,
57  dvid,
58  dvia,
59  composite,
60  svideo,
61  lvds,
62  component,
63  ninepindin,
65  hdmia,
66  hdmib,
67  tv,
68  edp
69 };
70 
75 {
77  double vrefresh_hz;
78 };
79 
84 {
86  DisplayConfigurationOutputId id;
88  DisplayConfigurationCardId card_id;
92  std::vector<MirPixelFormat> pixel_formats;
94  std::vector<DisplayConfigurationMode> modes;
100  bool connected;
102  bool used;
112 
114  float scale;
117 
121  bool valid() const;
122 };
123 
129 {
130  DisplayConfigurationOutputId const& id;
131  DisplayConfigurationCardId const& card_id;
133  std::vector<MirPixelFormat> const& pixel_formats;
134  std::vector<DisplayConfigurationMode> const& modes;
135  uint32_t const& preferred_mode_index;
137  bool const& connected;
138  bool& used;
144  float& scale;
146 
149 };
150 
151 std::ostream& operator<<(std::ostream& out, DisplayConfigurationCard const& val);
152 bool operator==(DisplayConfigurationCard const& val1, DisplayConfigurationCard const& val2);
153 bool operator!=(DisplayConfigurationCard const& val1, DisplayConfigurationCard const& val2);
154 
155 std::ostream& operator<<(std::ostream& out, DisplayConfigurationMode const& val);
156 bool operator==(DisplayConfigurationMode const& val1, DisplayConfigurationMode const& val2);
157 bool operator!=(DisplayConfigurationMode const& val1, DisplayConfigurationMode const& val2);
158 
159 std::ostream& operator<<(std::ostream& out, DisplayConfigurationOutput const& val);
162 
167 {
168 public:
170 
172  virtual void for_each_card(std::function<void(DisplayConfigurationCard const&)> f) const = 0;
174  virtual void for_each_output(std::function<void(DisplayConfigurationOutput const&)> f) const = 0;
175  virtual void for_each_output(std::function<void(UserDisplayConfigurationOutput&)> f) = 0;
176  virtual bool valid() const;
177 
178 protected:
179  DisplayConfiguration() = default;
180  DisplayConfiguration(DisplayConfiguration const& c) = delete;
182 };
183 
184 std::ostream& operator<<(std::ostream& out, DisplayConfiguration const& val);
185 
186 }
187 }
188 
189 #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't.
Definition: display_configuration.h:128
All things Mir.
Definition: atomic_callback.h:25
uint32_t const & preferred_mode_index
Definition: display_configuration.h:135
Configuration information for a display card.
Definition: display_configuration.h:43
DisplayConfigurationOutputType const & type
Definition: display_configuration.h:132
Configuration information for a display output mode.
Definition: display_configuration.h:74
geometry::Size const & physical_size_mm
Definition: display_configuration.h:136
bool & used
Definition: display_configuration.h:138
std::vector< DisplayConfigurationMode > modes
The modes supported by the output.
Definition: display_configuration.h:94
Definition: point.h:30
DisplayConfigurationOutputId id
The output's id.
Definition: display_configuration.h:86
DisplayConfigurationOutputType type
The type of the output.
Definition: display_configuration.h:90
IntWrapper< detail::GraphicsConfOutputIdTag > DisplayConfigurationOutputId
Definition: display_configuration.h:38
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:114
std::vector< MirPixelFormat > pixel_formats
The pixel formats supported by the output.
Definition: display_configuration.h:92
uint32_t preferred_mode_index
The index in the 'modes' vector of the preferred output mode.
Definition: display_configuration.h:96
MirFormFactor form_factor
Form factor of this output; phone display, tablet, monitor, TV, projector...
Definition: display_configuration.h:116
virtual void for_each_output(std::function< void(DisplayConfigurationOutput const &)> f) const =0
Executes a function object for each output in the configuration.
MirPixelFormat & current_format
Definition: display_configuration.h:141
double vrefresh_hz
Definition: display_configuration.h:77
DisplayConfigurationCardId card_id
The id of the card the output is connected to.
Definition: display_configuration.h:88
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:98
geometry::Rectangle extents() const
Definition: display_configuration.cpp:304
DisplayConfigurationOutputType
The type of a display output.
Definition: display_configuration.h:52
bool operator!=(BufferProperties const &lhs, BufferProperties const &rhs)
Definition: buffer_properties.h:78
bool valid() const
Definition: display_configuration.cpp:253
MirFormFactor & form_factor
Definition: display_configuration.h:145
virtual ~DisplayConfiguration()
Definition: display_configuration.h:169
MirOrientation & orientation
Definition: display_configuration.h:143
geometry::Size size
Definition: display_configuration.h:76
MirPowerMode
Definition: common.h:101
bool const & connected
Definition: display_configuration.h:137
MirPowerMode power_mode
Current power mode.
Definition: display_configuration.h:110
UserDisplayConfigurationOutput(DisplayConfigurationOutput &master)
Definition: display_configuration.cpp:283
MirOrientation orientation
Definition: display_configuration.h:111
MirFormFactor
Form factor associated with a physical output.
Definition: common.h:197
MirPixelFormat
32-bit pixel formats (8888): The order of components in the enum matches the order of the components ...
Definition: common.h:134
DisplayConfiguration & operator=(DisplayConfiguration const &c)=delete
bool connected
Whether the output is connected.
Definition: display_configuration.h:100
bool used
Whether the output is used in the configuration.
Definition: display_configuration.h:102
Configuration information for a display output.
Definition: display_configuration.h:83
DisplayConfigurationCardId id
Definition: display_configuration.h:45
IntWrapper< detail::GraphicsConfCardIdTag > DisplayConfigurationCardId
Definition: display_configuration.h:37
virtual void for_each_card(std::function< void(DisplayConfigurationCard const &)> f) const =0
Executes a function object for each card in the configuration.
Definition: rectangle.h:33
size_t max_simultaneous_outputs
Definition: display_configuration.h:46
geometry::Point top_left
The top left point of this output in the virtual coordinate space.
Definition: display_configuration.h:104
geometry::Point & top_left
Definition: display_configuration.h:139
DisplayConfigurationOutputId const & id
Definition: display_configuration.h:130
virtual bool valid() const
Definition: display_configuration.cpp:270
geometry::Rectangle extents() const
The logical rectangle occupied by the output, based on its position, current mode and orientation (ro...
Definition: display_configuration.cpp:248
std::vector< DisplayConfigurationMode > const & modes
Definition: display_configuration.h:134
DisplayConfigurationCardId const & card_id
Definition: display_configuration.h:131
uint32_t current_mode_index
The index in the 'modes' vector of the current output mode.
Definition: display_configuration.h:106
uint32_t & current_mode_index
Definition: display_configuration.h:140
float & scale
Definition: display_configuration.h:144
Interface to a configuration of display cards and outputs.
Definition: display_configuration.h:166
MirPixelFormat current_format
The current output pixel format.
Definition: display_configuration.h:108
MirPowerMode & power_mode
Definition: display_configuration.h:142
std::vector< MirPixelFormat > const & pixel_formats
Definition: display_configuration.h:133

Copyright © 2012-2015 Canonical Ltd.
Generated on Thu Oct 8 16:20:16 UTC 2015