Mir
Main Page
Related Pages
Modules
Namespaces
Classes
Files
Examples
File List
File Members
include
client
mir_toolkit
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
40
typedef
struct
MirOutputMode
MirOutputMode
;
41
47
void
mir_display_config_release
(
MirDisplayConfig
* config);
48
61
int
mir_display_config_get_max_simultaneous_outputs
(
62
MirDisplayConfig
const
* config);
63
80
int
mir_display_config_get_num_outputs
(
MirDisplayConfig
const
* config);
81
92
MirOutput
const
*
mir_display_config_get_output
(
MirDisplayConfig
const
* config,
93
size_t
index);
94
104
int
mir_output_get_num_modes
(
MirOutput
const
* output);
105
120
MirOutputMode
const
*
mir_output_get_mode
(
MirOutput
const
* output,
size_t
index);
121
138
MirOutputMode
const
*
mir_output_get_preferred_mode
(
MirOutput
const
* output);
139
153
MirOutputMode
const
*
mir_output_get_current_mode
(
MirOutput
const
* output);
154
161
int
mir_output_get_num_pixel_formats
(
MirOutput
const
* output);
162
172
MirPixelFormat
mir_output_get_pixel_format
(
MirOutput
const
* output,
173
size_t
index);
174
182
MirPixelFormat
mir_output_get_current_pixel_format
(
MirOutput
const
* output);
183
190
void
mir_output_set_pixel_format
(
MirOutput
* output,
MirPixelFormat
format);
191
202
int
mir_output_get_id
(
MirOutput
const
* output);
203
213
MirOutputType
mir_output_get_type
(
MirOutput
const
* output);
214
229
int
mir_output_get_position_x
(
MirOutput
const
* output);
230
245
int
mir_output_get_position_y
(
MirOutput
const
* output);
246
268
MirOutputConnectionState
mir_output_get_connection_state
(
269
MirOutput
const
* output);
270
277
bool
mir_output_is_enabled
(
MirOutput
const
* output);
278
292
int
mir_output_get_physical_width_mm
(
MirOutput
const
* output);
293
307
int
mir_output_get_physical_height_mm
(
MirOutput
const
* output);
308
318
MirPowerMode
mir_output_get_power_mode
(
MirOutput
const
* output);
319
326
MirOrientation
mir_output_get_orientation
(
MirOutput
const
* output);
327
342
float
mir_output_get_scale_factor
(
MirOutput
const
* output);
343
352
MirFormFactor
mir_output_get_form_factor
(
MirOutput
const
* output);
353
362
int
mir_output_mode_get_width
(
MirOutputMode
const
* mode);
363
371
int
mir_output_mode_get_height
(
MirOutputMode
const
* mode);
372
378
double
mir_output_mode_get_refresh_rate
(
MirOutputMode
const
* mode);
379
382
#ifdef __cplusplus
383
}
384
#endif
385
386
#endif //MIR_TOOLKIT_MIR_DISPLAY_CONFIGURATION_H_
MirOutput
struct MirOutput MirOutput
Descriptor for an output connection.
Definition:
client_types.h:56
mir_output_get_position_y
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
mir_output_get_num_modes
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
MirDisplayConfig
struct MirDisplayConfig MirDisplayConfig
Definition:
client_types.h:48
mir_output_get_mode
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
mir_output_mode_get_width
int mir_output_mode_get_width(MirOutputMode const *mode)
Get the width, in pixels, of a MirOutputMode.
Definition:
display_configuration_api.cpp:308
mir_display_config_get_num_outputs
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
MirOutputConnectionState
Definition:
client_types.h:303
mir_output_get_physical_width_mm
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
mir_output_get_preferred_mode
MirOutputMode const * mir_output_get_preferred_mode(MirOutput const *output)
Get a handle to the output's preferred mode.
Definition:
display_configuration_api.cpp:150
mir_display_config_get_max_simultaneous_outputs
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
mir_output_get_orientation
MirOrientation mir_output_get_orientation(MirOutput const *output)
Get the orientation of a display.
Definition:
display_configuration_api.cpp:287
mir_output_get_form_factor
MirFormFactor mir_output_get_form_factor(MirOutput const *output)
Get the form-factor of a connected output.
Definition:
display_configuration_api.cpp:301
mir_output_get_connection_state
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
mir_output_get_pixel_format
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
MirOrientation
Direction relative to the "natural" orientation of the display.
Definition:
common.h:164
mir_output_get_current_mode
MirOutputMode const * mir_output_get_current_mode(MirOutput const *output)
Get a handle to the output's current mode.
Definition:
display_configuration_api.cpp:164
mir_output_get_power_mode
MirPowerMode mir_output_get_power_mode(MirOutput const *output)
Get the power state of a connected display.
Definition:
display_configuration_api.cpp:273
mir_output_is_enabled
bool mir_output_is_enabled(MirOutput const *output)
Get whether this output is enabled in the current configuration.
Definition:
display_configuration_api.cpp:94
mir_display_config_release
void mir_display_config_release(MirDisplayConfig *config)
Release resources associated with a MirDisplayConfig handle.
Definition:
mir_connection_api.cpp:245
MirPowerMode
MirPowerMode
Definition:
common.h:101
mir_output_get_type
MirOutputType mir_output_get_type(MirOutput const *output)
Get the physical connection type of an output.
Definition:
display_configuration_api.cpp:129
mir_output_get_position_x
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
MirFormFactor
Form factor associated with a physical output.
Definition:
common.h:197
MirPixelFormat
MirPixelFormat
32-bit pixel formats (8888): The order of components in the enum matches the order of the components ...
Definition:
common.h:134
client_types.h
MirOutputMode
struct MirOutputMode MirOutputMode
A descriptor for a display mode.
Definition:
mir_display_configuration.h:40
mir_output_mode_get_refresh_rate
double mir_output_mode_get_refresh_rate(MirOutputMode const *mode)
Get the refresh rate, in Hz, of a MirOutputMode.
Definition:
display_configuration_api.cpp:322
mir_output_get_current_pixel_format
MirPixelFormat mir_output_get_current_pixel_format(MirOutput const *output)
Get the current pixel format.
Definition:
display_configuration_api.cpp:220
mir_output_set_pixel_format
void mir_output_set_pixel_format(MirOutput *output, MirPixelFormat format)
Set the output format.
Definition:
display_configuration_api.cpp:227
mir_output_get_num_pixel_formats
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
mir_output_get_physical_height_mm
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
MirOutputType
MirOutputType
Definition:
client_types.h:284
mir_output_get_id
int mir_output_get_id(MirOutput const *output)
Get the ID of an output.
Definition:
display_configuration_api.cpp:122
mir_display_config_get_output
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.
Definition:
display_configuration_api.cpp:76
mir_output_get_scale_factor
float mir_output_get_scale_factor(MirOutput const *output)
Get the scale-factor of a display.
Definition:
display_configuration_api.cpp:294
mir_output_mode_get_height
int mir_output_mode_get_height(MirOutputMode const *mode)
Get the height, in pixels, of a MirOutputMode.
Definition:
display_configuration_api.cpp:315
Copyright © 2012-2015 Canonical Ltd.
Generated on Wed Mar 30 00:29:56 UTC 2016