Class PngSinkOptions

Namespace

ItTiger.TigerCli.PngSink

Assembly

ItTiger.TigerCli.PngSink.dll

Immutable options used by PngSink and PngRenderer to size and style a rendered PNG image.

public sealed class PngSinkOptions

Inheritance

object

PngSinkOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Chrome

Whether to render only terminal content or include TigerCli window chrome.

public PngWindowChrome Chrome { get; init; }

Property Value

PngWindowChrome

Columns

The number of terminal text columns to render. Must be positive.

public required int Columns { get; init; }

Property Value

int

DefaultForeground

Default foreground colour used when a text segment has no explicit foreground.

public CliColor DefaultForeground { get; init; }

Property Value

CliColor

FrameColor

The frame colour used when window chrome is enabled.

public CliColor FrameColor { get; init; }

Property Value

CliColor

OverflowMode

Controls whether writes outside Columns by Rows throw or clip.

public PngOverflowMode OverflowMode { get; init; }

Property Value

PngOverflowMode

Rows

The number of terminal text rows to render. Must be positive.

public required int Rows { get; init; }

Property Value

int

TerminalBackground

The background colour of the terminal content area.

public CliColor TerminalBackground { get; init; }

Property Value

CliColor

TerminalFont

The monospace font used for terminal cells.

public PngFontSource TerminalFont { get; init; }

Property Value

PngFontSource

TerminalFontSize

The terminal font size in pixels. Must be positive.

public float TerminalFontSize { get; init; }

Property Value

float

Title

Optional title displayed in the title bar when Chrome is FrameAndTitle. Control characters are sanitized before rendering.

public string? Title { get; init; }

Property Value

string

TitleBackground

The background colour of the title bar.

public CliColor TitleBackground { get; init; }

Property Value

CliColor

TitleBarIcon

The title-bar icon source. Use None to suppress it.

public PngTitleBarIcon TitleBarIcon { get; init; }

Property Value

PngTitleBarIcon

TitleBarSymbols

The title-bar window-control symbol source. Use None to suppress it.

public PngTitleBarSymbols TitleBarSymbols { get; init; }

Property Value

PngTitleBarSymbols

TitleFont

The font used for the title bar.

public PngFontSource TitleFont { get; init; }

Property Value

PngFontSource

TitleFontSize

The title-bar font size in pixels. Must be positive.

public float TitleFontSize { get; init; }

Property Value

float

TitleForeground

The foreground colour of title-bar text and symbols.

public CliColor TitleForeground { get; init; }

Property Value

CliColor