Mir
mir_display_configuration.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2016 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: Christopher James Halse Rogers <christopher.halse.rogers@canonical.com>
17  */
18 
19 #ifndef MIR_TOOLKIT_MIR_DISPLAY_CONFIGURATION_H_
20 #define MIR_TOOLKIT_MIR_DISPLAY_CONFIGURATION_H_
21 
22 #include "client_types.h"
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
41 
48 
62  MirDisplayConfig const* config);
63 
81 
93  size_t index);
94 
106  size_t index);
107 
117 int mir_output_get_num_modes(MirOutput const* output);
118 
133 MirOutputMode const* mir_output_get_mode(MirOutput const* output, size_t index);
134 
152 
167 
174 void mir_output_set_current_mode(MirOutput* output, MirOutputMode const* mode);
175 
183 
194  size_t index);
195 
204 
212 
223 int mir_output_get_id(MirOutput const* output);
224 
235 
250 int mir_output_get_position_x(MirOutput const* output);
251 
266 int mir_output_get_position_y(MirOutput const* output);
267 
284 void mir_output_set_position(MirOutput* output, int x, int y);
285 
308  MirOutput const* output);
309 
316 bool mir_output_is_enabled(MirOutput const* output);
317 
323 void mir_output_enable(MirOutput* output);
324 
330 void mir_output_disable(MirOutput* output);
331 
346 
361 
372 
382 
390 
397 void mir_output_set_orientation(MirOutput* output, MirOrientation orientation);
398 
413 float mir_output_get_scale_factor(MirOutput const* output);
414 
424 
434 
443 
450 
453 #ifdef __cplusplus
454 }
455 #endif
456 
457 #endif //MIR_TOOLKIT_MIR_DISPLAY_CONFIGURATION_H_
struct MirOutput MirOutput
Descriptor for an output connection.
Definition: client_types.h:59
int mir_output_get_position_y(MirOutput const *output)
Get the y coordinate of the top-left point of the output in the virtual display space.
Definition: display_configuration_api.cpp:242
int mir_output_get_num_modes(MirOutput const *output)
Get the number of modes in the supported mode list of this output.
Definition: display_configuration_api.cpp:143
struct MirDisplayConfig MirDisplayConfig
Definition: client_types.h:49
void mir_output_set_current_mode(MirOutput *output, MirOutputMode const *mode)
Set the current mode of an output.
Definition: display_configuration_api.cpp:178
MirOutputMode const * mir_output_get_mode(MirOutput const *output, size_t index)
Get a handle for a mode descriptor from the list of supported modes.
Definition: display_configuration_api.cpp:199
void mir_output_set_power_mode(MirOutput *output, MirPowerMode mode)
Set the power state of a connected display.
Definition: display_configuration_api.cpp:280
int mir_output_mode_get_width(MirOutputMode const *mode)
Get the width, in pixels, of a MirOutputMode.
Definition: display_configuration_api.cpp:316
int mir_display_config_get_num_outputs(MirDisplayConfig const *config)
Get the number of outputs available in this display configuration.
Definition: display_configuration_api.cpp:70
MirOutputConnectionState
Definition: client_types.h:309
int mir_output_get_physical_width_mm(MirOutput const *output)
Get the physical width of the connected display, in millimetres.
Definition: display_configuration_api.cpp:136
MirOutputMode const * mir_output_get_preferred_mode(MirOutput const *output)
Get a handle to the output&#39;s preferred mode.
Definition: display_configuration_api.cpp:150
int mir_display_config_get_max_simultaneous_outputs(MirDisplayConfig const *config)
Get the maximum possible number of simultaneously active outputs this system supports.
Definition: display_configuration_api.cpp:115
MirOrientation mir_output_get_orientation(MirOutput const *output)
Get the orientation of a display.
Definition: display_configuration_api.cpp:287
MirFormFactor mir_output_get_form_factor(MirOutput const *output)
Get the form-factor of a connected output.
Definition: display_configuration_api.cpp:309
MirOutputConnectionState mir_output_get_connection_state(MirOutput const *output)
Get whether there is a display physically connected to the output.
Definition: display_configuration_api.cpp:257
MirPixelFormat mir_output_get_pixel_format(MirOutput const *output, size_t index)
Get a pixel format from the list of supported formats.
Definition: display_configuration_api.cpp:213
MirOrientation
Direction relative to the "natural" orientation of the display.
Definition: common.h:164
MirOutputMode const * mir_output_get_current_mode(MirOutput const *output)
Get a handle to the output&#39;s current mode.
Definition: display_configuration_api.cpp:164
void mir_output_set_position(MirOutput *output, int x, int y)
Set the coordinates of the top-left point of the output in the virtual display space.
Definition: display_configuration_api.cpp:249
MirPowerMode mir_output_get_power_mode(MirOutput const *output)
Get the power state of a connected display.
Definition: display_configuration_api.cpp:273
bool mir_output_is_enabled(MirOutput const *output)
Get whether this output is enabled in the current configuration.
Definition: display_configuration_api.cpp:94
void mir_display_config_release(MirDisplayConfig *config)
Release resources associated with a MirDisplayConfig handle.
Definition: mir_connection_api.cpp:245
MirPowerMode
Definition: common.h:101
MirOutputType mir_output_get_type(MirOutput const *output)
Get the physical connection type of an output.
Definition: display_configuration_api.cpp:129
int mir_output_get_position_x(MirOutput const *output)
Get the x coordinate of the top-left point of the output in the virtual display space.
Definition: display_configuration_api.cpp:235
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
struct MirOutputMode MirOutputMode
A descriptor for a display mode.
Definition: mir_display_configuration.h:40
double mir_output_mode_get_refresh_rate(MirOutputMode const *mode)
Get the refresh rate, in Hz, of a MirOutputMode.
Definition: display_configuration_api.cpp:330
MirOutput * mir_display_config_get_mutable_output(MirDisplayConfig *config, size_t index)
Get a modifyable handle to the index &#39;th output of this configuration.
Definition: display_configuration_api.cpp:85
MirPixelFormat mir_output_get_current_pixel_format(MirOutput const *output)
Get the current pixel format.
Definition: display_configuration_api.cpp:220
void mir_output_set_pixel_format(MirOutput *output, MirPixelFormat format)
Set the output format.
Definition: display_configuration_api.cpp:227
int mir_output_get_num_pixel_formats(MirOutput const *output)
Get the number of pixel formats supported by this output.
Definition: display_configuration_api.cpp:206
int mir_output_get_physical_height_mm(MirOutput const *output)
Get the physical height of the connected display, in millimetres.
Definition: display_configuration_api.cpp:266
void mir_output_set_orientation(MirOutput *output, MirOrientation orientation)
Set the orientation of a display.
Definition: display_configuration_api.cpp:294
MirOutputType
Definition: client_types.h:289
void mir_output_enable(MirOutput *output)
Enable this output.
Definition: display_configuration_api.cpp:101
int mir_output_get_id(MirOutput const *output)
Get the ID of an output.
Definition: display_configuration_api.cpp:122
MirOutput const * mir_display_config_get_output(MirDisplayConfig const *config, size_t index)
Get a read-only handle to the index &#39;th output of this configuration.
Definition: display_configuration_api.cpp:76
void mir_output_disable(MirOutput *output)
Disable this output.
Definition: display_configuration_api.cpp:108
float mir_output_get_scale_factor(MirOutput const *output)
Get the scale-factor of a display.
Definition: display_configuration_api.cpp:302
int mir_output_mode_get_height(MirOutputMode const *mode)
Get the height, in pixels, of a MirOutputMode.
Definition: display_configuration_api.cpp:323

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