API Reference
QrEasyOptions
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
- Property HotpBuilder.Options
- Property TotpBuilder.Options
- Property QrBuilder.Options
- Method QrPresets.Contact
- Method QrPresets.Logo
- Method QrPresets.Otp
- Method QrPresets.Wifi
Accepted by parameters
- Method Otp.Hotp
- Method Otp.Totp
- Method HotpBuilder.WithOptions
- Method TotpBuilder.WithOptions
- Method QR.AsciiConsole
- Method QR.AsciiConsole
- Method QR.AsciiConsoleAuto
- Method QR.Create
- Method QR.Create
- Method QR.Encode
- Method QR.Encode
- Method QR.EncodeAuto
- Method QR.Save
- Method QR.Save
- Method QR.SaveAuto
- Method QrBuilder.WithOptions
- Method QrCode.Encode
- Method QrCode.Encode
- Method QrCode.EncodeAuto
- Method QrCode.Render
- Method QrCode.Render
- Method QrCode.Render
- Method QrCode.RenderAuto
- Method QrCode.Save
- Method QrCode.Save
- Method QrCode.Save
- Method QrCode.Save
- Method QrEasy.Encode
- Method QrEasy.Encode
- Method QrEasy.EncodeAuto
- Method QrEasy.EvaluateScanHeuristics
- Method QrEasy.EvaluateScanHeuristics
- Method QrEasy.RenderAsciiConsole
- Method QrEasy.RenderAsciiConsole
- Method QrEasy.RenderAsciiConsoleAuto
- Method QrEasy.RenderPixels
- Method QrEasy.RenderPixels
Constructors
public QrEasyOptions() #Inherited Methods
Properties
public Int32 ModuleSize { get; set; } #Module size in pixels.
public Int32 QuietZone { get; set; } #Quiet zone size in modules.
public Int32 TargetSizePx { get; set; } #Target output size in pixels (0 = disabled). When set, module size is adjusted to fit this target.
public Boolean TargetSizeIncludesQuietZone { get; set; } #When true, TargetSizePx includes the quiet zone.
public Nullable<QrErrorCorrectionLevel> ErrorCorrectionLevel { get; set; } #Optional error correction level override.
public Nullable<QrTextEncoding> TextEncoding { get; set; } #Optional text encoding override (when set, emits ECI for non-default encodings).
public Boolean IncludeEci { get; set; } #When true, emits ECI headers for non-default encodings.
public Boolean RespectPayloadDefaults { get; set; } #When true, payload defaults may override version/ECC settings.
public Int32 MinVersion { get; set; } #Minimum QR version (1..40).
public Int32 MaxVersion { get; set; } #Maximum QR version (1..40).
public Nullable<Int32> ForceMask { get; set; } #Optional forced mask pattern (0..7).
public Rgba32 Foreground { get; set; } #Foreground color.
public Rgba32 Background { get; set; } #Background color.
public QrPngGradientOptions BackgroundGradient { get; set; } #Optional background gradient.
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).
public QrRenderStyle Style { get; set; } #Style preset for PNG rendering.
public QrArtOptions Art { get; set; } #High-level QR art options (theme + variant + intensity).
public Boolean ArtGuardrailsEnabled { get; set; } #When true, applies conservative static guardrails for art-heavy styles. This does not validate the rendered output with a decoder.
public Int32 ArtGuardrailMinimumScore { get; set; } #Minimum static heuristic score target (0..100) for art guardrails.
public Nullable<QrPngModuleShape> ModuleShape { get; set; } #Overrides the module shape (when set).
public Nullable<Double> ModuleScale { get; set; } #Overrides the module scale (0.1..1.0).
public QrPngModuleScaleMapOptions ModuleScaleMap { get; set; } #Overrides the module scale map.
public QrPngModuleShapeMapOptions ModuleShapeMap { get; set; } #Overrides the module shape map.
public QrPngModuleJitterOptions ModuleJitter { get; set; } #Overrides per-module jitter options.
public Boolean ProtectFunctionalPatterns { get; set; } #When true, keeps non-eye functional patterns at a conventional style.
public Boolean ProtectQuietZone { get; set; } #When true and a background pattern is enabled, preserves a clean quiet zone.
public Nullable<Int32> ModuleCornerRadiusPx { get; set; } #Overrides the module corner radius in pixels.
public QrPngGradientOptions ForegroundGradient { get; set; } #Overrides the foreground gradient.
public QrPngPaletteOptions ForegroundPalette { get; set; } #Overrides the foreground palette.
public QrPngForegroundPatternOptions ForegroundPattern { get; set; } #Overrides the foreground pattern overlay.
public QrPngPaletteZoneOptions ForegroundPaletteZones { get; set; } #Overrides palette zones.
public QrPngCanvasOptions Canvas { get; set; } #Optional canvas options for sticker-style output.
public QrPngDebugOptions Debug { get; set; } #Optional debug overlay options (PNG only).
public QrPngEyeOptions Eyes { get; set; } #Overrides eye (finder) styling.
public Byte[] LogoPng { get; set; } #Optional logo PNG bytes (embedded for PNG/SVG/HTML).
public Double LogoScale { get; set; } #Logo size relative to the QR area (excluding quiet zone).
public Int32 LogoPaddingPx { get; set; } #Padding around the logo in pixels.
public Boolean LogoDrawBackground { get; set; } #Whether to draw a background plate behind the logo. When enabled, the encoder may auto-bump the minimum version to reduce logo coverage.
public Boolean AutoBumpVersionForLogoBackground { get; set; } #When true, bumps MinVersion to a more conservative minimum for logo background plates.
public Int32 LogoBackgroundMinVersion { get; set; } #Minimum version to use when a logo background plate is enabled (0 = disable auto bump).
public Nullable<Rgba32> LogoBackground { get; set; } #Logo background color (defaults to QR background).
public Int32 LogoCornerRadiusPx { get; set; } #Logo background corner radius in pixels.
public Int32 JpegQuality { get; set; } #JPEG quality (1..100).
public JpegEncodeOptions JpegOptions { get; set; } #Optional JPEG encoding options (subsampling/progressive/metadata/etc). When set, overrides JpegQuality where applicable.
public Int32 WebpQuality { get; set; } #WebP quality (0..100). A value of 100 uses lossless VP8L.
public Int32[] IcoSizes { get; set; } #ICO output sizes in pixels (1..256). Defaults to common icon sizes.
public Boolean IcoPreserveAspectRatio { get; set; } #When true, preserves aspect ratio and pads to square for ICO.
public Boolean HtmlEmailSafeTable { get; set; } #When true, renders HTML using email-safe tables.