API Reference
MatrixAsciiRenderOptions
Rendering options for ASCII matrix output.
Inheritance
- Object
- MatrixAsciiRenderOptions
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method AsciiConsole.Fit
- Method AsciiPresets.Console
- Method AsciiPresets.ConsoleCompact
- Method MatrixAsciiRenderOptions.WithAnsiColorizeLight
- Method MatrixAsciiRenderOptions.WithAnsiColors
- Method MatrixAsciiRenderOptions.WithAnsiDarkColor
- Method MatrixAsciiRenderOptions.WithAnsiDarkGradient
- Method MatrixAsciiRenderOptions.WithAnsiDarkPalette
- Method MatrixAsciiRenderOptions.WithAnsiLightColor
- Method MatrixAsciiRenderOptions.WithAnsiTrueColor
- Method MatrixAsciiRenderOptions.WithDark
- Method MatrixAsciiRenderOptions.WithEnsureDarkContrast
- Method MatrixAsciiRenderOptions.WithHalfBlockBackground
- Method MatrixAsciiRenderOptions.WithHalfBlocks
- Method MatrixAsciiRenderOptions.WithInvert
- Method MatrixAsciiRenderOptions.WithLight
- Method MatrixAsciiRenderOptions.WithMaxDarkLuminance
- Method MatrixAsciiRenderOptions.WithModuleHeight
- Method MatrixAsciiRenderOptions.WithModuleWidth
- Method MatrixAsciiRenderOptions.WithNewLine
- Method MatrixAsciiRenderOptions.WithQuietZone
- Method MatrixAsciiRenderOptions.WithScale
- Method MatrixAsciiRenderOptions.WithUnicodeBlocks
- Property RenderExtras.MatrixAscii
Accepted by parameters
- Method AztecCode.Ascii
- Method AztecCode.Ascii
- Method DataMatrixCode.Ascii
- Method DataMatrixCode.Ascii
- Method DataMatrixCode.Ascii
- Method DataMatrixBuilder.Ascii
- Method Pdf417Code.Ascii
- Method Pdf417Code.Ascii
- Method Pdf417Code.Ascii
- Method Pdf417Code.AsciiMacro
- Method Pdf417Builder.Ascii
- Method QR.Ascii
- Method QR.Ascii
- Method QR.AsciiAuto
- Method QrBuilder.Ascii
- Method QrBuilder.SaveAscii
- Method QrEasy.RenderAscii
- Method QrEasy.RenderAscii
- Method QrEasy.RenderAsciiAuto
- Method MatrixAsciiRenderer.Render
Constructors
public MatrixAsciiRenderOptions() #Methods
public MatrixAsciiRenderOptions WithAnsiColorizeLight(Boolean enabled = true) #MatrixAsciiRenderOptionsEnables or disables ANSI colorization of light modules.
Parameters
- enabled System.Boolean = true
public MatrixAsciiRenderOptions WithAnsiColors(Boolean enabled = true) #MatrixAsciiRenderOptionsEnables or disables ANSI color escape codes.
Parameters
- enabled System.Boolean = true
public MatrixAsciiRenderOptions WithAnsiDarkColor(Rgba32 color) #MatrixAsciiRenderOptionsSets the ANSI color for dark modules.
Parameters
- color CodeGlyphX.Rendering.Png.Rgba32
public MatrixAsciiRenderOptions WithAnsiDarkGradient(AsciiGradientOptions gradient) #MatrixAsciiRenderOptionsSets an ANSI gradient for dark modules.
Parameters
- gradient CodeGlyphX.Rendering.Ascii.AsciiGradientOptions
public MatrixAsciiRenderOptions WithAnsiDarkPalette(AsciiPaletteOptions palette) #MatrixAsciiRenderOptionsSets an ANSI palette for dark modules.
Parameters
- palette CodeGlyphX.Rendering.Ascii.AsciiPaletteOptions
public MatrixAsciiRenderOptions WithAnsiLightColor(Rgba32 color) #MatrixAsciiRenderOptionsSets the ANSI color for light modules.
Parameters
- color CodeGlyphX.Rendering.Png.Rgba32
public MatrixAsciiRenderOptions WithAnsiTrueColor(Boolean enabled = true) #MatrixAsciiRenderOptionsEnables or disables ANSI truecolor (24-bit) output.
Parameters
- enabled System.Boolean = true
public MatrixAsciiRenderOptions WithDark(String dark) #MatrixAsciiRenderOptionsSets the character(s) used for dark modules.
Parameters
- dark System.String
public MatrixAsciiRenderOptions WithEnsureDarkContrast(Boolean enabled = true) #MatrixAsciiRenderOptionsEnables or disables contrast clamping for dark modules.
Parameters
- enabled System.Boolean = true
public MatrixAsciiRenderOptions WithHalfBlockBackground(Boolean enabled = true) #MatrixAsciiRenderOptionsEnables or disables ANSI background colors for half-block rendering.
Parameters
- enabled System.Boolean = true
public MatrixAsciiRenderOptions WithHalfBlocks(Boolean enabled = true) #MatrixAsciiRenderOptionsEnables or disables Unicode half-blocks (two module rows per text row).
Parameters
- enabled System.Boolean = true
public MatrixAsciiRenderOptions WithInvert(Boolean enabled = true) #MatrixAsciiRenderOptionsEnables or disables inverted output (dark/light swapped).
Parameters
- enabled System.Boolean = true
public MatrixAsciiRenderOptions WithLight(String light) #MatrixAsciiRenderOptionsSets the character(s) used for light modules.
Parameters
- light System.String
public MatrixAsciiRenderOptions WithMaxDarkLuminance(Double value) #MatrixAsciiRenderOptionsSets the maximum luminance for dark modules (0-1).
Parameters
- value System.Double
public MatrixAsciiRenderOptions WithModuleHeight(Int32 height) #MatrixAsciiRenderOptionsSets the module height in rows.
Parameters
- height System.Int32
public MatrixAsciiRenderOptions WithModuleWidth(Int32 width) #MatrixAsciiRenderOptionsSets the module width in characters.
Parameters
- width System.Int32
public MatrixAsciiRenderOptions WithNewLine(String newLine) #MatrixAsciiRenderOptionsSets the line separator.
Parameters
- newLine System.String
public MatrixAsciiRenderOptions WithQuietZone(Int32 quietZone) #MatrixAsciiRenderOptionsSets the quiet zone size in modules.
Parameters
- quietZone System.Int32
public MatrixAsciiRenderOptions WithScale(Int32 scale) #MatrixAsciiRenderOptionsSets an additional scale multiplier applied to both module width and height.
Parameters
- scale System.Int32
public MatrixAsciiRenderOptions WithUnicodeBlocks(Boolean enabled = true) #MatrixAsciiRenderOptionsEnables or disables Unicode block glyphs when defaults are used.
Parameters
- enabled System.Boolean = true
Inherited Methods
Properties
public Int32 QuietZone { get; set; } #Quiet zone size in modules.
public Int32 ModuleWidth { get; set; } #Module width in characters.
public Int32 ModuleHeight { get; set; } #Module height in rows.
public Int32 Scale { get; set; } #Additional scale multiplier applied to both module width and height.
public String Dark { get; set; } #Character(s) used for dark modules.
public String Light { get; set; } #Character(s) used for light modules.
public String NewLine { get; set; } #Line separator used between rows.
public Boolean UseUnicodeBlocks { get; set; } #When true, prefers Unicode block glyphs (for example, █) when defaults are used.
public Boolean UseHalfBlocks { get; set; } #When true, uses Unicode half-blocks to combine two module rows into one text row.
public Boolean UseHalfBlockBackground { get; set; } #When true, uses ANSI background colors for half-block rendering.
public AsciiGradientOptions AnsiDarkGradient { get; set; } #Optional ANSI gradient for dark modules.
public AsciiPaletteOptions AnsiDarkPalette { get; set; } #Optional ANSI palette for dark modules.
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 Boolean Invert { get; set; } #When true, swaps dark and light output.
public Boolean UseAnsiColors { get; set; } #When true, emits ANSI color escape codes for dark (and optionally light) modules.
public Boolean UseAnsiTrueColor { get; set; } #When true, uses 24-bit ANSI colors; otherwise maps to ANSI 256-color.
public Rgba32 AnsiDarkColor { get; set; } #ANSI color for dark modules.
public Rgba32 AnsiLightColor { get; set; } #ANSI color for light modules.
public Boolean AnsiColorizeLight { get; set; } #When true, also colorizes light modules; otherwise leaves them uncolored.