mir_display_configuration.h

Go to the documentation of this file.

/*
 * Copyright © 2016 Canonical Ltd.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Authored by: Christopher James Halse Rogers <christopher.halse.rogers@canonical.com>
 */

#ifndef MIR_TOOLKIT_MIR_DISPLAY_CONFIGURATION_H_
#define MIR_TOOLKIT_MIR_DISPLAY_CONFIGURATION_H_

#include "client_types.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct MirOutputMode MirOutputMode;

void mir_display_config_release(MirDisplayConfig* config);

int mir_display_config_get_max_simultaneous_outputs(
    MirDisplayConfig const* config);

int mir_display_config_get_num_outputs(MirDisplayConfig const* config);

MirOutput const* mir_display_config_get_output(MirDisplayConfig const* config,
    size_t index);

MirOutput* mir_display_config_get_mutable_output(MirDisplayConfig* config,
    size_t index);

int mir_output_get_num_modes(MirOutput const* output);

MirOutputMode const* mir_output_get_mode(MirOutput const* output, size_t index);

MirOutputMode const* mir_output_get_preferred_mode(MirOutput const* output);

size_t mir_output_get_preferred_mode_index(MirOutput const* output);

MirOutputMode const* mir_output_get_current_mode(MirOutput const* output);

size_t mir_output_get_current_mode_index(MirOutput const* output);

void mir_output_set_current_mode(MirOutput* output, MirOutputMode const* mode);

int mir_output_get_num_pixel_formats(MirOutput const* output);

MirPixelFormat mir_output_get_pixel_format(MirOutput const* output,
    size_t index);

MirPixelFormat mir_output_get_current_pixel_format(MirOutput const* output);

void mir_output_set_pixel_format(MirOutput* output, MirPixelFormat format);

int mir_output_get_id(MirOutput const* output);

MirOutputType mir_output_get_type(MirOutput const* output);

char const* mir_display_output_type_name(MirDisplayOutputType type)
__attribute__((deprecated("use mir_output_type_name instead")));

char const* mir_output_type_name(MirOutputType type);

int mir_output_get_position_x(MirOutput const* output);

int mir_output_get_position_y(MirOutput const* output);

void mir_output_set_position(MirOutput* output, int x, int y);

MirOutputConnectionState mir_output_get_connection_state(
    MirOutput const* output);

bool mir_output_is_enabled(MirOutput const* output);

void mir_output_enable(MirOutput* output);

void mir_output_disable(MirOutput* output);

char const* mir_output_get_model(MirOutput const* output);

int mir_output_get_physical_width_mm(MirOutput const* output);

int mir_output_get_physical_height_mm(MirOutput const* output);

MirPowerMode mir_output_get_power_mode(MirOutput const* output);

void mir_output_set_power_mode(MirOutput* output, MirPowerMode mode);

MirOrientation mir_output_get_orientation(MirOutput const* output);

void mir_output_set_orientation(MirOutput* output, MirOrientation orientation);

float mir_output_get_scale_factor(MirOutput const* output);

MirSubpixelArrangement mir_output_get_subpixel_arrangement(MirOutput const* output);

MirFormFactor mir_output_get_form_factor(MirOutput const* output);

bool mir_output_is_gamma_supported(MirOutput const* client_output);

uint32_t mir_output_get_gamma_size(MirOutput const* client_output);

void mir_output_get_gamma(MirOutput const* client_output,
                          uint16_t* red,
                          uint16_t* green,
                          uint16_t* blue,
                          uint32_t  size);

void mir_output_set_gamma(MirOutput* client_output,
                          uint16_t const* red,
                          uint16_t const* green,
                          uint16_t const* blue,
                          uint32_t  size);

void mir_output_set_scale_factor(MirOutput* output, float scale);

uint8_t const* mir_output_get_edid(MirOutput const* output);

size_t mir_output_get_edid_size(MirOutput const* output);

int mir_output_mode_get_width(MirOutputMode const* mode);

int mir_output_mode_get_height(MirOutputMode const* mode);

double mir_output_mode_get_refresh_rate(MirOutputMode const* mode);

#ifdef __cplusplus
}
#endif

#endif //MIR_TOOLKIT_MIR_DISPLAY_CONFIGURATION_H_