CodeGlyphX logo
CodeGlyphX

API Reference

Class

QrEasyOptions

Edit on GitHub
Namespace CodeGlyphX
Assembly CodeGlyphX
Source CodeGlyphX/QrEasyOptions.cs:15
Modifiers sealed

Simple options for QR rendering.

Inheritance

  • Object
  • QrEasyOptions

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

Accepted by parameters

Constructors

public QrEasyOptions() #
CodeGlyphX/QrEasyOptions.cs:15

Properties

public Int32 ModuleSize { get; set; } #
CodeGlyphX/QrEasyOptions.cs:15

Module size in pixels.

public Int32 QuietZone { get; set; } #
CodeGlyphX/QrEasyOptions.cs:20

Quiet zone size in modules.

public Int32 TargetSizePx { get; set; } #
CodeGlyphX/QrEasyOptions.cs:25

Target output size in pixels (0 = disabled). When set, module size is adjusted to fit this target.

public Boolean TargetSizeIncludesQuietZone { get; set; } #
CodeGlyphX/QrEasyOptions.cs:30

When true, TargetSizePx includes the quiet zone.

public Nullable<QrErrorCorrectionLevel> ErrorCorrectionLevel { get; set; } #
CodeGlyphX/QrEasyOptions.cs:35

Optional error correction level override.

public Nullable<QrTextEncoding> TextEncoding { get; set; } #
CodeGlyphX/QrEasyOptions.cs:40

Optional text encoding override (when set, emits ECI for non-default encodings).

public Boolean IncludeEci { get; set; } #
CodeGlyphX/QrEasyOptions.cs:45

When true, emits ECI headers for non-default encodings.

public Boolean RespectPayloadDefaults { get; set; } #
CodeGlyphX/QrEasyOptions.cs:50

When true, payload defaults may override version/ECC settings.

public Int32 MinVersion { get; set; } #
CodeGlyphX/QrEasyOptions.cs:55

Minimum QR version (1..40).

public Int32 MaxVersion { get; set; } #
CodeGlyphX/QrEasyOptions.cs:60

Maximum QR version (1..40).

public Nullable<Int32> ForceMask { get; set; } #
CodeGlyphX/QrEasyOptions.cs:65

Optional forced mask pattern (0..7).

public Rgba32 Foreground { get; set; } #
CodeGlyphX/QrEasyOptions.cs:70

Foreground color.

public Rgba32 Background { get; set; } #
CodeGlyphX/QrEasyOptions.cs:75

Background color.

public QrPngGradientOptions BackgroundGradient { get; set; } #
CodeGlyphX/QrEasyOptions.cs:80

Optional background gradient.

public QrPngBackgroundPatternOptions BackgroundPattern { get; set; } #
CodeGlyphX/QrEasyOptions.cs:85

Optional pattern overlay for the QR background area.

public Int32 BackgroundSupersample { get; set; } #
CodeGlyphX/QrEasyOptions.cs:90

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

public QrRenderStyle Style { get; set; } #
CodeGlyphX/QrEasyOptions.cs:95

Style preset for PNG rendering.

public QrArtOptions Art { get; set; } #
CodeGlyphX/QrEasyOptions.cs:100

High-level QR art options (theme + variant + intensity).

public Boolean ArtAutoTune { get; set; } #
CodeGlyphX/QrEasyOptions.cs:105

When true, applies scan-safety auto-tuning for art-heavy styles.

public Int32 ArtAutoTuneMinScore { get; set; } #
CodeGlyphX/QrEasyOptions.cs:110

Minimum safety score target (0..100) for art auto-tuning.

public Nullable<QrPngModuleShape> ModuleShape { get; set; } #
CodeGlyphX/QrEasyOptions.cs:115

Overrides the module shape (when set).

public Nullable<Double> ModuleScale { get; set; } #
CodeGlyphX/QrEasyOptions.cs:120

Overrides the module scale (0.1..1.0).

public QrPngModuleScaleMapOptions ModuleScaleMap { get; set; } #
CodeGlyphX/QrEasyOptions.cs:125

Overrides the module scale map.

public QrPngModuleShapeMapOptions ModuleShapeMap { get; set; } #
CodeGlyphX/QrEasyOptions.cs:130

Overrides the module shape map.

public QrPngModuleJitterOptions ModuleJitter { get; set; } #
CodeGlyphX/QrEasyOptions.cs:135

Overrides per-module jitter options.

public Boolean ProtectFunctionalPatterns { get; set; } #
CodeGlyphX/QrEasyOptions.cs:141

When true, keeps non-eye functional patterns at a stable, scan-friendly style.

public Boolean ProtectQuietZone { get; set; } #
CodeGlyphX/QrEasyOptions.cs:146

When true and a background pattern is enabled, preserves a clean quiet zone.

public Nullable<Int32> ModuleCornerRadiusPx { get; set; } #
CodeGlyphX/QrEasyOptions.cs:151

Overrides the module corner radius in pixels.

public QrPngGradientOptions ForegroundGradient { get; set; } #
CodeGlyphX/QrEasyOptions.cs:156

Overrides the foreground gradient.

public QrPngPaletteOptions ForegroundPalette { get; set; } #
CodeGlyphX/QrEasyOptions.cs:161

Overrides the foreground palette.

public QrPngForegroundPatternOptions ForegroundPattern { get; set; } #
CodeGlyphX/QrEasyOptions.cs:166

Overrides the foreground pattern overlay.

public QrPngPaletteZoneOptions ForegroundPaletteZones { get; set; } #
CodeGlyphX/QrEasyOptions.cs:171

Overrides palette zones.

public QrPngCanvasOptions Canvas { get; set; } #
CodeGlyphX/QrEasyOptions.cs:176

Optional canvas options for sticker-style output.

public QrPngDebugOptions Debug { get; set; } #
CodeGlyphX/QrEasyOptions.cs:181

Optional debug overlay options (PNG only).

public QrPngEyeOptions Eyes { get; set; } #
CodeGlyphX/QrEasyOptions.cs:186

Overrides eye (finder) styling.

public Byte[] LogoPng { get; set; } #
CodeGlyphX/QrEasyOptions.cs:191

Optional logo PNG bytes (embedded for PNG/SVG/HTML).

public Double LogoScale { get; set; } #
CodeGlyphX/QrEasyOptions.cs:196

Logo size relative to the QR area (excluding quiet zone).

public Int32 LogoPaddingPx { get; set; } #
CodeGlyphX/QrEasyOptions.cs:201

Padding around the logo in pixels.

public Boolean LogoDrawBackground { get; set; } #
CodeGlyphX/QrEasyOptions.cs:207

Whether to draw a background plate behind the logo. When enabled, the encoder may auto-bump the minimum version for scan safety.

public Boolean AutoBumpVersionForLogoBackground { get; set; } #
CodeGlyphX/QrEasyOptions.cs:212

When true, bumps MinVersion to a safer minimum for logo background plates.

public Int32 LogoBackgroundMinVersion { get; set; } #
CodeGlyphX/QrEasyOptions.cs:217

Minimum version to use when a logo background plate is enabled (0 = disable auto bump).

public Nullable<Rgba32> LogoBackground { get; set; } #
CodeGlyphX/QrEasyOptions.cs:222

Logo background color (defaults to QR background).

public Int32 LogoCornerRadiusPx { get; set; } #
CodeGlyphX/QrEasyOptions.cs:227

Logo background corner radius in pixels.

public Int32 JpegQuality { get; set; } #
CodeGlyphX/QrEasyOptions.cs:232

JPEG quality (1..100).

public JpegEncodeOptions JpegOptions { get; set; } #
CodeGlyphX/QrEasyOptions.cs:238

Optional JPEG encoding options (subsampling/progressive/metadata/etc). When set, overrides JpegQuality where applicable.

public Int32 WebpQuality { get; set; } #
CodeGlyphX/QrEasyOptions.cs:244

WebP quality (0..100). A value of 100 uses lossless VP8L.

public Int32[] IcoSizes { get; set; } #
CodeGlyphX/QrEasyOptions.cs:253

ICO output sizes in pixels (1..256). Defaults to common icon sizes.

public Boolean IcoPreserveAspectRatio { get; set; } #
CodeGlyphX/QrEasyOptions.cs:258

When true, preserves aspect ratio and pads to square for ICO.

public Boolean HtmlEmailSafeTable { get; set; } #
CodeGlyphX/QrEasyOptions.cs:263

When true, renders HTML using email-safe tables.