CodeGlyphX logo
CodeGlyphX

API Reference

Class

QrDecoder

Namespace CodeGlyphX
Assembly CodeGlyphX
Modifiers static

Decodes QR codes from a module grid or from raw pixels (clean images).

Inheritance

  • Object
  • QrDecoder

Remarks

Current scope: byte + kanji payloads on clean/generated images and clean on-screen QR codes.

Methods

TryDecode 16 overloads
public static Boolean TryDecode(BitMatrix modules, out QrDecoded result) #
Returns: Boolean

Attempts to decode a QR code from an exact module grid (no quiet zone).

Parameters

modules CodeGlyphX.BitMatrix requiredposition: 0
Square matrix of QR modules (dark = true).
result CodeGlyphX.QrDecoded@ requiredposition: 1
Decoded payload.

Returns

true when decoding succeeded; otherwise false.

public static Boolean TryDecode(BitMatrix modules, out QrDecoded result, out QrDecodeInfo info) #
Returns: Boolean

Attempts to decode a QR code from an exact module grid (no quiet zone), with diagnostics.

Parameters

modules CodeGlyphX.BitMatrix requiredposition: 0
Square matrix of QR modules (dark = true).
result CodeGlyphX.QrDecoded@ requiredposition: 1
Decoded payload.
info CodeGlyphX.QrDecodeInfo@ requiredposition: 2
Decode diagnostics.

Returns

true when decoding succeeded; otherwise false.

public static Boolean TryDecode(BitMatrix modules, out QrDecoded result, CancellationToken cancellationToken) #
Returns: Boolean

Attempts to decode a QR code from an exact module grid, with cancellation.

Parameters

modules CodeGlyphX.BitMatrix requiredposition: 0
result CodeGlyphX.QrDecoded@ requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2
public static Boolean TryDecode(BitMatrix modules, out QrDecoded result, out QrDecodeInfo info, CancellationToken cancellationToken) #
Returns: Boolean

Attempts to decode a QR code from an exact module grid, with diagnostics and cancellation.

Parameters

modules CodeGlyphX.BitMatrix requiredposition: 0
result CodeGlyphX.QrDecoded@ requiredposition: 1
info CodeGlyphX.QrDecodeInfo@ requiredposition: 2
cancellationToken System.Threading.CancellationToken requiredposition: 3
public static Boolean TryDecode(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, out QrDecoded result) #
Returns: Boolean

Attempts to decode a QR code from raw pixel data (best-effort, clean inputs).

Parameters

pixels System.ReadOnlySpan{System.Byte} requiredposition: 0
Pixel buffer.
width System.Int32 requiredposition: 1
Image width in pixels.
height System.Int32 requiredposition: 2
Image height in pixels.
stride System.Int32 requiredposition: 3
Bytes per row.
fmt CodeGlyphX.PixelFormat requiredposition: 4
Pixel format (4 bytes per pixel).
result CodeGlyphX.QrDecoded@ requiredposition: 5
Decoded payload.

Returns

true when decoding succeeded; otherwise false.

public static Boolean TryDecode(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, out QrDecoded result, QrPixelDecodeOptions options) #
Returns: Boolean

Attempts to decode a QR code from raw pixel data (best-effort, clean inputs) using the specified profile.

Parameters

pixels System.ReadOnlySpan{System.Byte} requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
fmt CodeGlyphX.PixelFormat requiredposition: 4
result CodeGlyphX.QrDecoded@ requiredposition: 5
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 6
public static Boolean TryDecode(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, out QrDecoded result, QrPixelDecodeOptions options, CancellationToken cancellationToken) #
Returns: Boolean

Attempts to decode a QR code from raw pixel data (best-effort, clean inputs) using the specified profile, with cancellation.

Parameters

pixels System.ReadOnlySpan{System.Byte} requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
fmt CodeGlyphX.PixelFormat requiredposition: 4
result CodeGlyphX.QrDecoded@ requiredposition: 5
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 6
cancellationToken System.Threading.CancellationToken requiredposition: 7
public static Boolean TryDecode(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, out QrDecoded result, out QrPixelDecodeInfo info) #
Returns: Boolean

Attempts to decode a QR code from raw pixel data (best-effort, clean inputs), with diagnostics.

Parameters

pixels System.ReadOnlySpan{System.Byte} requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
fmt CodeGlyphX.PixelFormat requiredposition: 4
result CodeGlyphX.QrDecoded@ requiredposition: 5
info CodeGlyphX.QrPixelDecodeInfo@ requiredposition: 6
public static Boolean TryDecode(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, out QrDecoded result, out QrPixelDecodeInfo info, QrPixelDecodeOptions options) #
Returns: Boolean

Attempts to decode a QR code from raw pixel data (best-effort, clean inputs), with diagnostics and profile options.

Parameters

pixels System.ReadOnlySpan{System.Byte} requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
fmt CodeGlyphX.PixelFormat requiredposition: 4
result CodeGlyphX.QrDecoded@ requiredposition: 5
info CodeGlyphX.QrPixelDecodeInfo@ requiredposition: 6
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 7
public static Boolean TryDecode(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, out QrDecoded result, out QrPixelDecodeInfo info, QrPixelDecodeOptions options, CancellationToken cancellationToken) #
Returns: Boolean

Attempts to decode a QR code from raw pixel data (best-effort, clean inputs), with diagnostics, profile options, and cancellation.

Parameters

pixels System.ReadOnlySpan{System.Byte} requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
fmt CodeGlyphX.PixelFormat requiredposition: 4
result CodeGlyphX.QrDecoded@ requiredposition: 5
info CodeGlyphX.QrPixelDecodeInfo@ requiredposition: 6
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 7
cancellationToken System.Threading.CancellationToken requiredposition: 8
public static Boolean TryDecode(Byte[] pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, out QrDecoded result) #
Returns: Boolean

Attempts to decode a QR code from raw pixel data (best-effort, clean inputs).

Parameters

pixels System.Byte[] requiredposition: 0
Pixel buffer.
width System.Int32 requiredposition: 1
Image width in pixels.
height System.Int32 requiredposition: 2
Image height in pixels.
stride System.Int32 requiredposition: 3
Bytes per row.
fmt CodeGlyphX.PixelFormat requiredposition: 4
Pixel format (4 bytes per pixel).
result CodeGlyphX.QrDecoded@ requiredposition: 5
Decoded payload.

Returns

true when decoding succeeded; otherwise false.

public static Boolean TryDecode(Byte[] pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, out QrDecoded result, QrPixelDecodeOptions options) #
Returns: Boolean

Attempts to decode a QR code from raw pixel data (best-effort, clean inputs) using the specified profile.

Parameters

pixels System.Byte[] requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
fmt CodeGlyphX.PixelFormat requiredposition: 4
result CodeGlyphX.QrDecoded@ requiredposition: 5
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 6
public static Boolean TryDecode(Byte[] pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, out QrDecoded result, QrPixelDecodeOptions options, CancellationToken cancellationToken) #
Returns: Boolean

Attempts to decode a QR code from raw pixel data (best-effort, clean inputs) using the specified profile, with cancellation.

Parameters

pixels System.Byte[] requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
fmt CodeGlyphX.PixelFormat requiredposition: 4
result CodeGlyphX.QrDecoded@ requiredposition: 5
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 6
cancellationToken System.Threading.CancellationToken requiredposition: 7
public static Boolean TryDecode(Byte[] pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, out QrDecoded result, out QrPixelDecodeInfo info) #
Returns: Boolean

Attempts to decode a QR code from raw pixel data (best-effort, clean inputs), with diagnostics.

Parameters

pixels System.Byte[] requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
fmt CodeGlyphX.PixelFormat requiredposition: 4
result CodeGlyphX.QrDecoded@ requiredposition: 5
info CodeGlyphX.QrPixelDecodeInfo@ requiredposition: 6
public static Boolean TryDecode(Byte[] pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, out QrDecoded result, out QrPixelDecodeInfo info, QrPixelDecodeOptions options) #
Returns: Boolean

Attempts to decode a QR code from raw pixel data (best-effort, clean inputs), with diagnostics and profile options.

Parameters

pixels System.Byte[] requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
fmt CodeGlyphX.PixelFormat requiredposition: 4
result CodeGlyphX.QrDecoded@ requiredposition: 5
info CodeGlyphX.QrPixelDecodeInfo@ requiredposition: 6
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 7
public static Boolean TryDecode(Byte[] pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, out QrDecoded result, out QrPixelDecodeInfo info, QrPixelDecodeOptions options, CancellationToken cancellationToken) #
Returns: Boolean

Attempts to decode a QR code from raw pixel data (best-effort, clean inputs), with diagnostics, profile options, and cancellation.

Parameters

pixels System.Byte[] requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
fmt CodeGlyphX.PixelFormat requiredposition: 4
result CodeGlyphX.QrDecoded@ requiredposition: 5
info CodeGlyphX.QrPixelDecodeInfo@ requiredposition: 6
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 7
cancellationToken System.Threading.CancellationToken requiredposition: 8
TryDecodeAll 6 overloads
public static Boolean TryDecodeAll(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, out QrDecoded[] results) #
Returns: Boolean

Attempts to decode all QR codes from raw pixel data (best-effort, clean inputs).

Parameters

pixels System.ReadOnlySpan{System.Byte} requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
fmt CodeGlyphX.PixelFormat requiredposition: 4
results CodeGlyphX.QrDecoded[]@ requiredposition: 5
public static Boolean TryDecodeAll(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, out QrDecoded[] results, QrPixelDecodeOptions options) #
Returns: Boolean

Attempts to decode all QR codes from raw pixel data (best-effort, clean inputs) using the specified profile.

Parameters

pixels System.ReadOnlySpan{System.Byte} requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
fmt CodeGlyphX.PixelFormat requiredposition: 4
results CodeGlyphX.QrDecoded[]@ requiredposition: 5
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 6
public static Boolean TryDecodeAll(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, out QrDecoded[] results, QrPixelDecodeOptions options, CancellationToken cancellationToken) #
Returns: Boolean

Attempts to decode all QR codes from raw pixel data (best-effort, clean inputs) using the specified profile, with cancellation.

Parameters

pixels System.ReadOnlySpan{System.Byte} requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
fmt CodeGlyphX.PixelFormat requiredposition: 4
results CodeGlyphX.QrDecoded[]@ requiredposition: 5
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 6
cancellationToken System.Threading.CancellationToken requiredposition: 7
public static Boolean TryDecodeAll(Byte[] pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, out QrDecoded[] results) #
Returns: Boolean

Attempts to decode all QR codes from raw pixel data (best-effort, clean inputs).

Parameters

pixels System.Byte[] requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
fmt CodeGlyphX.PixelFormat requiredposition: 4
results CodeGlyphX.QrDecoded[]@ requiredposition: 5
public static Boolean TryDecodeAll(Byte[] pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, out QrDecoded[] results, QrPixelDecodeOptions options) #
Returns: Boolean

Attempts to decode all QR codes from raw pixel data (best-effort, clean inputs) using the specified profile.

Parameters

pixels System.Byte[] requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
fmt CodeGlyphX.PixelFormat requiredposition: 4
results CodeGlyphX.QrDecoded[]@ requiredposition: 5
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 6
public static Boolean TryDecodeAll(Byte[] pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, out QrDecoded[] results, QrPixelDecodeOptions options, CancellationToken cancellationToken) #
Returns: Boolean

Attempts to decode all QR codes from raw pixel data (best-effort, clean inputs) using the specified profile, with cancellation.

Parameters

pixels System.Byte[] requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
fmt CodeGlyphX.PixelFormat requiredposition: 4
results CodeGlyphX.QrDecoded[]@ requiredposition: 5
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 6
cancellationToken System.Threading.CancellationToken requiredposition: 7