Mir
surface_output_event.h
Go to the documentation of this file.
1/*
2 * Copyright © 2015 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 2 or 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_SURFACE_OUTPUT_EVENT_H_
20#define MIR_TOOLKIT_SURFACE_OUTPUT_EVENT_H_
21
24
25#ifdef __cplusplus
30extern "C" {
31#endif
32
33// Ignore use of deprecate MirSurfaceOutputEvent typedef in deprecated functions (for now)
34#pragma GCC diagnostic push
35#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
42int mir_surface_output_event_get_dpi(MirSurfaceOutputEvent const* ev)
43MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_output_event_get_dpi instead");
44
52MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_output_event_get_form_factor instead");
53
61float mir_surface_output_event_get_scale(MirSurfaceOutputEvent const* ev)
62MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_output_event_get_scale instead");
63
73double mir_surface_output_event_get_refresh_rate(MirSurfaceOutputEvent const* ev)
74MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_output_event_get_refresh_rate instead");
75
83uint32_t mir_surface_output_event_get_output_id(MirSurfaceOutputEvent const *ev)
84MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_output_event_get_output_id instead");
85
86#pragma GCC diagnostic pop
87
88#ifdef __cplusplus
89}
91#endif
92
93#endif //MIR_TOOLKIT_SURFACE_OUTPUT_EVENT_H_
#define MIR_FOR_REMOVAL_IN_VERSION_1(message)
Definition: deprecations.h:30
MirFormFactor
Form factor associated with a physical output.
Definition: common.h:429
double mir_surface_output_event_get_refresh_rate(MirSurfaceOutputEvent const *ev) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_output_event_get_refresh_rate instead")
Retrieve the maximum refresh rate of the output(s) associated with a MirSurfaceOutputEvent.
uint32_t mir_surface_output_event_get_output_id(MirSurfaceOutputEvent const *ev) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_output_event_get_output_id instead")
Retrieve the ID of the output this surface is on from a MirSurfaceOutputEvent.
float mir_surface_output_event_get_scale(MirSurfaceOutputEvent const *ev) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_output_event_get_scale instead")
Retrieve the suggested scaling factor of the new output configuration of a MirSurfaceOutputEvent.
int mir_surface_output_event_get_dpi(MirSurfaceOutputEvent const *ev) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_output_event_get_dpi instead")
Retrieve the DPI of the new output configuration of a MirSurfaceOutputEvent.
MirFormFactor mir_surface_output_event_get_form_factor(MirSurfaceOutputEvent const *ev) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_output_event_get_form_factor instead")
Retrieve the form factor of the new output configuration of a MirSurfaceOutputEvent.

Copyright © 2012-2022 Canonical Ltd.
Generated on Sat 3 Dec 14:36:51 UTC 2022
This documentation is licensed under the GPL version 2 or 3.