CodeGlyphX logo
CodeGlyphX

API Reference

Class

AsciiConsoleOptions

Namespace CodeGlyphX.Rendering.Ascii
Assembly CodeGlyphX
Modifiers sealed

Options for console-friendly ASCII rendering with auto-fit.

Inheritance

  • Object
  • AsciiConsoleOptions

Usage

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

Accepted by parameters

Constructors

Properties

public Nullable<Int32> WindowWidth { get; set; } #

Optional console window width override (columns).

public Nullable<Int32> WindowHeight { get; set; } #

Optional console window height override (rows).

public Nullable<Int32> MaxWindowWidth { get; set; } #

Optional maximum console width to use for auto-fit (columns).

public Nullable<Int32> MaxWindowHeight { get; set; } #

Optional maximum console height to use for auto-fit (rows).

public Nullable<Int32> TargetWidth { get; set; } #

Optional target output width (columns, excluding padding).

public Nullable<Int32> TargetHeight { get; set; } #

Optional target output height (rows, excluding padding).

public Int32 PaddingColumns { get; set; } #

Horizontal padding to keep around the QR when auto-fitting.

public Int32 PaddingRows { get; set; } #

Vertical padding to keep around the QR when auto-fitting.

public Int32 MinScale { get; set; } #

Minimum scale applied when auto-fitting.

public Int32 MaxScale { get; set; } #

Maximum scale applied when auto-fitting.

public Int32 MinQuietZone { get; set; } #

Minimum quiet zone size when shrinking to fit.

public Nullable<Int32> QuietZone { get; set; } #

Overrides quiet zone size (modules).

public Boolean AllowQuietZoneShrink { get; set; } #

When true, allows reducing quiet zone to fit within console size.

public Boolean AllowModuleWidthShrink { get; set; } #

When true, allows shrinking module width to fit within console size.

public Nullable<Int32> ModuleWidth { get; set; } #

Optional module width override.

public Nullable<Int32> ModuleHeight { get; set; } #

Optional module height override.

public String Dark { get; set; } #

Optional dark glyph override.

public String Light { get; set; } #

Optional light glyph override.

public String NewLine { get; set; } #

Optional line separator override.

public Boolean UseHalfBlocks { get; set; } #

When true, uses Unicode half-blocks to compress height.

public Boolean HalfBlockUseBackground { get; set; } #

When true, uses ANSI background colors for half-block rendering.

public Boolean UseUnicodeBlocks { get; set; } #

When true, prefers Unicode block glyphs.

public Nullable<Boolean> UseAnsiColors { get; set; } #

Enables or disables ANSI colors (null = auto-detect).

public Nullable<Boolean> UseTrueColor { get; set; } #

Enables or disables ANSI truecolor (null = default true).

public Nullable<Boolean> ColorizeLight { get; set; } #

Enables or disables ANSI colorization of light modules (null = keep preset default).

public Nullable<Double> CellAspectRatio { get; set; } #

Character cell aspect ratio (width / height). Used to auto-tune module width.

public AsciiGradientOptions DarkGradient { get; set; } #

Optional ANSI gradient for dark modules.

public AsciiPaletteOptions DarkPalette { get; set; } #

Optional ANSI palette for dark modules.

public Boolean PreferScanReliability { get; set; } #

When true, enables scan-friendly defaults (quiet zone, background fill, contrast clamp).

public Boolean EnsureDarkContrast { get; set; } #

When true, clamps dark colors to a maximum luminance.

public Double MaxDarkLuminance { get; set; } #

Maximum luminance allowed for dark modules (0-1).

public Nullable<Rgba32> DarkColor { get; set; } #

Optional ANSI color for dark modules.

public Nullable<Rgba32> LightColor { get; set; } #

Optional ANSI color for light modules.

public Encoding OutputEncoding { get; set; } #

Optional output encoding override used for Unicode capability checks.

public Nullable<Boolean> Invert { get; set; } #

When true, swaps dark and light output.