Mir
Loading...
Searching...
No Matches
output.h
Go to the documentation of this file.
1/*
2 * Copyright © Canonical Ltd.
3 *
4 * This program is free software: you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 or 3 as
6 * 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 General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16
17#ifndef MIRAL_OUTPUT_H
18#define MIRAL_OUTPUT_H
19
20#include <mir_toolkit/common.h>
21
23
24#include <map>
25#include <memory>
26#include <optional>
27
28namespace mir { namespace graphics { struct DisplayConfigurationOutput; } }
29
30namespace miral
31{
32using namespace mir::geometry;
33
34class Output
35{
36public:
37
38 struct PhysicalSizeMM { int width; int height; };
39
40 enum class Type
41 {
42 unknown,
43 vga,
44 dvii,
45 dvid,
46 dvia,
48 svideo,
49 lvds,
53 hdmia,
54 hdmib,
55 tv,
56 edp
57 };
58
59 explicit Output(const mir::graphics::DisplayConfigurationOutput &output);
60 Output(Output const&);
63
65 auto type() const -> Type;
66
69
71 auto connected() const -> bool;
72
74 auto used() const -> bool;
75
78
80 auto refresh_rate() const -> double;
81
83 auto power_mode() const -> MirPowerMode;
84
85 auto orientation() const -> MirOrientation;
86
88 auto scale() const -> float;
89
91 auto form_factor() const -> MirFormFactor;
92
95 auto extents() const -> Rectangle;
96
99 auto id() const -> int;
100
103 auto name() const -> std::string;
104
107 auto attribute(std::string const& key) const -> std::optional<std::string>;
108
111 auto attributes_map() const -> std::map<std::string const, std::optional<std::string>>;
112
113 auto valid() const -> bool;
114
115 auto is_same_output(Output const& other) const -> bool;
116
120 auto logical_group_id() const -> int;
121
122private:
123 std::shared_ptr<mir::graphics::DisplayConfigurationOutput> self;
124};
125
126bool operator==(Output::PhysicalSizeMM const& lhs, Output::PhysicalSizeMM const& rhs);
127inline bool operator!=(Output::PhysicalSizeMM const& lhs, Output::PhysicalSizeMM const& rhs)
128{ return !(lhs == rhs); }
129
130auto equivalent_display_area(Output const& lhs, Output const& rhs) -> bool;
131}
132
133#endif //MIRAL_OUTPUT_H
Definition output.h:35
auto name() const -> std::string
The output name. This matches that suppled to clients through wl_output.
Output(Output const &)
auto connected() const -> bool
Whether the output is connected.
Type
Definition output.h:41
Output(const mir::graphics::DisplayConfigurationOutput &output)
auto type() const -> Type
The type of the output.
auto form_factor() const -> MirFormFactor
Form factor of this output; phone display, tablet, monitor, TV, projector...
auto attributes_map() const -> std::map< std::string const, std::optional< std::string > >
A custom attribute map.
Output & operator=(Output const &)
auto pixel_format() const -> MirPixelFormat
The current output pixel format.
auto refresh_rate() const -> double
refresh_rate in Hz
auto orientation() const -> MirOrientation
auto valid() const -> bool
auto attribute(std::string const &key) const -> std::optional< std::string >
A custom attribute value.
auto physical_size_mm() const -> PhysicalSizeMM
The physical size of the output.
auto logical_group_id() const -> int
A positive number if this output is part of a logical output group (aka a display wall) A single disp...
auto power_mode() const -> MirPowerMode
Current power mode.
auto used() const -> bool
Whether the output is used in the configuration.
auto is_same_output(Output const &other) const -> bool
auto extents() const -> Rectangle
The logical rectangle occupied by the output, based on its position, current mode and orientation (ro...
auto scale() const -> float
Requested scale factor for this output, for HiDPI support.
MirFormFactor
Form factor associated with a physical output.
Definition common.h:347
MirOrientation
Direction relative to the "natural" orientation of the display.
Definition common.h:193
MirPowerMode
Definition common.h:108
MirPixelFormat
32-bit pixel formats (8888): The order of components in the enum matches the order of the components ...
Definition common.h:163
Basic geometry types. Types for dimensions, displacements, etc. and the operations that they support.
Definition dimensions.h:29
Definition splash_session.h:22
Mir Abstraction Layer.
Definition floating_window_manager.h:29
auto equivalent_display_area(Output const &lhs, Output const &rhs) -> bool
STL namespace.
Definition rectangle.h:35
Definition output.h:38
int width
Definition output.h:38
int height
Definition output.h:38

Copyright © 2012-2025 Canonical Ltd.
Generated on Mon Jan 20 23:24:07 UTC 2025
This documentation is licensed under the GPL version 2 or 3.