HL.MonitorSpec

class HL.MonitorSpec

Table describing one monitor configuration entry.

HL.MonitorSpec is passed to hl.monitor(). It describes the output to configure, its mode, position, scale, transform, mirroring, reserved space, and optional color-management settings.

Shape

{
    output = string,

    disabled = boolean?,
    mode = string?,
    position = string?,
    scale = string | number?,
    transform = integer | boolean?,
    mirror = string?,
    bitdepth = integer | boolean?,
    vrr = integer | boolean?,

    reserved = integer | HL.CssGap?,
    reserved_area = integer | HL.CssGap?,

    cm = string?,
    icc = string?,
    supports_hdr = integer | boolean?,
    supports_wide_color = integer | boolean?,
    sdr_eotf = string?,
    sdrbrightness = number | boolean?,
    sdrsaturation = number | boolean?,
    sdr_min_luminance = number | boolean?,
    sdr_max_luminance = integer | boolean?,
    min_luminance = number | boolean?,
    max_luminance = integer | boolean?,
    max_avg_luminance = integer | boolean?,
}

Fields

outputstring

Monitor output name. This field is required.

disabledboolean, optional

Disable the monitor.

modestring, optional

Monitor mode, usually written as resolution and refresh rate.

positionstring, optional

Monitor position.

scalestring or number, optional

Monitor scale factor.

transforminteger or boolean, optional

Monitor transform value.

mirrorstring, optional

Output name of the monitor to mirror.

bitdepthinteger or boolean, optional

Monitor bit depth option.

vrrinteger or boolean, optional

Variable refresh rate option.

reservedinteger or HL.CssGap, optional

Reserved space around the monitor.

reserved_areainteger or HL.CssGap, optional

Reserved area field.

cmstring, optional

Color-management mode.

iccstring, optional

ICC profile path.

supports_hdrinteger or boolean, optional

HDR capability override.

supports_wide_colorinteger or boolean, optional

Wide-color capability override.

sdr_eotfstring, optional

SDR transfer function option.

sdrbrightnessnumber or boolean, optional

SDR brightness option.

sdrsaturationnumber or boolean, optional

SDR saturation option.

sdr_min_luminancenumber or boolean, optional

SDR minimum luminance.

sdr_max_luminanceinteger or boolean, optional

SDR maximum luminance.

min_luminancenumber or boolean, optional

Minimum luminance.

max_luminanceinteger or boolean, optional

Maximum luminance.

max_avg_luminanceinteger or boolean, optional

Maximum average luminance.

Examples

Configure a normal monitor:

{
    output = "DP-1",
    mode = "2560x1440@60",
    position = "0x0",
    scale = 1,
}

Configure a transformed portrait monitor:

{
    output = "DP-2",
    mode = "2560x1440@60",
    position = "2560x0",
    scale = 1,
    transform = 1,
}

Reserve monitor space:

{
    output = "DP-1",
    reserved = {
        top = 32,
        right = 0,
        bottom = 0,
        left = 0,
    },
}

Used by

hl.monitor()

Configure a monitor from this table.

See also

HL.Monitor

Runtime object representing an active monitor.

HL.CssGap

Table shape accepted by reserved and reserved_area.

hl.get_monitor()

Get a runtime monitor object by selector.

hl.get_monitors()

Get all current monitor objects.