Skip to content
ConsoleMonster

API Reference

Class

TerminalBackgroundInfo

Namespace ConsoleMonster.Output
Assembly ConsoleMonster
Modifiers sealed

Describes the detected terminal background colour and its source.

Inheritance

  • Object
  • TerminalBackgroundInfo

Usage

Explore 1 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters 1

Properties

public Boolean IsLight { get; } #

Whether the background is classified as light.

public Boolean HasColor { get; } #

Whether an RGB colour was available.

public Byte Red { get; } #

Red channel, meaningful when TerminalBackgroundInfo.HasColor is true.

public Byte Green { get; } #

Green channel, meaningful when TerminalBackgroundInfo.HasColor is true.

public Byte Blue { get; } #

Blue channel, meaningful when TerminalBackgroundInfo.HasColor is true.

public Double? Luminance { get; } #

Relative luminance when an RGB colour was available.

public String Source { get; } #

Detection source: console color table, COLORFGBG, or unknown.

public String Decision { get; } #

Human-readable explanation of the detection result.