PhoshMonitor

PhoshMonitor — A monitor

Functions

PhoshMonitor * phosh_monitor_new_from_wl_output ()
PhoshMonitorMode * phosh_monitor_get_current_mode ()
gboolean phosh_monitor_is_configured ()
gboolean phosh_monitor_is_builtin ()
gboolean phosh_monitor_is_flipped ()
guint phosh_monitor_get_rotation ()
void phosh_monitor_set_power_save_mode ()

Properties

PhoshMonitorPowerSaveMode power-mode Read
gpointer wl-output Read / Write / Construct Only

Signals

void configured Run Last

Types and Values

enum PhoshMonitorConnectorType
enum PhoshMonitorPowerSaveMode
#define PHOSH_TYPE_MONITOR
  PhoshMonitor

Object Hierarchy

    GEnum
    ├── PhoshMonitorConnectorType
    ╰── PhoshMonitorPowerSaveMode
    GObject
    ╰── PhoshMonitor

Description

A rectangualar area in the compositor space, usally corresponds to physical monitor using wl_output and xdg_output Wayland protocols.

Functions

phosh_monitor_new_from_wl_output ()

PhoshMonitor *
phosh_monitor_new_from_wl_output (gpointer wl_output);

phosh_monitor_get_current_mode ()

PhoshMonitorMode *
phosh_monitor_get_current_mode (PhoshMonitor *monitor);

phosh_monitor_is_configured ()

gboolean
phosh_monitor_is_configured (PhoshMonitor *monitor);

Parameters

self

A PhoshMonitor

  

Returns

TRUE if the monitor fully configured (received all state updates from the compositor).

phosh_monitor_is_builtin ()

gboolean
phosh_monitor_is_builtin (PhoshMonitor *monitor);

Parameters

self

A PhoshMonitor

  

Returns

TRUE if the monitor built in panel (e.g. laptop panel or phone LCD)

phosh_monitor_is_flipped ()

gboolean
phosh_monitor_is_flipped (PhoshMonitor *monitor);

Parameters

self

A PhoshMonitor

  

Returns

TRUE if the monitor's output is flipped

phosh_monitor_get_rotation ()

guint
phosh_monitor_get_rotation (PhoshMonitor *monitor);

Parameters

self

A PhoshMonitor

  

Returns

The monitor's rotation in degrees.

phosh_monitor_set_power_save_mode ()

void
phosh_monitor_set_power_save_mode (PhoshMonitor *self,
                                   PhoshMonitorPowerSaveMode mode);

Sets monitor's power save mode.

Parameters

self

A PhoshMonitor

  

mode

The PhoshMonitorPowerSaveMode

  

Types and Values

enum PhoshMonitorConnectorType

Members

PHOSH_MONITOR_CONNECTOR_TYPE_Unknown

    

PHOSH_MONITOR_CONNECTOR_TYPE_VGA

    

PHOSH_MONITOR_CONNECTOR_TYPE_DVII

    

PHOSH_MONITOR_CONNECTOR_TYPE_DVID

    

PHOSH_MONITOR_CONNECTOR_TYPE_DVIA

    

PHOSH_MONITOR_CONNECTOR_TYPE_Composite

    

PHOSH_MONITOR_CONNECTOR_TYPE_SVIDEO

    

PHOSH_MONITOR_CONNECTOR_TYPE_LVDS

    

PHOSH_MONITOR_CONNECTOR_TYPE_Component

    

PHOSH_MONITOR_CONNECTOR_TYPE_9PinDIN

    

PHOSH_MONITOR_CONNECTOR_TYPE_DisplayPort

    

PHOSH_MONITOR_CONNECTOR_TYPE_HDMIA

    

PHOSH_MONITOR_CONNECTOR_TYPE_HDMIB

    

PHOSH_MONITOR_CONNECTOR_TYPE_TV

    

PHOSH_MONITOR_CONNECTOR_TYPE_eDP

    

PHOSH_MONITOR_CONNECTOR_TYPE_VIRTUAL

    

PHOSH_MONITOR_CONNECTOR_TYPE_DSI

    

enum PhoshMonitorPowerSaveMode

The power save mode of a monitor

Members

PHOSH_MONITOR_POWER_SAVE_MODE_OFF

The monitor is off (saving power)

  

PHOSH_MONITOR_POWER_SAVE_MODE_ON

The monitor is on

  

PHOSH_TYPE_MONITOR

#define PHOSH_TYPE_MONITOR                 (phosh_monitor_get_type ())

PhoshMonitor

typedef struct _PhoshMonitor PhoshMonitor;

Property Details

The “power-mode” property

  “power-mode”               PhoshMonitorPowerSaveMode

The power save mode for this monitor.

Owner: PhoshMonitor

Flags: Read

Default value: PHOSH_MONITOR_POWER_SAVE_MODE_OFF

The “wl-output” property

  “wl-output”                gpointer

The wayland output associated with this monitor.

Owner: PhoshMonitor

Flags: Read / Write / Construct Only

Signal Details

The “configured” signal

void
user_function (PhoshMonitor *monitor,
               gpointer      user_data)

Emitted whenever a monitor is fully configured (that is it received all configuration data from the various wayland protocols).

Parameters

monitor

The PhoshMonitor emitting the signal.

  

user_data

user data set when the signal handler was connected.

  

Flags: Run Last

Generated by GTK-Doc V1.32