Class ConsoleWindowSystemOptions

Namespace

SharpConsoleUI.Configuration

Assembly

SharpConsoleUI.dll

Configuration options for ConsoleWindowSystem behavior.

public record ConsoleWindowSystemOptions : IEquatable<ConsoleWindowSystemOptions>

Inheritance

object

ConsoleWindowSystemOptions

Implements

IEquatable<ConsoleWindowSystemOptions>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

BindingExtensions.BindTwoWay<TBuilder, TControl, TSource, TValue>(TBuilder, TSource, Expression<Func<TSource, TValue>>, Expression<Func<TControl, TValue>>)

BindingExtensions.BindTwoWay<TBuilder, TControl, TSource, TSrc, TTgt>(TBuilder, TSource, Expression<Func<TSource, TSrc>>, Expression<Func<TControl, TTgt>>, Func<TSrc, TTgt>, Func<TTgt, TSrc>)

BindingExtensions.Bind<TBuilder, TControl, TSource, TValue>(TBuilder, TSource, Expression<Func<TSource, TValue>>, Expression<Func<TControl, TValue>>)

BindingExtensions.Bind<TBuilder, TControl, TSource, TSrc, TTgt>(TBuilder, TSource, Expression<Func<TSource, TSrc>>, Expression<Func<TControl, TTgt>>, Func<TSrc, TTgt>)

Constructors

ConsoleWindowSystemOptions(bool, bool, int, bool, DirtyTrackingMode, float, int, bool, bool, bool, int, DiagnosticsLayers, bool, bool, Func<PanelBuilder, PanelBuilder>?, Func<PanelBuilder, PanelBuilder>?, bool, bool, DesktopBackgroundConfig?, TerminalTransparencyMode, ConsoleKey?, ConsoleKey?)

Configuration options for ConsoleWindowSystem behavior.

public ConsoleWindowSystemOptions(bool EnablePerformanceMetrics = false, bool EnableFrameRateLimiting = true, int TargetFPS = 60, bool ClampToWindowWidth = false, DirtyTrackingMode DirtyTrackingMode = DirtyTrackingMode.Smart, float SmartModeCoverageThreshold = 0.6, int SmartModeFragmentationThreshold = 5, bool EnableAnimations = true, bool ClearDestinationOnWindowMove = true, bool EnableDiagnostics = false, int DiagnosticsRetainFrames = 1, DiagnosticsLayers DiagnosticsLayers = DiagnosticsLayers.All, bool EnableQualityAnalysis = false, bool EnablePerformanceProfiling = false, Func<PanelBuilder, PanelBuilder>? TopPanelConfig = null, Func<PanelBuilder, PanelBuilder>? BottomPanelConfig = null, bool ShowTopPanel = true, bool ShowBottomPanel = true, DesktopBackgroundConfig? DesktopBackground = null, TerminalTransparencyMode TerminalTransparencyMode = TerminalTransparencyMode.PreserveWindowColor, ConsoleKey? WindowCycleKey = ConsoleKey.T, ConsoleKey? ExitKey = ConsoleKey.Q)

Parameters

EnablePerformanceMetrics bool

EnableFrameRateLimiting bool

TargetFPS int

ClampToWindowWidth bool

DirtyTrackingMode DirtyTrackingMode

SmartModeCoverageThreshold float

SmartModeFragmentationThreshold int

EnableAnimations bool

ClearDestinationOnWindowMove bool

EnableDiagnostics bool

DiagnosticsRetainFrames int

DiagnosticsLayers DiagnosticsLayers

EnableQualityAnalysis bool

EnablePerformanceProfiling bool

TopPanelConfig Func<PanelBuilder, PanelBuilder>

BottomPanelConfig Func<PanelBuilder, PanelBuilder>

ShowTopPanel bool

ShowBottomPanel bool

DesktopBackground DesktopBackgroundConfig

TerminalTransparencyMode TerminalTransparencyMode

WindowCycleKey ConsoleKey?

ExitKey ConsoleKey?

Properties

BottomPanelConfig

public Func<PanelBuilder, PanelBuilder>? BottomPanelConfig { get; init; }

Property Value

Func<PanelBuilder, PanelBuilder>

ClampToWindowWidth

public bool ClampToWindowWidth { get; init; }

Property Value

bool

ClearDestinationOnWindowMove

public bool ClearDestinationOnWindowMove { get; init; }

Property Value

bool

Default

Gets the default configuration with frame rate limiting enabled at 60 FPS.

public static ConsoleWindowSystemOptions Default { get; }

Property Value

ConsoleWindowSystemOptions

DesktopBackground

public DesktopBackgroundConfig? DesktopBackground { get; init; }

Property Value

DesktopBackgroundConfig

DiagnosticsLayers

public DiagnosticsLayers DiagnosticsLayers { get; init; }

Property Value

DiagnosticsLayers

DiagnosticsRetainFrames

public int DiagnosticsRetainFrames { get; init; }

Property Value

int

DirtyTrackingMode

public DirtyTrackingMode DirtyTrackingMode { get; init; }

Property Value

DirtyTrackingMode

EnableAnimations

public bool EnableAnimations { get; init; }

Property Value

bool

EnableDiagnostics

public bool EnableDiagnostics { get; init; }

Property Value

bool

EnableFrameRateLimiting

public bool EnableFrameRateLimiting { get; init; }

Property Value

bool

EnablePerformanceMetrics

public bool EnablePerformanceMetrics { get; init; }

Property Value

bool

EnablePerformanceProfiling

public bool EnablePerformanceProfiling { get; init; }

Property Value

bool

EnableQualityAnalysis

public bool EnableQualityAnalysis { get; init; }

Property Value

bool

ExitKey

public ConsoleKey? ExitKey { get; init; }

Property Value

ConsoleKey?

MinFrameTime

Gets the minimum time between frames in milliseconds based on TargetFPS.

public int MinFrameTime { get; }

Property Value

int

ShowBottomPanel

public bool ShowBottomPanel { get; init; }

Property Value

bool

ShowTopPanel

public bool ShowTopPanel { get; init; }

Property Value

bool

SmartModeCoverageThreshold

public float SmartModeCoverageThreshold { get; init; }

Property Value

float

SmartModeFragmentationThreshold

public int SmartModeFragmentationThreshold { get; init; }

Property Value

int

TargetFPS

public int TargetFPS { get; init; }

Property Value

int

TerminalTransparencyMode

public TerminalTransparencyMode TerminalTransparencyMode { get; init; }

Property Value

TerminalTransparencyMode

TopPanelConfig

public Func<PanelBuilder, PanelBuilder>? TopPanelConfig { get; init; }

Property Value

Func<PanelBuilder, PanelBuilder>

WindowCycleKey

public ConsoleKey? WindowCycleKey { get; init; }

Property Value

ConsoleKey?

WithMetrics

Gets a configuration with performance metrics enabled.

public static ConsoleWindowSystemOptions WithMetrics { get; }

Property Value

ConsoleWindowSystemOptions

WithoutFrameRateLimiting

Gets a configuration with frame rate limiting disabled (renders as fast as possible).

public static ConsoleWindowSystemOptions WithoutFrameRateLimiting { get; }

Property Value

ConsoleWindowSystemOptions

Methods

Create(bool?, bool?, int?)

Creates a new configuration, checking environment variable SHARPCONSOLEUI_PERF_METRICS for override.

public static ConsoleWindowSystemOptions Create(bool? enableMetrics = null, bool? enableFrameRateLimiting = null, int? targetFPS = null)

Parameters

enableMetrics bool?

Explicit enable flag, or null to check environment variable.

enableFrameRateLimiting bool?

Enable frame rate limiting (default: true).

targetFPS int?

Target frames per second (default: 60).

Returns

ConsoleWindowSystemOptions

A new ConsoleWindowSystemOptions instance.

WithTargetFPS(int)

Gets a configuration with custom target FPS.

public static ConsoleWindowSystemOptions WithTargetFPS(int fps)

Parameters

fps int

Returns

ConsoleWindowSystemOptions