CodeGlyphX logo
CodeGlyphX

API Reference

Class

QrPixelDecodeOptions

Namespace CodeGlyphX
Assembly CodeGlyphX
Modifiers sealed

Options for pixel-based QR decoding.

Inheritance

  • Object
  • QrPixelDecodeOptions

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

public QrPixelDecodeOptions() #

Methods

public static QrPixelDecodeOptions Balanced() #
Returns: QrPixelDecodeOptions

Balanced preset (good default for most images).

public static QrPixelDecodeOptions Fast() #
Returns: QrPixelDecodeOptions

Fast preset (lower accuracy, fewer transforms).

public static QrPixelDecodeOptions Robust() #
Returns: QrPixelDecodeOptions

Robust preset (best accuracy, slower).

public static QrPixelDecodeOptions Screen(Int32 maxMilliseconds = 300, Int32 maxDimension = 1200) #
Returns: QrPixelDecodeOptions

Screen preset (budgeted decode for UI capture scenarios).

Parameters

maxMilliseconds System.Int32 = 300 optionalposition: 0
maxDimension System.Int32 = 1200 optionalposition: 1
public static QrPixelDecodeOptions Stylized() #
Returns: QrPixelDecodeOptions

Stylized preset (adds aggressive sampling for QR art).

public QrPixelDecodeOptions WithAggressiveSampling(Boolean enabled = true) #
Returns: QrPixelDecodeOptions

Enables or disables aggressive sampling.

Parameters

enabled System.Boolean = true optionalposition: 0
public QrPixelDecodeOptions WithAutoCrop(Boolean enabled = true) #
Returns: QrPixelDecodeOptions

Enables or disables auto-crop for QR decoding.

Parameters

enabled System.Boolean = true optionalposition: 0
public QrPixelDecodeOptions WithBudget(Int32 maxMilliseconds, Int32 maxDimension = 0) #
Returns: QrPixelDecodeOptions

Sets the time+dimension budget in one call.

Parameters

maxMilliseconds System.Int32 requiredposition: 0
maxDimension System.Int32 = 0 optionalposition: 1
public QrPixelDecodeOptions WithBudgetMilliseconds(Int32 maxMilliseconds) #
Returns: QrPixelDecodeOptions

Sets a hard decode time budget without profile downgrades.

Parameters

maxMilliseconds System.Int32 requiredposition: 0
public QrPixelDecodeOptions WithMaxDimension(Int32 maxDimension) #
Returns: QrPixelDecodeOptions

Sets maximum dimension (pixels) for QR decoding.

Parameters

maxDimension System.Int32 requiredposition: 0
public QrPixelDecodeOptions WithMaxMilliseconds(Int32 maxMilliseconds) #
Returns: QrPixelDecodeOptions

Sets the maximum decode time budget.

Parameters

maxMilliseconds System.Int32 requiredposition: 0
public QrPixelDecodeOptions WithMaxScale(Int32 maxScale) #
Returns: QrPixelDecodeOptions

Sets maximum scale to try (1..8).

Parameters

maxScale System.Int32 requiredposition: 0
public QrPixelDecodeOptions WithoutTransforms() #
Returns: QrPixelDecodeOptions

Disables rotation/mirroring attempts.

public QrPixelDecodeOptions WithProfile(QrDecodeProfile profile) #
Returns: QrPixelDecodeOptions

Sets the profile (fast/balanced/robust).

Parameters

profile CodeGlyphX.QrDecodeProfile requiredposition: 0
public QrPixelDecodeOptions WithStylizedSampling(Boolean enabled = true) #
Returns: QrPixelDecodeOptions

Enables or disables stylized sampling for QR art.

Parameters

enabled System.Boolean = true optionalposition: 0
public QrPixelDecodeOptions WithTileScan(Boolean enabled = true, Int32 tileGrid = 0) #
Returns: QrPixelDecodeOptions

Enables tile-based scanning for multiple QR codes.

Parameters

enabled System.Boolean = true optionalposition: 0
tileGrid System.Int32 = 0 optionalposition: 1

Properties

public QrDecodeProfile Profile { get; set; } #

Speed/accuracy profile (default: Robust).

public Int32 MaxDimension { get; set; } #

Maximum dimension (pixels) for decoding. Larger inputs will be downscaled by sampling. Set to 0 to disable.

public Int32 MaxScale { get; set; } #

Maximum scale to try when decoding (1..8). Set to 0 to use profile defaults.

public Int32 MaxMilliseconds { get; set; } #

Maximum milliseconds to spend decoding (best effort). Set to 0 to disable.

public Int32 BudgetMilliseconds { get; set; } #

Hard budget in milliseconds for decoding (best effort), without profile downgrades. When set, this is used for internal time budgeting instead of MaxMilliseconds.

public Boolean AutoCrop { get; set; } #

Attempts to auto-crop likely QR regions before decoding (useful for screenshots).

public Boolean EnableTileScan { get; set; } #

Enables tile-based scanning for multiple QR codes in one image.

public Int32 TileGrid { get; set; } #

Tile grid size for multi-scan (0 = auto, 2..4 recommended).

public Boolean DisableTransforms { get; set; } #

Disable rotation/mirroring attempts even in robust profiles.

public Boolean AggressiveSampling { get; set; } #

Enables extra thresholding/sampling passes for stylized or noisy QR codes (slower).

public Boolean StylizedSampling { get; set; } #

Enables stylized sampling tuned for QR art (opt-in, slower).