Mir
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
105
MirOutput
*
mir_display_config_get_mutable_output
(
MirDisplayConfig
* config,
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
151
MirOutputMode
const
*
mir_output_get_preferred_mode
(
MirOutput
const
* output);
152
166
size_t
mir_output_get_preferred_mode_index
(
MirOutput
const
* output);
167
181
MirOutputMode
const
*
mir_output_get_current_mode
(
MirOutput
const
* output);
182
193
size_t
mir_output_get_current_mode_index
(
MirOutput
const
* output);
194
201
void
mir_output_set_current_mode
(
MirOutput
* output,
MirOutputMode
const
* mode);
202
209
int
mir_output_get_num_pixel_formats
(
MirOutput
const
* output);
210
220
MirPixelFormat
mir_output_get_pixel_format
(
MirOutput
const
* output,
221
size_t
index);
222
230
MirPixelFormat
mir_output_get_current_pixel_format
(
MirOutput
const
* output);
231
238
void
mir_output_set_pixel_format
(
MirOutput
* output,
MirPixelFormat
format);
239
250
int
mir_output_get_id
(
MirOutput
const
* output);
251
261
MirOutputType
mir_output_get_type
(
MirOutput
const
* output);
262
269
char
const
*
mir_display_output_type_name
(
MirDisplayOutputType
type);
270
277
char
const
*
mir_output_type_name
(
MirOutputType
type);
278
293
int
mir_output_get_position_x
(
MirOutput
const
* output);
294
309
int
mir_output_get_position_y
(
MirOutput
const
* output);
310
327
void
mir_output_set_position
(
MirOutput
* output,
int
x,
int
y);
328
350
MirOutputConnectionState
mir_output_get_connection_state
(
351
MirOutput
const
* output);
352
359
bool
mir_output_is_enabled
(
MirOutput
const
* output);
360
366
void
mir_output_enable
(
MirOutput
* output);
367
373
void
mir_output_disable
(
MirOutput
* output);
374
388
int
mir_output_get_physical_width_mm
(
MirOutput
const
* output);
389
403
int
mir_output_get_physical_height_mm
(
MirOutput
const
* output);
404
414
MirPowerMode
mir_output_get_power_mode
(
MirOutput
const
* output);
415
424
void
mir_output_set_power_mode
(
MirOutput
* output,
MirPowerMode
mode);
425
432
MirOrientation
mir_output_get_orientation
(
MirOutput
const
* output);
433
440
void
mir_output_set_orientation
(
MirOutput
* output,
MirOrientation
orientation);
441
456
float
mir_output_get_scale_factor
(
MirOutput
const
* output);
457
465
MirSubpixelArrangement
mir_output_get_subpixel_arrangement
(
MirOutput
const
* output);
466
475
MirFormFactor
mir_output_get_form_factor
(
MirOutput
const
* output);
476
482
bool
mir_output_is_gamma_supported
(
MirOutput
const
* client_output);
483
490
uint32_t
mir_output_get_gamma_size
(
MirOutput
const
* client_output);
491
502
void
mir_output_get_gamma
(
MirOutput
const
* client_output,
503
uint16_t* red,
504
uint16_t* green,
505
uint16_t* blue,
506
uint32_t size);
507
516
void
mir_output_set_gamma
(
MirOutput
* client_output,
517
uint16_t
const
* red,
518
uint16_t
const
* green,
519
uint16_t
const
* blue,
520
uint32_t size);
521
530
int
mir_output_mode_get_width
(
MirOutputMode
const
* mode);
531
539
int
mir_output_mode_get_height
(
MirOutputMode
const
* mode);
540
546
double
mir_output_mode_get_refresh_rate
(
MirOutputMode
const
* mode);
547
550
#ifdef __cplusplus
551
}
552
#endif
553
554
#endif //MIR_TOOLKIT_MIR_DISPLAY_CONFIGURATION_H_
MirOutput
struct MirOutput MirOutput
Descriptor for an output connection.
Definition:
client_types.h:59
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.
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.
mir_output_get_gamma
void mir_output_get_gamma(MirOutput const *client_output, uint16_t *red, uint16_t *green, uint16_t *blue, uint32_t size)
Get the gamma ramp of a display.
MirDisplayConfig
struct MirDisplayConfig MirDisplayConfig
Definition:
client_types.h:49
mir_output_set_current_mode
void mir_output_set_current_mode(MirOutput *output, MirOutputMode const *mode)
Set the current mode of an output.
mir_output_get_preferred_mode_index
size_t mir_output_get_preferred_mode_index(MirOutput const *output)
Get the index of the output's preferred mode.
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.
mir_output_set_power_mode
void mir_output_set_power_mode(MirOutput *output, MirPowerMode mode)
Set the power state of a connected display.
mir_output_mode_get_width
int mir_output_mode_get_width(MirOutputMode const *mode)
Get the width, in pixels, of a MirOutputMode.
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.
MirOutputConnectionState
MirOutputConnectionState
Definition:
client_types.h:291
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.
mir_output_get_preferred_mode
MirOutputMode const * mir_output_get_preferred_mode(MirOutput const *output)
Get a handle to the output's preferred mode.
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.
mir_output_get_orientation
MirOrientation mir_output_get_orientation(MirOutput const *output)
Get the orientation of a display.
mir_output_get_form_factor
MirFormFactor mir_output_get_form_factor(MirOutput const *output)
Get the form-factor of a connected output.
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.
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.
mir_output_get_gamma_size
uint32_t mir_output_get_gamma_size(MirOutput const *client_output)
Gets the gamma size.
MirOrientation
MirOrientation
Direction relative to the "natural" orientation of the display.
Definition:
common.h:186
MirSubpixelArrangement
MirSubpixelArrangement
Physical arrangement of subpixels on the physical output.
Definition:
common.h:336
mir_output_get_current_mode
MirOutputMode const * mir_output_get_current_mode(MirOutput const *output)
Get a handle to the output's current mode.
mir_output_set_position
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.
mir_output_is_gamma_supported
bool mir_output_is_gamma_supported(MirOutput const *client_output)
Gets if the platform supports gamma correction.
mir_output_get_power_mode
MirPowerMode mir_output_get_power_mode(MirOutput const *output)
Get the power state of a connected display.
mir_output_is_enabled
bool mir_output_is_enabled(MirOutput const *output)
Get whether this output is enabled in the current configuration.
mir_display_config_release
void mir_display_config_release(MirDisplayConfig *config)
Release resources associated with a MirDisplayConfig handle.
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.
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.
MirFormFactor
MirFormFactor
Form factor associated with a physical output.
Definition:
common.h:320
MirPixelFormat
MirPixelFormat
32-bit pixel formats (8888): The order of components in the enum matches the order of the components ...
Definition:
common.h:156
mir_output_type_name
char const * mir_output_type_name(MirOutputType type)
Get the textual name of an output type.
mir_output_set_gamma
void mir_output_set_gamma(MirOutput *client_output, uint16_t const *red, uint16_t const *green, uint16_t const *blue, uint32_t size)
Set the gamma ramp of a display.
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.
mir_display_config_get_mutable_output
MirOutput * mir_display_config_get_mutable_output(MirDisplayConfig *config, size_t index)
Get a modifyable handle to the index 'th output of this configuration.
mir_output_get_current_pixel_format
MirPixelFormat mir_output_get_current_pixel_format(MirOutput const *output)
Get the current pixel format.
mir_output_set_pixel_format
void mir_output_set_pixel_format(MirOutput *output, MirPixelFormat format)
Set the output format.
MirDisplayOutputType
MirDisplayOutputType
Definition:
client_types.h:269
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.
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.
mir_display_output_type_name
char const * mir_display_output_type_name(MirDisplayOutputType type)
Get the textual name of an output type.
mir_output_set_orientation
void mir_output_set_orientation(MirOutput *output, MirOrientation orientation)
Set the orientation of a display.
MirOutputType
MirOutputType
Definition:
common.h:109
mir_output_enable
void mir_output_enable(MirOutput *output)
Enable this output.
mir_output_get_id
int mir_output_get_id(MirOutput const *output)
Get the ID of an output.
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.
mir_output_disable
void mir_output_disable(MirOutput *output)
Disable this output.
mir_output_get_scale_factor
float mir_output_get_scale_factor(MirOutput const *output)
Get the scale-factor of a display.
mir_output_get_current_mode_index
size_t mir_output_get_current_mode_index(MirOutput const *output)
Get the index of to the output's current mode.
mir_output_mode_get_height
int mir_output_mode_get_height(MirOutputMode const *mode)
Get the height, in pixels, of a MirOutputMode.
mir_output_get_subpixel_arrangement
MirSubpixelArrangement mir_output_get_subpixel_arrangement(MirOutput const *output)
Get the subpixel arrangement of a display.
Copyright © 2012-2016 Canonical Ltd.
Generated on Sat Dec 3 12:48:59 UTC 2016