CodeGlyphX logo
CodeGlyphX

API Reference

Class

QR

Edit on GitHub
Namespace CodeGlyphX
Assembly CodeGlyphX
Source ../../../../_/CodeGlyphX/QR.cs:29
Modifiers static

Simple QR helpers with fluent and static APIs.

Inheritance

  • Object
  • QR

Remarks

Use RenderExtras) to pick the output format by file extension.

Examples


using CodeGlyphX;
QR.Save("https://example.com", "qr.png");

Methods

AsciiConsole 2 overloads
public static String AsciiConsole(String payload, AsciiConsoleOptions consoleOptions = null, QrEasyOptions options = null) #
../../../../_/CodeGlyphX/QR.cs:72
Returns: String

Renders a QR code as console-friendly ASCII text with auto-fit.

Parameters

payload System.String requiredposition: 0
consoleOptions CodeGlyphX.Rendering.Ascii.AsciiConsoleOptions = null optionalposition: 1
options CodeGlyphX.QrEasyOptions = null optionalposition: 2
public static String AsciiConsole(QrPayloadData payload, AsciiConsoleOptions consoleOptions = null, QrEasyOptions options = null) #
../../../../_/CodeGlyphX/QR.cs:86
Returns: String

Renders a QR code as console-friendly ASCII text with auto-fit for a payload with embedded defaults.

Parameters

payload CodeGlyphX.Payloads.QrPayloadData requiredposition: 0
consoleOptions CodeGlyphX.Rendering.Ascii.AsciiConsoleOptions = null optionalposition: 1
options CodeGlyphX.QrEasyOptions = null optionalposition: 2
public static String AsciiConsoleAuto(String payload, QrPayloadDetectOptions detectOptions = null, AsciiConsoleOptions consoleOptions = null, QrEasyOptions options = null) #
../../../../_/CodeGlyphX/QR.cs:79
Returns: String

Detects a payload type and renders a QR code as console-friendly ASCII text with auto-fit.

Parameters

payload System.String requiredposition: 0
detectOptions CodeGlyphX.Payloads.QrPayloadDetectOptions = null optionalposition: 1
consoleOptions CodeGlyphX.Rendering.Ascii.AsciiConsoleOptions = null optionalposition: 2
options CodeGlyphX.QrEasyOptions = null optionalposition: 3
Create 2 overloads
public static QrBuilder Create(String payload, QrEasyOptions options = null) #
../../../../_/CodeGlyphX/QR.cs:29
Returns: QrBuilder

Starts a fluent QR builder for plain text.

Parameters

payload System.String requiredposition: 0
options CodeGlyphX.QrEasyOptions = null optionalposition: 1
public static QrBuilder Create(QrPayloadData payload, QrEasyOptions options = null) #
../../../../_/CodeGlyphX/QR.cs:36
Returns: QrBuilder

Starts a fluent QR builder for a payload with embedded defaults.

Parameters

payload CodeGlyphX.Payloads.QrPayloadData requiredposition: 0
options CodeGlyphX.QrEasyOptions = null optionalposition: 1
DecodePng 2 overloads
public static QrDecoded DecodePng(Byte[] png) #
../../../../_/CodeGlyphX/QR.Payload.cs:245
Returns: QrDecoded

Decodes a QR code from a PNG byte array.

Parameters

png System.Byte[] requiredposition: 0
public static QrDecoded DecodePng(Stream stream) #
../../../../_/CodeGlyphX/QR.Payload.cs:265
Returns: QrDecoded

Decodes a QR code from a PNG stream.

Parameters

stream System.IO.Stream requiredposition: 0
public static QrDecoded DecodePngFile(String path) #
../../../../_/CodeGlyphX/QR.Payload.cs:255
Returns: QrDecoded

Decodes a QR code from a PNG file.

Parameters

path System.String requiredposition: 0
Encode 2 overloads
public static QrCode Encode(String payload, QrEasyOptions options = null) #
../../../../_/CodeGlyphX/QR.cs:42
Returns: QrCode

Encodes a payload into a QR code.

Parameters

payload System.String requiredposition: 0
options CodeGlyphX.QrEasyOptions = null optionalposition: 1
public static QrCode Encode(QrPayloadData payload, QrEasyOptions options = null) #
../../../../_/CodeGlyphX/QR.cs:54
Returns: QrCode

Encodes a payload with embedded defaults into a QR code.

Parameters

payload CodeGlyphX.Payloads.QrPayloadData requiredposition: 0
options CodeGlyphX.QrEasyOptions = null optionalposition: 1
public static QrCode EncodeAuto(String payload, QrPayloadDetectOptions detectOptions = null, QrEasyOptions options = null) #
../../../../_/CodeGlyphX/QR.cs:48
Returns: QrCode

Detects a payload type and encodes it into a QR code.

Parameters

payload System.String requiredposition: 0
detectOptions CodeGlyphX.Payloads.QrPayloadDetectOptions = null optionalposition: 1
options CodeGlyphX.QrEasyOptions = null optionalposition: 2
public static QrParsedPayload ParsePayload(String payload) #
../../../../_/CodeGlyphX/QR.Payload.cs:31
Returns: QrParsedPayload

Parses a raw QR payload into a structured representation.

Parameters

payload System.String requiredposition: 0
Save 2 overloads
public static String Save(String payload, String path, QrEasyOptions options = null, RenderExtras extras = null) #
../../../../_/CodeGlyphX/QR.Save.cs:19
Returns: String

Saves a QR code to a file based on the file extension. Defaults to PNG when no extension is provided.

Parameters

payload System.String requiredposition: 0
path System.String requiredposition: 1
options CodeGlyphX.QrEasyOptions = null optionalposition: 2
extras CodeGlyphX.Rendering.RenderExtras = null optionalposition: 3
public static String Save(QrPayloadData payload, String path, QrEasyOptions options = null, RenderExtras extras = null) #
../../../../_/CodeGlyphX/QR.Save.cs:39
Returns: String

Saves a QR code to a file based on the file extension. Defaults to PNG when no extension is provided.

Parameters

payload CodeGlyphX.Payloads.QrPayloadData requiredposition: 0
path System.String requiredposition: 1
options CodeGlyphX.QrEasyOptions = null optionalposition: 2
extras CodeGlyphX.Rendering.RenderExtras = null optionalposition: 3
public static String SaveAuto(String payload, String path, QrPayloadDetectOptions detectOptions = null, QrEasyOptions options = null, RenderExtras extras = null) #
../../../../_/CodeGlyphX/QR.Save.cs:29
Returns: String

Detects a payload type and saves a QR code to a file based on the file extension. Defaults to PNG when no extension is provided.

Parameters

payload System.String requiredposition: 0
path System.String requiredposition: 1
detectOptions CodeGlyphX.Payloads.QrPayloadDetectOptions = null optionalposition: 2
options CodeGlyphX.QrEasyOptions = null optionalposition: 3
extras CodeGlyphX.Rendering.RenderExtras = null optionalposition: 4
TryDecodeAllImage 10 overloads
public static Boolean TryDecodeAllImage(Byte[] image, out QrDecoded[] decoded) #
../../../../_/CodeGlyphX/QR.Payload.cs:112
Returns: Boolean

Attempts to decode all QR codes from common image formats (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA).

Parameters

image System.Byte[] requiredposition: 0
decoded CodeGlyphX.QrDecoded[]@ requiredposition: 1
public static Boolean TryDecodeAllImage(Byte[] image, QrPixelDecodeOptions options, out QrDecoded[] decoded) #
../../../../_/CodeGlyphX/QR.Payload.cs:119
Returns: Boolean

Attempts to decode all QR codes from common image formats (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA) with options.

Parameters

image System.Byte[] requiredposition: 0
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 1
decoded CodeGlyphX.QrDecoded[]@ requiredposition: 2
public static Boolean TryDecodeAllImage(Byte[] image, QrPixelDecodeOptions options, CancellationToken cancellationToken, out QrDecoded[] decoded) #
../../../../_/CodeGlyphX/QR.Payload.cs:126
Returns: Boolean

Attempts to decode all QR codes from common image formats (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA) with options and cancellation.

Parameters

image System.Byte[] requiredposition: 0
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2
decoded CodeGlyphX.QrDecoded[]@ requiredposition: 3
public static Boolean TryDecodeAllImage(Byte[] image, ImageDecodeOptions imageOptions, QrPixelDecodeOptions options, out QrDecoded[] decoded) #
../../../../_/CodeGlyphX/QR.Payload.cs:137
Returns: Boolean

Attempts to decode all QR codes from common image formats (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA) with image decode options.

Parameters

image System.Byte[] requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 2
decoded CodeGlyphX.QrDecoded[]@ requiredposition: 3
public static Boolean TryDecodeAllImage(Byte[] image, ImageDecodeOptions imageOptions, QrPixelDecodeOptions options, CancellationToken cancellationToken, out QrDecoded[] decoded) #
../../../../_/CodeGlyphX/QR.Payload.cs:144
Returns: Boolean

Attempts to decode all QR codes from common image formats (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA) with image decode options and cancellation.

Parameters

image System.Byte[] requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 2
cancellationToken System.Threading.CancellationToken requiredposition: 3
decoded CodeGlyphX.QrDecoded[]@ requiredposition: 4
public static Boolean TryDecodeAllImage(Stream stream, out QrDecoded[] decoded) #
../../../../_/CodeGlyphX/QR.Payload.cs:205
Returns: Boolean

Attempts to decode all QR codes from an image stream (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA).

Parameters

stream System.IO.Stream requiredposition: 0
decoded CodeGlyphX.QrDecoded[]@ requiredposition: 1
public static Boolean TryDecodeAllImage(Stream stream, QrPixelDecodeOptions options, out QrDecoded[] decoded) #
../../../../_/CodeGlyphX/QR.Payload.cs:212
Returns: Boolean

Attempts to decode all QR codes from an image stream (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA) with options.

Parameters

stream System.IO.Stream requiredposition: 0
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 1
decoded CodeGlyphX.QrDecoded[]@ requiredposition: 2
public static Boolean TryDecodeAllImage(Stream stream, QrPixelDecodeOptions options, CancellationToken cancellationToken, out QrDecoded[] decoded) #
../../../../_/CodeGlyphX/QR.Payload.cs:219
Returns: Boolean

Attempts to decode all QR codes from an image stream (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA) with options and cancellation.

Parameters

stream System.IO.Stream requiredposition: 0
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2
decoded CodeGlyphX.QrDecoded[]@ requiredposition: 3
public static Boolean TryDecodeAllImage(Stream stream, ImageDecodeOptions imageOptions, QrPixelDecodeOptions options, out QrDecoded[] decoded) #
../../../../_/CodeGlyphX/QR.Payload.cs:231
Returns: Boolean

Attempts to decode all QR codes from an image stream (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA) with image decode options.

Parameters

stream System.IO.Stream requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 2
decoded CodeGlyphX.QrDecoded[]@ requiredposition: 3
public static Boolean TryDecodeAllImage(Stream stream, ImageDecodeOptions imageOptions, QrPixelDecodeOptions options, CancellationToken cancellationToken, out QrDecoded[] decoded) #
../../../../_/CodeGlyphX/QR.Payload.cs:238
Returns: Boolean

Attempts to decode all QR codes from an image stream (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA) with image decode options and cancellation.

Parameters

stream System.IO.Stream requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 2
cancellationToken System.Threading.CancellationToken requiredposition: 3
decoded CodeGlyphX.QrDecoded[]@ requiredposition: 4
TryDecodeAllPng 7 overloads
public static Boolean TryDecodeAllPng(Byte[] png, out QrDecoded[] decoded) #
../../../../_/CodeGlyphX/QR.Decode.cs:70
Returns: Boolean

Attempts to decode all QR codes from a PNG byte array.

Parameters

png System.Byte[] requiredposition: 0
decoded CodeGlyphX.QrDecoded[]@ requiredposition: 1
public static Boolean TryDecodeAllPng(Byte[] png, QrPixelDecodeOptions options, out QrDecoded[] decoded) #
../../../../_/CodeGlyphX/QR.Decode.cs:77
Returns: Boolean

Attempts to decode all QR codes from a PNG byte array with options.

Parameters

png System.Byte[] requiredposition: 0
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 1
decoded CodeGlyphX.QrDecoded[]@ requiredposition: 2
public static Boolean TryDecodeAllPng(Byte[] png, QrPixelDecodeOptions options, CancellationToken cancellationToken, out QrDecoded[] decoded) #
../../../../_/CodeGlyphX/QR.Decode.cs:84
Returns: Boolean

Attempts to decode all QR codes from a PNG byte array with options and cancellation.

Parameters

png System.Byte[] requiredposition: 0
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2
decoded CodeGlyphX.QrDecoded[]@ requiredposition: 3
public static Boolean TryDecodeAllPng(Byte[] png, ImageDecodeOptions imageOptions, QrPixelDecodeOptions options, out QrDecoded[] decoded) #
../../../../_/CodeGlyphX/QR.Decode.cs:95
Returns: Boolean

Attempts to decode all QR codes from a PNG byte array with image decode options.

Parameters

png System.Byte[] requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 2
decoded CodeGlyphX.QrDecoded[]@ requiredposition: 3
public static Boolean TryDecodeAllPng(Byte[] png, ImageDecodeOptions imageOptions, QrPixelDecodeOptions options, CancellationToken cancellationToken, out QrDecoded[] decoded) #
../../../../_/CodeGlyphX/QR.Decode.cs:102
Returns: Boolean

Attempts to decode all QR codes from a PNG byte array with image decode options and cancellation.

Parameters

png System.Byte[] requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 2
cancellationToken System.Threading.CancellationToken requiredposition: 3
decoded CodeGlyphX.QrDecoded[]@ requiredposition: 4
public static Boolean TryDecodeAllPng(Stream stream, out QrDecoded[] decoded) #
../../../../_/CodeGlyphX/QR.Payload.cs:38
Returns: Boolean

Attempts to decode all QR codes from a PNG stream.

Parameters

stream System.IO.Stream requiredposition: 0
decoded CodeGlyphX.QrDecoded[]@ requiredposition: 1
public static Boolean TryDecodeAllPng(Stream stream, QrPixelDecodeOptions options, CancellationToken cancellationToken, out QrDecoded[] decoded) #
../../../../_/CodeGlyphX/QR.Payload.cs:48
Returns: Boolean

Attempts to decode all QR codes from a PNG stream with options and cancellation.

Parameters

stream System.IO.Stream requiredposition: 0
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2
decoded CodeGlyphX.QrDecoded[]@ requiredposition: 3
TryDecodeAllPngFile 4 overloads
public static Boolean TryDecodeAllPngFile(String path, out QrDecoded[] decoded) #
../../../../_/CodeGlyphX/QR.Decode.cs:164
Returns: Boolean

Attempts to decode all QR codes from a PNG file.

Parameters

path System.String requiredposition: 0
decoded CodeGlyphX.QrDecoded[]@ requiredposition: 1
public static Boolean TryDecodeAllPngFile(String path, QrPixelDecodeOptions options, CancellationToken cancellationToken, out QrDecoded[] decoded) #
../../../../_/CodeGlyphX/QR.Decode.cs:174
Returns: Boolean

Attempts to decode all QR codes from a PNG file with options and cancellation.

Parameters

path System.String requiredposition: 0
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2
decoded CodeGlyphX.QrDecoded[]@ requiredposition: 3
public static Boolean TryDecodeAllPngFile(String path, ImageDecodeOptions imageOptions, QrPixelDecodeOptions options, out QrDecoded[] decoded) #
../../../../_/CodeGlyphX/QR.Decode.cs:184
Returns: Boolean

Attempts to decode all QR codes from a PNG file with image decode options.

Parameters

path System.String requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 2
decoded CodeGlyphX.QrDecoded[]@ requiredposition: 3
public static Boolean TryDecodeAllPngFile(String path, ImageDecodeOptions imageOptions, QrPixelDecodeOptions options, CancellationToken cancellationToken, out QrDecoded[] decoded) #
../../../../_/CodeGlyphX/QR.Decode.cs:191
Returns: Boolean

Attempts to decode all QR codes from a PNG file with image decode options and cancellation.

Parameters

path System.String requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 2
cancellationToken System.Threading.CancellationToken requiredposition: 3
decoded CodeGlyphX.QrDecoded[]@ requiredposition: 4
TryDecodeImage 14 overloads
public static Boolean TryDecodeImage(Byte[] image, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Payload.cs:59
Returns: Boolean

Attempts to decode a QR code from common image formats (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA).

Parameters

image System.Byte[] requiredposition: 0
decoded CodeGlyphX.QrDecoded@ requiredposition: 1
public static Boolean TryDecodeImage(Byte[] image, QrPixelDecodeOptions options, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Payload.cs:66
Returns: Boolean

Attempts to decode a QR code from common image formats (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA) with options.

Parameters

image System.Byte[] requiredposition: 0
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 1
decoded CodeGlyphX.QrDecoded@ requiredposition: 2
public static Boolean TryDecodeImage(Byte[] image, QrPixelDecodeOptions options, CancellationToken cancellationToken, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Payload.cs:73
Returns: Boolean

Attempts to decode a QR code from common image formats (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA) with options and cancellation.

Parameters

image System.Byte[] requiredposition: 0
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2
decoded CodeGlyphX.QrDecoded@ requiredposition: 3
public static Boolean TryDecodeImage(Byte[] image, ImageDecodeOptions imageOptions, QrPixelDecodeOptions options, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Payload.cs:84
Returns: Boolean

Attempts to decode a QR code from common image formats (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA) with image decode options.

Parameters

image System.Byte[] requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 2
decoded CodeGlyphX.QrDecoded@ requiredposition: 3
public static Boolean TryDecodeImage(Byte[] image, ImageDecodeOptions imageOptions, QrPixelDecodeOptions options, CancellationToken cancellationToken, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Payload.cs:91
Returns: Boolean

Attempts to decode a QR code from common image formats (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA) with image decode options and cancellation.

Parameters

image System.Byte[] requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 2
cancellationToken System.Threading.CancellationToken requiredposition: 3
decoded CodeGlyphX.QrDecoded@ requiredposition: 4
public static Boolean TryDecodeImage(Byte[] image, ImageDecodeOptions imageOptions, out QrDecoded decoded, out QrPixelDecodeInfo info, QrPixelDecodeOptions options = null) #
../../../../_/CodeGlyphX/QR.Payload.cs:98
Returns: Boolean

Attempts to decode a QR code from common image formats (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA) with image decode options, diagnostics, and profile options.

Parameters

image System.Byte[] requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
decoded CodeGlyphX.QrDecoded@ requiredposition: 2
info CodeGlyphX.QrPixelDecodeInfo@ requiredposition: 3
options CodeGlyphX.QrPixelDecodeOptions = null optionalposition: 4
public static Boolean TryDecodeImage(Byte[] image, ImageDecodeOptions imageOptions, out QrDecoded decoded, out QrPixelDecodeInfo info, QrPixelDecodeOptions options, CancellationToken cancellationToken) #
../../../../_/CodeGlyphX/QR.Payload.cs:105
Returns: Boolean

Attempts to decode a QR code from common image formats (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA) with image decode options, diagnostics, profile options, and cancellation.

Parameters

image System.Byte[] requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
decoded CodeGlyphX.QrDecoded@ requiredposition: 2
info CodeGlyphX.QrPixelDecodeInfo@ requiredposition: 3
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 4
cancellationToken System.Threading.CancellationToken requiredposition: 5
public static Boolean TryDecodeImage(Stream stream, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Payload.cs:151
Returns: Boolean

Attempts to decode a QR code from an image stream (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA).

Parameters

stream System.IO.Stream requiredposition: 0
decoded CodeGlyphX.QrDecoded@ requiredposition: 1
public static Boolean TryDecodeImage(Stream stream, QrPixelDecodeOptions options, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Payload.cs:158
Returns: Boolean

Attempts to decode a QR code from an image stream (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA) with options.

Parameters

stream System.IO.Stream requiredposition: 0
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 1
decoded CodeGlyphX.QrDecoded@ requiredposition: 2
public static Boolean TryDecodeImage(Stream stream, QrPixelDecodeOptions options, CancellationToken cancellationToken, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Payload.cs:165
Returns: Boolean

Attempts to decode a QR code from an image stream (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA) with options and cancellation.

Parameters

stream System.IO.Stream requiredposition: 0
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2
decoded CodeGlyphX.QrDecoded@ requiredposition: 3
public static Boolean TryDecodeImage(Stream stream, ImageDecodeOptions imageOptions, QrPixelDecodeOptions options, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Payload.cs:177
Returns: Boolean

Attempts to decode a QR code from an image stream (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA) with image decode options.

Parameters

stream System.IO.Stream requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 2
decoded CodeGlyphX.QrDecoded@ requiredposition: 3
public static Boolean TryDecodeImage(Stream stream, ImageDecodeOptions imageOptions, QrPixelDecodeOptions options, CancellationToken cancellationToken, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Payload.cs:184
Returns: Boolean

Attempts to decode a QR code from an image stream (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA) with image decode options and cancellation.

Parameters

stream System.IO.Stream requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 2
cancellationToken System.Threading.CancellationToken requiredposition: 3
decoded CodeGlyphX.QrDecoded@ requiredposition: 4
public static Boolean TryDecodeImage(Stream stream, ImageDecodeOptions imageOptions, out QrDecoded decoded, out QrPixelDecodeInfo info, QrPixelDecodeOptions options = null) #
../../../../_/CodeGlyphX/QR.Payload.cs:191
Returns: Boolean

Attempts to decode a QR code from an image stream (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA) with image decode options, diagnostics, and profile options.

Parameters

stream System.IO.Stream requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
decoded CodeGlyphX.QrDecoded@ requiredposition: 2
info CodeGlyphX.QrPixelDecodeInfo@ requiredposition: 3
options CodeGlyphX.QrPixelDecodeOptions = null optionalposition: 4
public static Boolean TryDecodeImage(Stream stream, ImageDecodeOptions imageOptions, out QrDecoded decoded, out QrPixelDecodeInfo info, QrPixelDecodeOptions options, CancellationToken cancellationToken) #
../../../../_/CodeGlyphX/QR.Payload.cs:198
Returns: Boolean

Attempts to decode a QR code from an image stream (PNG/BMP/PPM/PBM/PGM/PAM/XBM/XPM/TGA) with image decode options, diagnostics, profile options, and cancellation.

Parameters

stream System.IO.Stream requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
decoded CodeGlyphX.QrDecoded@ requiredposition: 2
info CodeGlyphX.QrPixelDecodeInfo@ requiredposition: 3
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 4
cancellationToken System.Threading.CancellationToken requiredposition: 5
TryDecodePng 13 overloads
public static Boolean TryDecodePng(Byte[] png, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Decode.cs:17
Returns: Boolean

Attempts to decode a QR code from a PNG byte array.

Parameters

png System.Byte[] requiredposition: 0
decoded CodeGlyphX.QrDecoded@ requiredposition: 1
public static Boolean TryDecodePng(Byte[] png, QrPixelDecodeOptions options, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Decode.cs:24
Returns: Boolean

Attempts to decode a QR code from a PNG byte array with options.

Parameters

png System.Byte[] requiredposition: 0
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 1
decoded CodeGlyphX.QrDecoded@ requiredposition: 2
public static Boolean TryDecodePng(Byte[] png, QrPixelDecodeOptions options, CancellationToken cancellationToken, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Decode.cs:31
Returns: Boolean

Attempts to decode a QR code from a PNG byte array with options and cancellation.

Parameters

png System.Byte[] requiredposition: 0
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2
decoded CodeGlyphX.QrDecoded@ requiredposition: 3
public static Boolean TryDecodePng(Byte[] png, ImageDecodeOptions imageOptions, QrPixelDecodeOptions options, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Decode.cs:42
Returns: Boolean

Attempts to decode a QR code from a PNG byte array with image decode options.

Parameters

png System.Byte[] requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 2
decoded CodeGlyphX.QrDecoded@ requiredposition: 3
public static Boolean TryDecodePng(Byte[] png, ImageDecodeOptions imageOptions, QrPixelDecodeOptions options, CancellationToken cancellationToken, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Decode.cs:49
Returns: Boolean

Attempts to decode a QR code from a PNG byte array with image decode options and cancellation.

Parameters

png System.Byte[] requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 2
cancellationToken System.Threading.CancellationToken requiredposition: 3
decoded CodeGlyphX.QrDecoded@ requiredposition: 4
public static Boolean TryDecodePng(Byte[] png, ImageDecodeOptions imageOptions, out QrDecoded decoded, out QrPixelDecodeInfo info, QrPixelDecodeOptions options = null) #
../../../../_/CodeGlyphX/QR.Decode.cs:56
Returns: Boolean

Attempts to decode a QR code from a PNG byte array with image decode options, diagnostics, and profile options.

Parameters

png System.Byte[] requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
decoded CodeGlyphX.QrDecoded@ requiredposition: 2
info CodeGlyphX.QrPixelDecodeInfo@ requiredposition: 3
options CodeGlyphX.QrPixelDecodeOptions = null optionalposition: 4
public static Boolean TryDecodePng(Byte[] png, ImageDecodeOptions imageOptions, out QrDecoded decoded, out QrPixelDecodeInfo info, QrPixelDecodeOptions options, CancellationToken cancellationToken) #
../../../../_/CodeGlyphX/QR.Decode.cs:63
Returns: Boolean

Attempts to decode a QR code from a PNG byte array with image decode options, diagnostics, profile options, and cancellation.

Parameters

png System.Byte[] requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
decoded CodeGlyphX.QrDecoded@ requiredposition: 2
info CodeGlyphX.QrPixelDecodeInfo@ requiredposition: 3
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 4
cancellationToken System.Threading.CancellationToken requiredposition: 5
public static Boolean TryDecodePng(Stream stream, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Decode.cs:201
Returns: Boolean

Attempts to decode a QR code from a PNG stream.

Parameters

stream System.IO.Stream requiredposition: 0
decoded CodeGlyphX.QrDecoded@ requiredposition: 1
public static Boolean TryDecodePng(Stream stream, QrPixelDecodeOptions options, CancellationToken cancellationToken, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Decode.cs:211
Returns: Boolean

Attempts to decode a QR code from a PNG stream with options and cancellation.

Parameters

stream System.IO.Stream requiredposition: 0
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2
decoded CodeGlyphX.QrDecoded@ requiredposition: 3
public static Boolean TryDecodePng(Stream stream, ImageDecodeOptions imageOptions, out QrDecoded decoded, out QrPixelDecodeInfo info, QrPixelDecodeOptions options = null) #
../../../../_/CodeGlyphX/QR.Decode.cs:222
Returns: Boolean

Attempts to decode a QR code from a PNG stream with image decode options, diagnostics, and profile options.

Parameters

stream System.IO.Stream requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
decoded CodeGlyphX.QrDecoded@ requiredposition: 2
info CodeGlyphX.QrPixelDecodeInfo@ requiredposition: 3
options CodeGlyphX.QrPixelDecodeOptions = null optionalposition: 4
public static Boolean TryDecodePng(Stream stream, ImageDecodeOptions imageOptions, out QrDecoded decoded, out QrPixelDecodeInfo info, QrPixelDecodeOptions options, CancellationToken cancellationToken) #
../../../../_/CodeGlyphX/QR.Decode.cs:229
Returns: Boolean

Attempts to decode a QR code from a PNG stream with image decode options, diagnostics, profile options, and cancellation.

Parameters

stream System.IO.Stream requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
decoded CodeGlyphX.QrDecoded@ requiredposition: 2
info CodeGlyphX.QrPixelDecodeInfo@ requiredposition: 3
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 4
cancellationToken System.Threading.CancellationToken requiredposition: 5
public static Boolean TryDecodePng(Stream stream, ImageDecodeOptions imageOptions, QrPixelDecodeOptions options, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Decode.cs:241
Returns: Boolean

Attempts to decode a QR code from a PNG stream with image decode options.

Parameters

stream System.IO.Stream requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 2
decoded CodeGlyphX.QrDecoded@ requiredposition: 3
public static Boolean TryDecodePng(Stream stream, ImageDecodeOptions imageOptions, QrPixelDecodeOptions options, CancellationToken cancellationToken, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Decode.cs:248
Returns: Boolean

Attempts to decode a QR code from a PNG stream with image decode options and cancellation.

Parameters

stream System.IO.Stream requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 2
cancellationToken System.Threading.CancellationToken requiredposition: 3
decoded CodeGlyphX.QrDecoded@ requiredposition: 4
TryDecodePngFile 6 overloads
public static Boolean TryDecodePngFile(String path, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Decode.cs:109
Returns: Boolean

Attempts to decode a QR code from a PNG file.

Parameters

path System.String requiredposition: 0
decoded CodeGlyphX.QrDecoded@ requiredposition: 1
public static Boolean TryDecodePngFile(String path, QrPixelDecodeOptions options, CancellationToken cancellationToken, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Decode.cs:119
Returns: Boolean

Attempts to decode a QR code from a PNG file with options and cancellation.

Parameters

path System.String requiredposition: 0
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2
decoded CodeGlyphX.QrDecoded@ requiredposition: 3
public static Boolean TryDecodePngFile(String path, ImageDecodeOptions imageOptions, out QrDecoded decoded, out QrPixelDecodeInfo info, QrPixelDecodeOptions options = null) #
../../../../_/CodeGlyphX/QR.Decode.cs:129
Returns: Boolean

Attempts to decode a QR code from a PNG file with image decode options, diagnostics, and profile options.

Parameters

path System.String requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
decoded CodeGlyphX.QrDecoded@ requiredposition: 2
info CodeGlyphX.QrPixelDecodeInfo@ requiredposition: 3
options CodeGlyphX.QrPixelDecodeOptions = null optionalposition: 4
public static Boolean TryDecodePngFile(String path, ImageDecodeOptions imageOptions, out QrDecoded decoded, out QrPixelDecodeInfo info, QrPixelDecodeOptions options, CancellationToken cancellationToken) #
../../../../_/CodeGlyphX/QR.Decode.cs:136
Returns: Boolean

Attempts to decode a QR code from a PNG file with image decode options, diagnostics, profile options, and cancellation.

Parameters

path System.String requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
decoded CodeGlyphX.QrDecoded@ requiredposition: 2
info CodeGlyphX.QrPixelDecodeInfo@ requiredposition: 3
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 4
cancellationToken System.Threading.CancellationToken requiredposition: 5
public static Boolean TryDecodePngFile(String path, ImageDecodeOptions imageOptions, QrPixelDecodeOptions options, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Decode.cs:147
Returns: Boolean

Attempts to decode a QR code from a PNG file with image decode options.

Parameters

path System.String requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 2
decoded CodeGlyphX.QrDecoded@ requiredposition: 3
public static Boolean TryDecodePngFile(String path, ImageDecodeOptions imageOptions, QrPixelDecodeOptions options, CancellationToken cancellationToken, out QrDecoded decoded) #
../../../../_/CodeGlyphX/QR.Decode.cs:154
Returns: Boolean

Attempts to decode a QR code from a PNG file with image decode options and cancellation.

Parameters

path System.String requiredposition: 0
imageOptions CodeGlyphX.ImageDecodeOptions requiredposition: 1
options CodeGlyphX.QrPixelDecodeOptions requiredposition: 2
cancellationToken System.Threading.CancellationToken requiredposition: 3
decoded CodeGlyphX.QrDecoded@ requiredposition: 4
TryParsePayload 2 overloads
public static Boolean TryParsePayload(String payload, out QrParsedPayload parsed) #
../../../../_/CodeGlyphX/QR.Payload.cs:17
Returns: Boolean

Attempts to parse a raw QR payload into a structured representation.

Parameters

payload System.String requiredposition: 0
parsed CodeGlyphX.Payloads.QrParsedPayload@ requiredposition: 1
public static Boolean TryParsePayload(String payload, QrPayloadParseOptions options, out QrParsedPayload parsed, out QrPayloadValidationResult validation) #
../../../../_/CodeGlyphX/QR.Payload.cs:24
Returns: Boolean

Attempts to parse a raw QR payload into a structured representation with optional validation.

Parameters

payload System.String requiredposition: 0
options CodeGlyphX.Payloads.QrPayloadParseOptions requiredposition: 1
parsed CodeGlyphX.Payloads.QrParsedPayload@ requiredposition: 2
validation CodeGlyphX.Payloads.QrPayloadValidationResult@ requiredposition: 3