CodeGlyphX logo
CodeGlyphX

API Reference

Class

MicroQrDecoder

Namespace CodeGlyphX
Assembly CodeGlyphX
Modifiers static

Decodes Micro QR codes from a module grid.

Inheritance

  • Object
  • MicroQrDecoder

Methods

TryDecode 9 overloads
public static Boolean TryDecode(BitMatrix modules, out MicroQrDecoded result) #
Returns: Boolean

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

Parameters

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

Returns

true when decoding succeeded; otherwise false.

public static Boolean TryDecode(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat format, out MicroQrDecoded decoded) #
Returns: Boolean

Attempts to recognize and decode a Micro QR symbol from RGBA32 or BGRA32 pixels.

Parameters

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

Attempts to recognize and decode a Micro QR symbol from RGBA32 or BGRA32 pixels, 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
format CodeGlyphX.PixelFormat requiredposition: 4
cancellationToken System.Threading.CancellationToken requiredposition: 5
decoded CodeGlyphX.MicroQrDecoded@ requiredposition: 6
public static Boolean TryDecode(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat format, out MicroQrDecoded decoded, out MicroQrPixelDecodeInfo info) #
Returns: Boolean

Attempts to recognize and decode a Micro QR symbol from RGBA32 or BGRA32 pixels and returns recognition metadata.

Parameters

pixels System.ReadOnlySpan{System.Byte} requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
format CodeGlyphX.PixelFormat requiredposition: 4
decoded CodeGlyphX.MicroQrDecoded@ requiredposition: 5
info CodeGlyphX.MicroQrPixelDecodeInfo@ requiredposition: 6
public static Boolean TryDecode(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat format, CancellationToken cancellationToken, out MicroQrDecoded decoded, out MicroQrPixelDecodeInfo info) #
Returns: Boolean

Attempts to recognize and decode a Micro QR symbol from RGBA32 or BGRA32 pixels, with cancellation and recognition metadata.

Parameters

pixels System.ReadOnlySpan{System.Byte} requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
format CodeGlyphX.PixelFormat requiredposition: 4
cancellationToken System.Threading.CancellationToken requiredposition: 5
decoded CodeGlyphX.MicroQrDecoded@ requiredposition: 6
info CodeGlyphX.MicroQrPixelDecodeInfo@ requiredposition: 7
public static Boolean TryDecode(Byte[] pixels, Int32 width, Int32 height, Int32 stride, PixelFormat format, out MicroQrDecoded decoded) #
Returns: Boolean

Attempts to recognize and decode a Micro QR symbol from RGBA32 or BGRA32 pixels.

Parameters

pixels System.Byte[] requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
format CodeGlyphX.PixelFormat requiredposition: 4
decoded CodeGlyphX.MicroQrDecoded@ requiredposition: 5
public static Boolean TryDecode(Byte[] pixels, Int32 width, Int32 height, Int32 stride, PixelFormat format, CancellationToken cancellationToken, out MicroQrDecoded decoded) #
Returns: Boolean

Attempts to recognize and decode a Micro QR symbol from RGBA32 or BGRA32 pixels, with cancellation.

Parameters

pixels System.Byte[] requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
format CodeGlyphX.PixelFormat requiredposition: 4
cancellationToken System.Threading.CancellationToken requiredposition: 5
decoded CodeGlyphX.MicroQrDecoded@ requiredposition: 6
public static Boolean TryDecode(Byte[] pixels, Int32 width, Int32 height, Int32 stride, PixelFormat format, out MicroQrDecoded decoded, out MicroQrPixelDecodeInfo info) #
Returns: Boolean

Attempts to recognize and decode a Micro QR symbol from RGBA32 or BGRA32 pixels and returns recognition metadata.

Parameters

pixels System.Byte[] requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
format CodeGlyphX.PixelFormat requiredposition: 4
decoded CodeGlyphX.MicroQrDecoded@ requiredposition: 5
info CodeGlyphX.MicroQrPixelDecodeInfo@ requiredposition: 6
public static Boolean TryDecode(Byte[] pixels, Int32 width, Int32 height, Int32 stride, PixelFormat format, CancellationToken cancellationToken, out MicroQrDecoded decoded, out MicroQrPixelDecodeInfo info) #
Returns: Boolean

Attempts to recognize and decode a Micro QR symbol from RGBA32 or BGRA32 pixels, with cancellation and recognition metadata.

Parameters

pixels System.Byte[] requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
format CodeGlyphX.PixelFormat requiredposition: 4
cancellationToken System.Threading.CancellationToken requiredposition: 5
decoded CodeGlyphX.MicroQrDecoded@ requiredposition: 6
info CodeGlyphX.MicroQrPixelDecodeInfo@ requiredposition: 7
TryDecodeImage 2 overloads
public static Boolean TryDecodeImage(Byte[] encodedImage, out MicroQrDecoded decoded, ImageDecodeOptions options = null, CancellationToken cancellationToken = null) #
Returns: Boolean

Attempts to decode an encoded raster image supported by the managed image reader and recognize a Micro QR symbol.

Parameters

encodedImage System.Byte[] requiredposition: 0
decoded CodeGlyphX.MicroQrDecoded@ requiredposition: 1
options CodeGlyphX.ImageDecodeOptions = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
public static Boolean TryDecodeImage(Byte[] encodedImage, out MicroQrDecoded decoded, out MicroQrPixelDecodeInfo info, ImageDecodeOptions options = null, CancellationToken cancellationToken = null) #
Returns: Boolean

Attempts to decode an encoded raster image supported by the managed image reader, recognize a Micro QR symbol, and return recognition metadata.

Parameters

encodedImage System.Byte[] requiredposition: 0
decoded CodeGlyphX.MicroQrDecoded@ requiredposition: 1
info CodeGlyphX.MicroQrPixelDecodeInfo@ requiredposition: 2
options CodeGlyphX.ImageDecodeOptions = null optionalposition: 3
cancellationToken System.Threading.CancellationToken = null optionalposition: 4