summaryrefslogtreecommitdiff
path: root/src/backends/meta-monitor-manager-private.h
diff options
context:
space:
mode:
authorNiels De Graef <nielsdegraef@gmail.com>2018-10-19 09:15:54 +0200
committerNiels De Graef <nielsdegraef@gmail.com>2019-01-06 21:57:16 +0100
commit0478c225b7627ed06c6460b0e11772e867d86579 (patch)
treee823128fc1792124e36bd9a60d00ac0b23c81ddc /src/backends/meta-monitor-manager-private.h
parent93c29318b2994cb23cc88e0c63d923bb0bc92dc8 (diff)
downloadmutter-0478c225b7627ed06c6460b0e11772e867d86579.tar.gz
Add some gtk-doc comments.
Diffstat (limited to 'src/backends/meta-monitor-manager-private.h')
-rw-r--r--src/backends/meta-monitor-manager-private.h54
1 files changed, 42 insertions, 12 deletions
diff --git a/src/backends/meta-monitor-manager-private.h b/src/backends/meta-monitor-manager-private.h
index 69c3036c4..becb78eef 100644
--- a/src/backends/meta-monitor-manager-private.h
+++ b/src/backends/meta-monitor-manager-private.h
@@ -1,17 +1,5 @@
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
-/**
- * \file screen-private.h Handling of monitor configuration
- *
- * Managing multiple monitors
- * This file contains structures and functions that handle
- * multiple monitors, including reading the current configuration
- * and available hardware, and applying it.
- *
- * This interface is private to mutter, API users should look
- * at MetaScreen instead.
- */
-
/*
* Copyright (C) 2001 Havoc Pennington
* Copyright (C) 2003 Rob Adams
@@ -152,6 +140,48 @@ struct _MetaMonitorManager
MetaMonitorSwitchConfigType current_switch_config;
};
+/**
+ * MetaMonitorManagerClass:
+ *
+ * @read_edid: Returns the raw Extended Display Identification Data (EDID)
+ * for the given #MetaOutput object. Use meta_output_parse_edid() to parse
+ * afterwards.
+ *
+ * @ensure_initial_config: Called on setup. Makes sure an initial config
+ * is loaded.
+ *
+ * @apply_monitors_config: Tries to apply the given config using the given
+ * method. Throws an error if something went wrong.
+ *
+ * @set_power_save_mode: Sets the #MetaPowerSave mode (for all displays).
+ *
+ * @change_backlight: Changes the backlight intensity to the given value (in
+ * percent).
+ *
+ * @get_crtc_gamma: Queries and returns the gamma rampQueries and returns the
+ * gamma ramp.
+ *
+ * @set_crtc_gamma: Sets custom display LUT (look up table) for each primary
+ * color. Each table is indexed by a value that represents input intensity,
+ * and yields a value that represents output intensity.
+ *
+ * @tiled_monitor_added: Should be called by a #MetaMonitor when it is created.
+ *
+ * @tiled_monitor_removed: Should be called by a #MetaMonitor when it is
+ * destroyed.
+ *
+ * @is_transform_handled: vfunc for
+ * meta_monitor_manager_is_transform_handled().
+ * @calculate_monitor_mode_scale: vfunc for
+ * meta_monitor_manager_calculate_monitor_mode_scale().
+ * @calculate_supported_scales: vfunc for
+ * meta_monitor_manager_calculate_supported_scales().
+ * @get_capabilities: vfunc for meta_monitor_manager_get_capabilities().
+ * @get_max_screen_size: vfunc for meta_monitor_manager_get_max_screen_size().
+ * @get_default_layout_mode: vfunc for meta_monitor_manager_get_default_layout_mode().
+ *
+ * The base class for a #MetaMonitorManager.
+ */
struct _MetaMonitorManagerClass
{
MetaDBusDisplayConfigSkeletonClass parent_class;