API Reference
QrEasy
QR encoding, styling, and static art-heuristic helpers with practical defaults.
Inheritance
- Object
- QrEasy
Examples
using CodeGlyphX;
var qr = QrEasy.Encode("https://example.com");
var report = QrEasy.EvaluateScanHeuristics("https://example.com");
Methods
public static QrCode Encode(String payload, QrEasyOptions options = null) #QrCodeEncodes a payload into a QrCode with defaults.
Parameters
- payload System.String
- options CodeGlyphX.QrEasyOptions = null
public static QrCode Encode(QrPayloadData payload, QrEasyOptions options = null) #QrCodeEncodes a payload with embedded defaults.
Parameters
- payload CodeGlyphX.Payloads.QrPayloadData
- options CodeGlyphX.QrEasyOptions = null
public static QrCode EncodeAuto(String payload, QrPayloadDetectOptions detectOptions = null, QrEasyOptions options = null) #QrCodeDetects a payload type and encodes it into a QrCode.
Parameters
- payload System.String
- detectOptions CodeGlyphX.Payloads.QrPayloadDetectOptions = null
- options CodeGlyphX.QrEasyOptions = null
public static QrArtHeuristicReport EvaluateScanHeuristics(String payload, QrEasyOptions options = null) #QrArtHeuristicReportEvaluates static QR art heuristics for a payload and options. This does not decode the rendered artifact or guarantee scanner interoperability.
Parameters
- payload System.String
- options CodeGlyphX.QrEasyOptions = null
public static QrArtHeuristicReport EvaluateScanHeuristics(QrPayloadData payload, QrEasyOptions options = null) #QrArtHeuristicReportEvaluates static QR art heuristics for a payload with embedded defaults. This does not decode the rendered artifact or guarantee scanner interoperability.
Parameters
- payload CodeGlyphX.Payloads.QrPayloadData
- options CodeGlyphX.QrEasyOptions = null
public static String RenderAsciiConsole(String payload, AsciiConsoleOptions consoleOptions = null, QrEasyOptions options = null) #StringRenders a QR code as console-friendly ASCII with auto-fit.
Parameters
- payload System.String
- consoleOptions CodeGlyphX.Rendering.Ascii.AsciiConsoleOptions = null
- options CodeGlyphX.QrEasyOptions = null
public static String RenderAsciiConsole(QrPayloadData payload, AsciiConsoleOptions consoleOptions = null, QrEasyOptions options = null) #StringRenders a QR code as console-friendly ASCII with auto-fit for a payload with embedded defaults.
Parameters
- payload CodeGlyphX.Payloads.QrPayloadData
- consoleOptions CodeGlyphX.Rendering.Ascii.AsciiConsoleOptions = null
- options CodeGlyphX.QrEasyOptions = null
public static String RenderAsciiConsoleAuto(String payload, QrPayloadDetectOptions detectOptions = null, AsciiConsoleOptions consoleOptions = null, QrEasyOptions options = null) #StringDetects a payload type and renders a QR code as console-friendly ASCII with auto-fit.
Parameters
- payload System.String
- detectOptions CodeGlyphX.Payloads.QrPayloadDetectOptions = null
- consoleOptions CodeGlyphX.Rendering.Ascii.AsciiConsoleOptions = null
- options CodeGlyphX.QrEasyOptions = null
public static Byte[] RenderPixels(String payload, out Int32 widthPx, out Int32 heightPx, out Int32 stride, QrEasyOptions options = null) #Byte[]Renders a QR code to a raw RGBA pixel buffer (no PNG encoding).
Parameters
- payload System.String
- widthPx System.Int32@
- heightPx System.Int32@
- stride System.Int32@
- options CodeGlyphX.QrEasyOptions = null
public static Byte[] RenderPixels(QrPayloadData payload, out Int32 widthPx, out Int32 heightPx, out Int32 stride, QrEasyOptions options = null) #Byte[]Renders a QR code to a raw RGBA pixel buffer (no PNG encoding) for a payload with embedded defaults.
Parameters
- payload CodeGlyphX.Payloads.QrPayloadData
- widthPx System.Int32@
- heightPx System.Int32@
- stride System.Int32@
- options CodeGlyphX.QrEasyOptions = null