Mir
display_config.h
Go to the documentation of this file.
1/*
2 * Copyright © 2017 Canonical Ltd.
3 *
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU Lesser 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 * Authored by: Alan Griffiths <alan@octopull.co.uk>
17 */
18
19#ifndef MIR_CLIENT_DISPLAY_CONFIG_H
20#define MIR_CLIENT_DISPLAY_CONFIG_H
21
24
25#include <functional>
26#include <memory>
27
28namespace mir
29{
33namespace client
34{
36{
37public:
38 DisplayConfig() = default;
39
40 explicit DisplayConfig(MirDisplayConfig* config) : self{config, deleter} {}
41
42 explicit DisplayConfig(MirConnection* connection) :
43 self{mir_connection_create_display_configuration(connection), deleter} {}
44
45 operator MirDisplayConfig*() { return self.get(); }
46
47 operator MirDisplayConfig const*() const { return self.get(); }
48
49 void reset() { self.reset(); }
50
51 void for_each_output(std::function<void(MirOutput const*)> const& enumerator) const
52 {
53 auto const count = mir_display_config_get_num_outputs(*this);
54
55 for (int i = 0; i != count; ++i)
56 enumerator(mir_display_config_get_output(*this, i));
57 }
58
59 void for_each_output(std::function<void(MirOutput*)> const& enumerator)
60 {
61 auto const count = mir_display_config_get_num_outputs(*this);
62
63 for (int i = 0; i != count; ++i)
64 enumerator(mir_display_config_get_mutable_output(*this, i));
65 }
66
67private:
68 static void deleter(MirDisplayConfig* config) { mir_display_config_release(config); }
69
70 std::shared_ptr <MirDisplayConfig> self;
71};
72
73// Provide a deleted overload to avoid double release "accidents".
74void mir_display_config_release(DisplayConfig const& config) = delete;
75}
76}
77
78#endif //MIR_CLIENT_DISPLAY_CONFIG_H
Definition: display_config.h:36
void reset()
Definition: display_config.h:49
DisplayConfig(MirConnection *connection)
Definition: display_config.h:42
void for_each_output(std::function< void(MirOutput *)> const &enumerator)
Definition: display_config.h:59
void for_each_output(std::function< void(MirOutput const *)> const &enumerator) const
Definition: display_config.h:51
DisplayConfig(MirDisplayConfig *config)
Definition: display_config.h:40
int mir_display_config_get_num_outputs(MirDisplayConfig const *config)
Get the number of outputs available in this display configuration.
MirDisplayConfig * mir_connection_create_display_configuration(MirConnection *connection)
Query the display.
MirOutput * mir_display_config_get_mutable_output(MirDisplayConfig *config, size_t index)
Get a modifyable handle to the index 'th output of this configuration.
struct MirDisplayConfig MirDisplayConfig
Definition: client_types.h:53
MirOutput const * mir_display_config_get_output(MirDisplayConfig const *config, size_t index)
Get a read-only handle to the index 'th output of this configuration.
struct MirConnection MirConnection
Definition: client_types.h:41
struct MirOutput MirOutput
Descriptor for an output connection.
Definition: client_types.h:72
void mir_display_config_release(DisplayConfig const &config)=delete
Definition: splash_session.h:24

Copyright © 2012-2022 Canonical Ltd.
Generated on Wed Dec 28 21:01:08 UTC 2022
This documentation is licensed under the GPL version 2 or 3.