CodeGlyphX logo
CodeGlyphX

API Reference

Class

QrPngRenderOptions

Namespace CodeGlyphX.Rendering.Png
Assembly CodeGlyphX
Modifiers sealed

Options for QrPngRenderer.

Inheritance

  • Object
  • QrPngRenderOptions

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

Methods

public QrPngRenderOptions WithBackground(Rgba32 color) #
Returns: QrPngRenderOptions

Sets the background color.

Parameters

color CodeGlyphX.Rendering.Png.Rgba32 requiredposition: 0
public QrPngRenderOptions WithBackgroundGradient(QrPngGradientOptions gradient) #
Returns: QrPngRenderOptions

Sets the background gradient.

Parameters

gradient CodeGlyphX.Rendering.Png.QrPngGradientOptions requiredposition: 0
public QrPngRenderOptions WithBackgroundPattern(QrPngBackgroundPatternOptions pattern) #
Returns: QrPngRenderOptions

Sets the background pattern overlay.

Parameters

pattern CodeGlyphX.Rendering.Png.QrPngBackgroundPatternOptions requiredposition: 0
public QrPngRenderOptions WithBackgroundSupersample(Int32 factor) #
Returns: QrPngRenderOptions

Sets the background supersample factor (1 = disabled).

Parameters

factor System.Int32 requiredposition: 0
public QrPngRenderOptions WithCanvas(QrPngCanvasOptions canvas) #
Returns: QrPngRenderOptions

Sets the canvas options.

Parameters

canvas CodeGlyphX.Rendering.Png.QrPngCanvasOptions requiredposition: 0
public QrPngRenderOptions WithDebug(QrPngDebugOptions debug) #
Returns: QrPngRenderOptions

Sets the debug overlay options.

Parameters

debug CodeGlyphX.Rendering.Png.QrPngDebugOptions requiredposition: 0
public QrPngRenderOptions WithEyes(QrPngEyeOptions eyes) #
Returns: QrPngRenderOptions

Sets custom eye (finder) options.

Parameters

eyes CodeGlyphX.Rendering.Png.QrPngEyeOptions requiredposition: 0
public QrPngRenderOptions WithForeground(Rgba32 color) #
Returns: QrPngRenderOptions

Sets the foreground color.

Parameters

color CodeGlyphX.Rendering.Png.Rgba32 requiredposition: 0
public QrPngRenderOptions WithForegroundGradient(QrPngGradientOptions gradient) #
Returns: QrPngRenderOptions

Sets the foreground gradient.

Parameters

gradient CodeGlyphX.Rendering.Png.QrPngGradientOptions requiredposition: 0
public QrPngRenderOptions WithForegroundPalette(QrPngPaletteOptions palette) #
Returns: QrPngRenderOptions

Sets the foreground palette.

Parameters

palette CodeGlyphX.Rendering.Png.QrPngPaletteOptions requiredposition: 0
public QrPngRenderOptions WithForegroundPaletteZones(QrPngPaletteZoneOptions zones) #
Returns: QrPngRenderOptions

Sets palette overrides for specific zones.

Parameters

zones CodeGlyphX.Rendering.Png.QrPngPaletteZoneOptions requiredposition: 0
public QrPngRenderOptions WithForegroundPattern(QrPngForegroundPatternOptions pattern) #
Returns: QrPngRenderOptions

Sets the foreground pattern overlay.

Parameters

pattern CodeGlyphX.Rendering.Png.QrPngForegroundPatternOptions requiredposition: 0
public QrPngRenderOptions WithLogo(QrPngLogoOptions logo) #
Returns: QrPngRenderOptions

Sets the logo overlay options.

Parameters

logo CodeGlyphX.Rendering.Png.QrPngLogoOptions requiredposition: 0
public QrPngRenderOptions WithModuleCornerRadiusPx(Int32 radiusPx) #
Returns: QrPngRenderOptions

Sets the module corner radius in pixels.

Parameters

radiusPx System.Int32 requiredposition: 0
public QrPngRenderOptions WithModuleJitter(QrPngModuleJitterOptions jitter) #
Returns: QrPngRenderOptions

Sets per-module jitter options.

Parameters

jitter CodeGlyphX.Rendering.Png.QrPngModuleJitterOptions requiredposition: 0
public QrPngRenderOptions WithModuleScale(Double scale) #
Returns: QrPngRenderOptions

Sets the module scale.

Parameters

scale System.Double requiredposition: 0
public QrPngRenderOptions WithModuleScaleMap(QrPngModuleScaleMapOptions map) #
Returns: QrPngRenderOptions

Sets per-module scale mapping options.

Parameters

map CodeGlyphX.Rendering.Png.QrPngModuleScaleMapOptions requiredposition: 0
public QrPngRenderOptions WithModuleShape(QrPngModuleShape shape) #
Returns: QrPngRenderOptions

Sets the module shape.

Parameters

shape CodeGlyphX.Rendering.Png.QrPngModuleShape requiredposition: 0
public QrPngRenderOptions WithModuleShapeMap(QrPngModuleShapeMapOptions map) #
Returns: QrPngRenderOptions

Sets per-module shape mapping options.

Parameters

map CodeGlyphX.Rendering.Png.QrPngModuleShapeMapOptions requiredposition: 0
public QrPngRenderOptions WithModuleSize(Int32 size) #
Returns: QrPngRenderOptions

Sets the module size in pixels.

Parameters

size System.Int32 requiredposition: 0
public QrPngRenderOptions WithPngCompressionLevel(Int32 level) #
Returns: QrPngRenderOptions

Sets the PNG compression level (0 = stored/uncompressed, 1-9 = compressed).

Parameters

level System.Int32 requiredposition: 0
public QrPngRenderOptions WithQuietZone(Int32 quietZone) #
Returns: QrPngRenderOptions

Sets the quiet zone size in modules.

Parameters

quietZone System.Int32 requiredposition: 0

Properties

public Int32 ModuleSize { get; set; } #

Gets or sets the size of a single QR module in pixels.

public Int32 QuietZone { get; set; } #

Gets or sets the quiet zone size in modules.

public Rgba32 Foreground { get; set; } #

Gets or sets the foreground (dark) color.

public Rgba32 Background { get; set; } #

Gets or sets the background (light) color.

public QrPngGradientOptions BackgroundGradient { get; set; } #

Optional gradient for the background.

public QrPngBackgroundPatternOptions BackgroundPattern { get; set; } #

Optional pattern overlay for the QR background area.

public Int32 BackgroundSupersample { get; set; } #

Background supersample factor for gradients/patterns (1 = disabled, max 4).

public QrPngGradientOptions ForegroundGradient { get; set; } #

Optional gradient for the foreground (dark) modules.

public QrPngPaletteOptions ForegroundPalette { get; set; } #

Optional multi-color palette for foreground modules.

public QrPngForegroundPatternOptions ForegroundPattern { get; set; } #

Optional pattern overlay for foreground modules.

public QrPngPaletteZoneOptions ForegroundPaletteZones { get; set; } #

Optional palette overrides for specific zones.

public QrPngEyeOptions Eyes { get; set; } #

Optional eye (finder) styling overrides.

public QrPngModuleShape ModuleShape { get; set; } #

Gets or sets the module shape.

public Double ModuleScale { get; set; } #

Gets or sets the scale of the module inside its cell (0.1..1.0).

public QrPngModuleScaleMapOptions ModuleScaleMap { get; set; } #

Optional per-module scale mapping.

public QrPngModuleShapeMapOptions ModuleShapeMap { get; set; } #

Optional per-module shape mapping.

public QrPngModuleJitterOptions ModuleJitter { get; set; } #

Optional per-module jitter (organic placement).

public Boolean ProtectFunctionalPatterns { get; set; } #

When true, keeps non-eye functional patterns (timing/alignment/format/version/dark module) at full scale and a stable foreground color for scan reliability.

public Boolean ProtectQuietZone { get; set; } #

When true and a background pattern is enabled, skips drawing the pattern inside the quiet zone.

public Int32 ModuleCornerRadiusPx { get; set; } #

Gets or sets the corner radius in pixels for Rounded.

public QrPngCanvasOptions Canvas { get; set; } #

Optional canvas options for sticker-style output.

public QrPngDebugOptions Debug { get; set; } #

Optional debug overlay options.

public Int32 PngCompressionLevel { get; set; } #

PNG compression level (0 = stored/uncompressed, 1-9 = compressed).

Fields

public const Int32 BackgroundSupersampleMin #

Minimum allowed background supersample factor.

Value: 1
public const Int32 BackgroundSupersampleMax #

Maximum allowed background supersample factor (capped to avoid large memory spikes).

Value: 4