FeatherQR API

Uncompressed = 0,

No compression

Deflate = 1,

DEFLATE compression (RFC 1951)

GZip = 2,

GZIP compression (RFC 1952)

L = 0,

7% may be lost before recovery is not possible

M = 1,

15% may be lost before recovery is not possible

Q = 2,

25% may be lost before recovery is not possible

H = 3,

30% may be lost before recovery is not possible

Default = 0,

Auto-detect encoding and add appropriate ECI header (recommended for most use cases).

Iso8859_1 = 3,

ISO-8859-1 (Latin-1) encoding - Western European characters. Adds an ECI header: 12 bits in Standard QR, 11 bits in rMQR.

Utf8 = 26,

UTF-8 Unicode encoding - Universal character support. Adds an ECI header: 12 bits in Standard QR, 11 bits in rMQR.

property Version

public MicroQRVersion Version { get; }

The Micro QR version that will be produced.

property BufferSize

public int BufferSize { get; }

Required destination buffer size in bytes (one byte per module, quiet zone included).

property QrSize

public int QrSize { get; }

Matrix side length in modules, quiet zone included.

constructor MicroQRCodeData

public MicroQRCodeData(MicroQRVersion version, int quietZoneSize);

Initializes an empty matrix for the specified version.

constructor MicroQRCodeData

public MicroQRCodeData(ReadOnlySpan<byte> rawData, int quietZoneSize);

constructor MicroQRCodeData

public MicroQRCodeData(byte[] rawData, int quietZoneSize);

Deserializes Micro QR data previously produced by GetRawData .

property Version

public MicroQRVersion Version { get; }

Gets the Micro QR version (M1-M4).

indexer this[int row, int col]

public bool this[int row, int col] { get; }

Gets the module state at the specified position (quiet zone included). Quiet zone positions always read false.

property Size

public int Size { get; }

Gets the matrix side length in modules, including the quiet zone.

method GetModuleRectangles

public ModuleRect[] GetModuleRectangles();

Gets the dark modules as merged rectangles in module coordinates, for rendering with any graphics API without SkiaSharp (SVG path data, draw calls, vector output).

method TryGetModuleRectangles

public bool TryGetModuleRectangles(Span<ModuleRect> destination, out int written);

Writes the dark modules as merged rectangles into a caller-provided buffer. Same contract as GetModuleRectangles without allocations.

method GetRawData

public byte[] GetRawData();

Serializes the core modules (quiet zone excluded) to a new byte array.

method GetModuleRectanglesMaxCount

public int GetModuleRectanglesMaxCount();

Gets an upper bound on the number of rectangles GetModuleRectangles can return, suitable for sizing a pooled buffer for TryGetModuleRectangles . O(1), no matrix scan.

method GetRawData

public int GetRawData(IBufferWriter<byte> writer);

Writes the serialized data to the specified buffer writer without intermediate allocation.

method GetRawDataSize

public int GetRawDataSize();

Gets the serialized size in bytes ("QRX" header + packed core bits).

property EccLevel

public MicroQREccLevel EccLevel { get; }

Error correction level read from the format information.

property Version

public MicroQRVersion Version { get; }

Micro QR version (M1-M4), or default (0) when the matrix was invalid.

property Status

public QRCodeDecodeStatus Status { get; }

Decode result status. Success when decoding succeeded.

property ErrorsCorrected

public int ErrorsCorrected { get; }

Number of codeword errors corrected by Reed-Solomon decoding.

property MaskPattern

public int MaskPattern { get; }

Mask pattern (0-3) read from the format information, or -1 when unknown.

method TryDecode

public static bool TryDecode(MicroQRCodeData data, out string text);

Decodes the text content from Micro QR code data.

method TryDecode

public static bool TryDecode(MicroQRCodeData data, out string text, out MicroQRCodeDecodeInfo info);

Decodes the text content from Micro QR code data, with diagnostic information.

method TryDecode

public static bool TryDecode(ReadOnlySpan<byte> modules, int size, Span<char> destination, out int charsWritten, out MicroQRCodeDecodeInfo info);

Decodes the text content from a module matrix into a caller-provided buffer without per-call heap allocation.

method TryDecode

public static bool TryDecode(ReadOnlySpan<byte> modules, int size, out string text, out MicroQRCodeDecodeInfo info);

Decodes the text content from a module matrix.

method TryDecodeImage

public static bool TryDecodeImage(ReadOnlySpan<byte> luminance, int width, int height, Span<char> destination, out int charsWritten, out MicroQRCodeDecodeInfo info);

Detects and decodes a Micro QR code from grayscale image pixels into a caller-provided buffer without per-call heap allocation.

method TryDecodeImage

public static bool TryDecodeImage(ReadOnlySpan<byte> luminance, int width, int height, out string text, out MicroQRCodeDecodeInfo info);

Detects and decodes a Micro QR code from grayscale image pixels.

method GetMaxDecodedLength

public static int GetMaxDecodedLength(MicroQRVersion version);

Calculates the maximum possible decoded character count for a Micro QR version, across all ECC levels and encoding modes. Use to size the destination buffer for the allocation-free TryDecode overload.

method GetRequiredBufferSize obsolete

public static MicroQRCodeCalculatedSize GetRequiredBufferSize(ReadOnlySpan<char> text, MicroQREccLevel eccLevel, MicroQRVersion? requestedVersion = null, int quietZoneSize = 2);

Calculates the required buffer size for encoding the specified text as a Micro QR code.

method CreateMicroQRCode

public static MicroQRCodeData CreateMicroQRCode(ReadOnlySpan<char> textSpan, MicroQREccLevel eccLevel, MicroQRVersion? requestedVersion = null, int quietZoneSize = 2);

method CreateMicroQRCode

public static MicroQRCodeData CreateMicroQRCode(ReadOnlySpan<char> textSpan, MicroQREccLevel eccLevel, in MicroQRCodeGeneratorOptions options);

method CreateMicroQRCode

public static MicroQRCodeData CreateMicroQRCode(string plainText, MicroQREccLevel eccLevel, MicroQRVersion? requestedVersion = null, int quietZoneSize = 2);

Creates a Micro QR code from the provided plain text.

method CreateMicroQRCode

public static MicroQRCodeData CreateMicroQRCode(string plainText, MicroQREccLevel eccLevel, in MicroQRCodeGeneratorOptions options);

method TryGetRequiredBufferSize

public static bool TryGetRequiredBufferSize(ReadOnlySpan<char> text, MicroQREccLevel eccLevel, out MicroQRCodeCalculatedSize size, in MicroQRCodeGeneratorOptions options = null);

Calculates the required buffer size, matrix size and version for encoding the specified text as a Micro QR code, reporting content that does not fit as false rather than as an exception.

method CreateMicroQRCode

public static int CreateMicroQRCode(ReadOnlySpan<char> textSpan, MicroQREccLevel eccLevel, Span<byte> destination, MicroQRVersion? requestedVersion = null, int quietZoneSize = 2);

Creates a Micro QR code and writes the module matrix into the caller-provided buffer without per-call heap allocation.

method CreateMicroQRCode

public static int CreateMicroQRCode(ReadOnlySpan<char> textSpan, MicroQREccLevel eccLevel, Span<byte> destination, in MicroQRCodeGeneratorOptions options);

property Segmentation

public MicroQRSegmentation Segmentation { get; init; }

How the content is split into encoding-mode segments (see MicroQRSegmentation ). Defaults to Single . Optimal never selects a larger version, and emits the identical bit stream when a split would not shrink the symbol. Size a destination buffer with the same value you encode with.

property Version

public MicroQRVersionRange Version { get; init; }

The versions the generator may choose from. Defaults to Any ; a MicroQRVersion or its nullable converts implicitly, so a null means automatic.

property QuietZoneSize

public int QuietZoneSize { get; init; }

Quiet zone width in modules. Defaults to 2, the ISO/IEC 18004 value for Micro QR; 0 is valid.

property MaskPattern

public int? MaskPattern { get; init; }

Pin one of the four Micro QR data mask patterns (0-3, ISO/IEC 18004 Table 10) instead of the automatic edge-score selection. null (the default) selects the highest-scoring pattern. Any pattern yields a valid, decodable symbol; the automatic choice merely optimizes scan reliability.

property Default

public static MicroQRCodeGeneratorOptions Default { get; }

The default configuration, identical to default.

ErrorDetectionOnly = 0,

Error detection only, no correction capacity. Valid only for version M1.

L = 1,

~7% recovery capacity. Valid for versions M2-M4.

M = 2,

~15% recovery capacity. Valid for versions M2-M4.

Q = 3,

~25% recovery capacity. Valid for version M4 only.

Single = 0,

One segment in the single mode that can represent the whole content (Numeric, else Alphanumeric, else Byte). The default, and the cheapest to encode.

Optimal = 1,

The mixed-mode split with the fewest total bits. Never selects a larger version than Single , emits the Single bit stream verbatim when a split would not shrink the symbol, and additionally encodes content that overflows every version in a single mode — unless the minimal-bit plan would be misread on decode (a relocated byte order mark, or a Latin-1 run the charset heuristic would read as UTF-8), in which case it reports "does not fit" rather than emitting a stream that decodes differently.

M1 = 1,

11×11 modules. Numeric mode only, error detection only.

M2 = 2,

13×13 modules. Numeric and Alphanumeric modes, ECC L/M.

M3 = 3,

15×15 modules. Numeric, Alphanumeric and Byte modes, ECC L/M.

M4 = 4,

17×17 modules. Numeric, Alphanumeric and Byte modes, ECC L/M/Q.

constant MaxVersion

public const MicroQRVersion MaxVersion;

The highest Micro QR version, M4.

constant MinVersion

public const MicroQRVersion MinVersion;

The lowest Micro QR version, M1.

constructor MicroQRVersionRange

public MicroQRVersionRange(MicroQRVersion min, MicroQRVersion max);

An inclusive range from min to max .

property Max

public MicroQRVersion Max { get; }

The highest permitted version (M4 when unbounded above).

property Min

public MicroQRVersion Min { get; }

The lowest permitted version (M1 when unbounded below).

property IsAny

public bool IsAny { get; }

Whether this range constrains nothing (the default).

property IsExact

public bool IsExact { get; }

Whether this range pins a single version.

property Any

public static MicroQRVersionRange Any { get; }

Every version, M1 to M4. Identical to default.

method Contains

public bool Contains(MicroQRVersion version);

Whether version falls inside this range.

method ToString

public override string ToString();

method AtLeast

public static MicroQRVersionRange AtLeast(MicroQRVersion version);

version or larger.

method AtMost

public static MicroQRVersionRange AtMost(MicroQRVersion version);

version or smaller.

method Between

public static MicroQRVersionRange Between(MicroQRVersion min, MicroQRVersion max);

An inclusive range from min to max .

method Exactly

public static MicroQRVersionRange Exactly(MicroQRVersion version);

Exactly version , with no automatic selection.

operator op_Implicit

public static MicroQRVersionRange op_Implicit(MicroQRVersion version);

A single version, as Exactly .

operator op_Implicit

public static MicroQRVersionRange op_Implicit(MicroQRVersion? version);

A single version, or Any when there is none, so an optional version needs no branch.

constructor ModuleRect

public ModuleRect(int X, int Y, int Width, int Height);

An axis-aligned rectangle of dark modules, in module coordinates. Produced by the GetModuleRectangles family on QRCodeData , MicroQRCodeData , and RmQRCodeData .

property Height

public int Height { get; init; }

Height in modules (always positive).

property Width

public int Width { get; init; }

Width in modules (always positive).

property X

public int X { get; init; }

Column of the left edge (0-based, including the quiet zone if present).

property Y

public int Y { get; init; }

Row of the top edge (0-based, including the quiet zone if present).

constructor QRCodeCalculatedSize

public QRCodeCalculatedSize(int BufferSize, int QrSize, int Version);

Calculated QR code size information.

property IsValid

public bool IsValid { get; }

Validates that the calculated size values are within acceptable ranges.

property BufferSize

public int BufferSize { get; init; }

Required buffer size for the QR code matrix data (in bytes). Calculated as QrSize × QrSize.

property QrSize

public int QrSize { get; init; }

QR code size in modules per side (including quiet zone if specified)

property Version

public int Version { get; init; }

QR code version (1-40) determined by data capacity requirements

constructor QRCodeData

public QRCodeData(ReadOnlySpan<byte> rawDataSpan, int quietZoneSize);

Initializes a new instance of the QRCodeData class from serialized raw data.

constructor QRCodeData

public QRCodeData(byte[] rawData, int quietZoneSize);

Initializes a new instance of the QRCodeData class from serialized raw data.

constructor QRCodeData

public QRCodeData(int version, int quietZoneSize);

Initializes with the specified version.

indexer this[int row, int col]

public bool this[int row, int col] { get; }

Gets or sets the module state at the specified position.

property Size

public int Size { get; }

Gets the size of the QR code matrix (modules per side).

property Version

public int Version { get; }

Get the QR code version (1-40)

method GetModuleRectangles

public ModuleRect[] GetModuleRectangles();

Gets the dark modules as merged rectangles in module coordinates, for rendering with any graphics API without SkiaSharp (SVG path data, draw calls, vector output).

method IsFinderPattern

public bool IsFinderPattern(int row, int col);

Checks if the specified module position (excluding quiet zone) is part of a finder pattern.

method TryGetModuleRectangles

public bool TryGetModuleRectangles(Span<ModuleRect> destination, out int written);

Writes the dark modules as merged rectangles into a caller-provided buffer. Same contract as GetModuleRectangles without allocations.

method GetRawData

public byte[] GetRawData();

Serializes the QR code data to a byte array.

method GetFinderPatternIndex

public int GetFinderPatternIndex(int row, int col);

Gets the finder pattern index for the specified module position (excluding quiet zone).

method GetModuleRectanglesMaxCount

public int GetModuleRectanglesMaxCount();

Gets an upper bound on the number of rectangles GetModuleRectangles can return, suitable for sizing a pooled buffer for TryGetModuleRectangles . O(1), no matrix scan.

method GetRawData

public int GetRawData(IBufferWriter<byte> writer);

Writes the serialized QR code data to the specified buffer writer.

method GetRawDataSize

public int GetRawDataSize();

Calculates the required buffer size for serialization.

property EccLevel

public ECCLevel EccLevel { get; }

Error correction level read from the format information.

property Status

public QRCodeDecodeStatus Status { get; }

Decode result status. Success when decoding succeeded.

property ErrorsCorrected

public int ErrorsCorrected { get; }

Total number of codeword errors corrected by Reed-Solomon decoding.

property MaskPattern

public int MaskPattern { get; }

Mask pattern (0-7) read from the format information, or -1 when unknown.

property Version

public int Version { get; }

QR code version (1-40), or 0 when the matrix was invalid.

Success = 0,

Decoding succeeded.

InvalidMatrix = 1,

The input is not a valid QR module matrix (invalid size or no dark modules).

FormatInformationInvalid = 2,

Both format information copies are corrupted beyond BCH correction capacity.

DataUncorrectable = 3,

One or more Reed-Solomon blocks contain more errors than the ECC level can correct.

InvalidBitstream = 4,

The data bitstream is malformed (invalid segment values or truncated data).

UnsupportedContent = 5,

The bitstream is well-formed but uses a feature this decoder does not support (FNC1, Structured Append, or an unsupported ECI charset). A property of the symbol's structure, not of its text; see UnmappedCharacter for the per-character case.

DestinationTooSmall = 6,

The destination buffer is too small for the decoded text.

NotDetected = 7,

No QR code was detected in the image (finder patterns not found or inconsistent).

UnmappedCharacter = 8,

The symbol was read correctly, but one character has no mapping under the charset this decoder applies, so no text is produced.

method TryDecode

public static bool TryDecode(QRCodeData data, out string text);

Decodes the text content from QR code data.

method TryDecode

public static bool TryDecode(QRCodeData data, out string text, out QRCodeDecodeInfo info);

Decodes the text content from QR code data, with diagnostic information.

method TryDecode

public static bool TryDecode(ReadOnlySpan<byte> modules, int size, Span<char> destination, out int charsWritten, out QRCodeDecodeInfo info);

Decodes the text content from a module matrix into a caller-provided buffer without per-call heap allocation.

method TryDecode

public static bool TryDecode(ReadOnlySpan<byte> modules, int size, out string text, out QRCodeDecodeInfo info);

Decodes the text content from a module matrix.

method TryDecodeImage

public static bool TryDecodeImage(ReadOnlySpan<byte> luminance, int width, int height, Span<char> destination, out int charsWritten, out QRCodeDecodeInfo info);

Detects and decodes a QR code from grayscale image pixels into a caller-provided buffer without per-call heap allocation.

method TryDecodeImage

public static bool TryDecodeImage(ReadOnlySpan<byte> luminance, int width, int height, out string text, out QRCodeDecodeInfo info);

Detects and decodes a QR code from grayscale image pixels.

method GetMaxDecodedLength

public static int GetMaxDecodedLength(int version);

Calculates the maximum possible decoded character count for a QR code version, across all ECC levels and encoding modes. Use to size the destination buffer for the allocation-free TryDecode overload.

method GetRequiredBufferSize obsolete

public static QRCodeCalculatedSize GetRequiredBufferSize(ReadOnlySpan<char> text, ECCLevel eccLevel, bool utf8BOM = false, EciMode eciMode = 0, int quietZoneSize = 4);

Calculates the required buffer size for encoding the specified text as a QR code.

method CreateQrCode

public static QRCodeData CreateQrCode(ReadOnlySpan<char> textSpan, ECCLevel eccLevel, bool utf8BOM = false, EciMode eciMode = 0, int requestedVersion = -1, int quietZoneSize = 4);

Creates a QR code from the provided plain text.

method CreateQrCode

public static QRCodeData CreateQrCode(ReadOnlySpan<char> textSpan, ECCLevel eccLevel, in QRCodeGeneratorOptions options);

method CreateQrCode

public static QRCodeData CreateQrCode(string plainText, ECCLevel eccLevel, bool utf8BOM = false, EciMode eciMode = 0, int requestedVersion = -1, int quietZoneSize = 4);

Creates a QR code from the provided plain text.

method CreateQrCode

public static QRCodeData CreateQrCode(string plainText, ECCLevel eccLevel, in QRCodeGeneratorOptions options);

method TryGetRequiredBufferSize

public static bool TryGetRequiredBufferSize(ReadOnlySpan<char> text, ECCLevel eccLevel, out QRCodeCalculatedSize size, in QRCodeGeneratorOptions options = null);

Calculates the required buffer size, matrix size and version for encoding the specified text as a QR code, reporting content that does not fit as false rather than as an exception.

method CreateQrCode

public static int CreateQrCode(ReadOnlySpan<char> textSpan, ECCLevel eccLevel, Span<byte> destination, bool utf8BOM = false, EciMode eciMode = 0, int requestedVersion = -1, int quietZoneSize = 4);

Creates a QR code from the provided plain text and writes the module matrix into the caller-provided buffer without per-call heap allocation.

method CreateQrCode

public static int CreateQrCode(ReadOnlySpan<char> textSpan, ECCLevel eccLevel, Span<byte> destination, in QRCodeGeneratorOptions options);

method CreateQrCode

public static int CreateQrCode(string plainText, ECCLevel eccLevel, Span<byte> destination, bool utf8BOM = false, EciMode eciMode = 0, int requestedVersion = -1, int quietZoneSize = 4);

Creates a QR code from the provided plain text and writes the module matrix into the caller-provided buffer without per-call heap allocation.

method CreateQrCode

public static int CreateQrCode(string plainText, ECCLevel eccLevel, Span<byte> destination, in QRCodeGeneratorOptions options);

property EciMode

public EciMode EciMode { get; init; }

Character encoding declaration. The default auto-detects ASCII (no ECI), ISO-8859-1 (assignment 3) or UTF-8 (assignment 26) from the content.

property Segmentation

public QRCodeSegmentation Segmentation { get; init; }

How the content is split into encoding-mode segments (see QRCodeSegmentation ). Defaults to Single . Optimal never selects a larger version, emits the identical bit stream when a split would not shrink the symbol, and defers to the single-mode stream when Utf8BOM would actually write a byte order mark. Size a destination buffer with the same value you encode with.

property Version

public QRCodeVersionRange Version { get; init; }

The versions the generator may choose from. Defaults to Any ; an int or int? converts implicitly, so Version = 15 pins one and a null means automatic.

property BoostEccLevel

public bool BoostEccLevel { get; init; }

Raise the error correction level above the requested one when the chosen version's capacity allows it, without changing the version. The requested level becomes the minimum; the version is still chosen for it, so boosting never produces a larger symbol, only spends padding that would otherwise be wasted. Recommended when an icon or custom module shape overlays the symbol.

property Utf8BOM

public bool Utf8BOM { get; init; }

Include a UTF-8 byte order mark. Ignored unless the content is written as UTF-8 in Byte mode. When a BOM would be written, Optimal emits the single-mode stream instead of a split (the BOM is a stream-level prefix, and a split would relocate it into the middle of the decoded text).

property QuietZoneSize

public int QuietZoneSize { get; init; }

Quiet zone width in modules. Defaults to 4, the ISO/IEC 18004 value; 0 is valid.

property MaskPattern

public int? MaskPattern { get; init; }

Pin one of the eight ISO/IEC 18004 data mask patterns (0-7) instead of the automatic penalty-scored selection. null (the default) selects the lowest-penalty pattern. Any pattern yields a valid, decodable symbol; the automatic choice merely optimizes scan reliability.

property Default

public static QRCodeGeneratorOptions Default { get; }

The default configuration, identical to default.

Single = 0,

One segment in the single mode that can represent the whole content (Numeric, else Alphanumeric, else Byte). The default, and the cheapest to encode.

Optimal = 1,

The mixed-mode split with the fewest total bits. Never selects a larger version than Single , emits the Single bit stream verbatim when a split would not shrink the symbol, and additionally encodes content that overflows every version in a single mode — unless the minimal-bit plan would be misread on decode (a relocated byte order mark), in which case it reports "does not fit" rather than emitting a stream that decodes differently.

constant MaxVersion

public const int MaxVersion;

The highest version defined by ISO/IEC 18004.

constant MinVersion

public const int MinVersion;

The lowest version defined by ISO/IEC 18004.

constructor QRCodeVersionRange

public QRCodeVersionRange(int min, int max);

An inclusive range from min to max .

property IsAny

public bool IsAny { get; }

Whether this range constrains nothing (the default).

property IsExact

public bool IsExact { get; }

Whether this range pins a single version.

property Max

public int Max { get; }

The highest permitted version (40 when unbounded above).

property Min

public int Min { get; }

The lowest permitted version (1 when unbounded below).

property Any

public static QRCodeVersionRange Any { get; }

Every version, 1 to 40. Identical to default.

method Contains

public bool Contains(int version);

Whether version falls inside this range.

method ToString

public override string ToString();

method AtLeast

public static QRCodeVersionRange AtLeast(int version);

version or larger.

method AtMost

public static QRCodeVersionRange AtMost(int version);

version or smaller.

method Between

public static QRCodeVersionRange Between(int min, int max);

An inclusive range from min to max .

method Exactly

public static QRCodeVersionRange Exactly(int version);

Exactly version , with no automatic selection.

operator op_Implicit

public static QRCodeVersionRange op_Implicit(int version);

A single version, as Exactly . Lets an option set read Version = 15.

operator op_Implicit

public static QRCodeVersionRange op_Implicit(int? version);

A single version, or Any when there is none.

property Version

public RmQRVersion Version { get; }

The rMQR version that will be generated (requested or automatically selected).

property BufferSize

public int BufferSize { get; }

Required destination size in bytes ( Width × Height ).

property Height

public int Height { get; }

Matrix height in modules, quiet zone included.

property Width

public int Width { get; }

Matrix width in modules, quiet zone included.

constructor RmQRCodeData

public RmQRCodeData(ReadOnlySpan<byte> rawData, int quietZoneSize);

constructor RmQRCodeData

public RmQRCodeData(RmQRVersion version, int quietZoneSize);

Initializes an empty (all light) matrix for the specified version.

constructor RmQRCodeData

public RmQRCodeData(byte[] rawData, int quietZoneSize);

Deserializes rMQR data previously produced by GetRawData .

property Version

public RmQRVersion Version { get; }

Gets the rMQR version (R7x43-R17x139).

indexer this[int row, int col]

public bool this[int row, int col] { get; }

Gets the module state at the specified position (quiet zone included). Quiet zone positions always read false.

property Height

public int Height { get; }

Gets the matrix height in modules, including the quiet zone.

property Width

public int Width { get; }

Gets the matrix width in modules, including the quiet zone.

method GetModuleRectangles

public ModuleRect[] GetModuleRectangles();

Gets the dark modules as merged rectangles in module coordinates, for rendering with any graphics API without SkiaSharp (SVG path data, draw calls, vector output).

method TryGetModuleRectangles

public bool TryGetModuleRectangles(Span<ModuleRect> destination, out int written);

Writes the dark modules as merged rectangles into a caller-provided buffer. Same contract as GetModuleRectangles without allocations.

method GetRawData

public byte[] GetRawData();

Serializes the core modules (quiet zone excluded) to a new byte array.

method GetModuleRectanglesMaxCount

public int GetModuleRectanglesMaxCount();

Gets an upper bound on the number of rectangles GetModuleRectangles can return, suitable for sizing a pooled buffer for TryGetModuleRectangles . O(1), no matrix scan.

method GetRawData

public int GetRawData(IBufferWriter<byte> writer);

Writes the serialized data to the specified buffer writer without intermediate allocation.

method GetRawDataSize

public int GetRawDataSize();

Gets the serialized size in bytes ("QRX" header + packed core bits).

property Status

public QRCodeDecodeStatus Status { get; }

Decode outcome; Success when text was produced.

property EccLevel

public RmQREccLevel EccLevel { get; }

The ECC level read from the format information (valid once the format decoded).

property Version

public RmQRVersion Version { get; }

The symbol version (from the physical dimensions), or 0 when the input is not an rMQR matrix.

property ErrorsCorrected

public int ErrorsCorrected { get; }

Total Reed-Solomon codeword corrections across all blocks (0 for a clean symbol).

method TryDecode

public static bool TryDecode(ReadOnlySpan<byte> modules, int width, int height, Span<char> destination, out int charsWritten, out RmQRCodeDecodeInfo info);

Decodes the text content from a module matrix into a caller-provided buffer without per-call heap allocation.

method TryDecode

public static bool TryDecode(ReadOnlySpan<byte> modules, int width, int height, out string text, out RmQRCodeDecodeInfo info);

Decodes the text content from a module matrix.

method TryDecode

public static bool TryDecode(RmQRCodeData data, out string text);

Decodes the text content of an RmQRCodeData matrix.

method TryDecode

public static bool TryDecode(RmQRCodeData data, out string text, out RmQRCodeDecodeInfo info);

Decodes the text content of an RmQRCodeData matrix with diagnostics.

method TryDecodeImage

public static bool TryDecodeImage(ReadOnlySpan<byte> luminance, int width, int height, Span<char> destination, out int charsWritten, out RmQRCodeDecodeInfo info);

Detects and decodes an rMQR Code from grayscale image pixels into a caller-provided buffer without per-call heap allocation.

method TryDecodeImage

public static bool TryDecodeImage(ReadOnlySpan<byte> luminance, int width, int height, out string text, out RmQRCodeDecodeInfo info);

Detects and decodes an rMQR Code from grayscale image pixels.

method GetMaxDecodedLength

public static int GetMaxDecodedLength(RmQRVersion version);

Calculates the maximum possible decoded character count for an rMQR version, across ECC levels and encoding modes. Use to size the destination buffer for the allocation-free TryDecode overload.

method CreateRmQRCode

public static RmQRCodeData CreateRmQRCode(ReadOnlySpan<char> textSpan, RmQREccLevel eccLevel, in RmQRCodeGeneratorOptions options = null);

method CreateRmQRCode

public static RmQRCodeData CreateRmQRCode(string plainText, RmQREccLevel eccLevel, in RmQRCodeGeneratorOptions options = null);

Creates an rMQR code from the provided plain text.

method TryGetRequiredBufferSize

public static bool TryGetRequiredBufferSize(ReadOnlySpan<char> text, RmQREccLevel eccLevel, out RmQRCodeCalculatedSize size, in RmQRCodeGeneratorOptions options = null);

Calculates the required buffer size, dimensions and version for encoding the specified text as an rMQR code, reporting a content overflow as false rather than as an exception.

method CreateRmQRCode

public static int CreateRmQRCode(ReadOnlySpan<char> textSpan, RmQREccLevel eccLevel, Span<byte> destination, in RmQRCodeGeneratorOptions options = null);

Creates an rMQR code and writes the module matrix into the caller-provided buffer without per-call heap allocation.

property EciMode

public EciMode EciMode { get; init; }

Character encoding declaration. The default auto-detects ASCII (no ECI), ISO-8859-1 (assignment 3) or UTF-8 (assignment 26) from the content.

property FitStrategy

public RmQRFitStrategy FitStrategy { get; init; }

How to choose among the versions that hold the content. Defaults to MinimizeArea , the choice both reference encoders make.

property Height

public RmQRHeight? Height { get; init; }

Restrict automatic fitting to one symbol height, or null (the default) to consider every height. Must agree with Version when both are set.

property Segmentation

public RmQRSegmentation Segmentation { get; init; }

Whether to split the content into mixed-mode segments. Defaults to Single . Size a destination buffer with the same value you encode with: the two modes can select different versions.

property Version

public RmQRVersion? Version { get; init; }

A specific version, or null (the default) to fit one automatically by FitStrategy and Height .

property QuietZoneSize

public int QuietZoneSize { get; init; }

Quiet zone width in modules. Defaults to 2, the ISO/IEC 23941 value; 0 is valid.

property Default

public static RmQRCodeGeneratorOptions Default { get; }

The default configuration, identical to default.

M = 0,

Medium: about 15% of codewords recoverable.

H = 1,

High: about 30% of codewords recoverable.

MinimizeArea = 0,

Fewest modules (height × width); ties prefer the smaller height, i.e. the wider symbol. The default.

MinimizeWidth = 1,

Smallest width; ties prefer the smaller height.

MinimizeHeight = 2,

Smallest height; ties prefer the smaller width.

H7 = 7,

7 modules high (widths 43-139).

H9 = 9,

9 modules high (widths 43-139).

H11 = 11,

11 modules high (widths 27-139).

H13 = 13,

13 modules high (widths 27-139).

H15 = 15,

15 modules high (widths 43-139).

H17 = 17,

17 modules high (widths 43-139).

Single = 0,

One segment in the single mode that can represent the whole content (Numeric, else Alphanumeric, else Byte). The default, and the cheapest to encode.

Optimal = 1,

The mixed-mode split with the fewest total bits. Never selects a symbol with more core modules than Single , emits the Single bit stream verbatim when a split would not shrink it, and additionally encodes content that overflows every version in a single mode — unless the minimal-bit plan would be misread on decode (a relocated byte order mark), in which case it reports "does not fit" rather than emitting a stream that decodes differently.

R7x43 = 1,

7 × 43 modules.

R7x59 = 2,

7 × 59 modules.

R7x77 = 3,

7 × 77 modules.

R7x99 = 4,

7 × 99 modules.

R7x139 = 5,

7 × 139 modules.

R9x43 = 6,

9 × 43 modules.

R9x59 = 7,

9 × 59 modules.

R9x77 = 8,

9 × 77 modules.

R9x99 = 9,

9 × 99 modules.

R9x139 = 10,

9 × 139 modules.

R11x27 = 11,

11 × 27 modules.

R11x43 = 12,

11 × 43 modules.

R11x59 = 13,

11 × 59 modules.

R11x77 = 14,

11 × 77 modules.

R11x99 = 15,

11 × 99 modules.

R11x139 = 16,

11 × 139 modules.

R13x27 = 17,

13 × 27 modules.

R13x43 = 18,

13 × 43 modules.

R13x59 = 19,

13 × 59 modules.

R13x77 = 20,

13 × 77 modules.

R13x99 = 21,

13 × 99 modules.

R13x139 = 22,

13 × 139 modules.

R15x43 = 23,

15 × 43 modules.

R15x59 = 24,

15 × 59 modules.

R15x77 = 25,

15 × 77 modules.

R15x99 = 26,

15 × 99 modules.

R15x139 = 27,

15 × 139 modules.

R17x43 = 28,

17 × 43 modules.

R17x59 = 29,

17 × 59 modules.

R17x77 = 30,

17 × 77 modules.

R17x99 = 31,

17 × 99 modules.

R17x139 = 32,

17 × 139 modules.

field Default

public static readonly CircleFinderPatternShape Default;

Gets the default instance.

property RequiresAntialiasing

public bool RequiresAntialiasing { get; }

Requires antialiasing to prevent jagged edges on curves.

method Draw

public override void Draw(SKCanvas canvas, SKRect rect, SKPaint paint);

method Draw

public override void Draw(SKCanvas canvas, SKRect rect, SKPaint paint, SKColor backgroundColor);

method Draw

public override void Draw(SKCanvas canvas, SKRect rect, SKPaint paint, SKPaint backgroundPaint);

field Default

public static readonly CircleModuleShape Default;

Gets the default instance.

property RequiresAntialiasing

public bool RequiresAntialiasing { get; }

Requires antialiasing to prevent jagged edges on curves.

method Draw

public override void Draw(SKCanvas canvas, SKRect rect, SKPaint paint);

constructor FinderPatternShape

protected FinderPatternShape();

property RequiresAntialiasing

public bool RequiresAntialiasing { get; }

Gets whether this shape requires antialiasing for smooth rendering. Curved shapes such as circles and rounded rectangles should return true ; straight-edged shapes such as rectangles can return false .

method Draw

public abstract void Draw(SKCanvas canvas, SKRect rect, SKPaint paint);

Draw a finder pattern at the specified location.

method Draw

public virtual void Draw(SKCanvas canvas, SKRect rect, SKPaint paint, SKColor backgroundColor);

Draw a finder pattern at the specified location with background color support.

method Draw

public virtual void Draw(SKCanvas canvas, SKRect rect, SKPaint paint, SKPaint backgroundPaint);

Draw a finder pattern at the specified location using an existing background paint.

None = 0,

No gradient. Use solid color specified in QR code rendering options. However, if solid is required, it's better to omit gradient options entirely.

LeftToRight = 1,

Gradient flows from left edge to right edge horizontally.

RightToLeft = 2,

Gradient flows from right edge to left edge horizontally.

TopToBottom = 3,

Gradient flows from top edge to bottom edge vertically.

BottomToTop = 4,

Gradient flows from bottom edge to top edge vertically.

TopLeftToBottomRight = 5,

Gradient flows diagonally from top-left corner to bottom-right corner.

TopRightToBottomLeft = 6,

Gradient flows diagonally from top-right corner to bottom-left corner.

BottomLeftToTopRight = 7,

Gradient flows diagonally from bottom-left corner to top-right corner.

BottomRightToTopLeft = 8,

Gradient flows diagonally from bottom-right corner to top-left corner.

field Default

public static readonly GradientOptions Default;

A ready-made gradient: dark orange to firebrick, running from the top-left corner to the bottom-right. Use it when you want a gradient without choosing colors.

constructor GradientOptions

public GradientOptions(SKColor[] colors, GradientDirection direction = 1, float[]? colorPositions = null);

Initializes a new instance of the GradientOptions record.

property Direction

public GradientDirection Direction { get; init; }

The gradient direction.

property Colors

public SKColor[] Colors { get; init; }

Gradient colors for multi-color gradients.

property ColorPositions

public float[]? ColorPositions { get; init; }

Optional color stops (0.0 to 1.0) for the gradient.

constructor IconData obsolete

public IconData();

property Icon

public IconShape Icon { get; set; }

The icon shape to overlay on the QR code.

property IconBorderWidth

public int IconBorderWidth { get; set; }

The border width around the icon in pixels. Creates a background-colored padding around the icon. Ignored when IconSizeModules is set.

property IconSizePercent

public int IconSizePercent { get; set; }

The size of the icon as a percentage of the QR code size (1-100). Ignored when IconSizeModules is set.

property MaxCoreOccupancyPercent

public int MaxCoreOccupancyPercent { get; set; }

Maximum allowed icon occupancy of the QR core area, as a percentage (1-100). Used only for module-based sizing. Default is 30.

property IconBorderModules

public int? IconBorderModules { get; set; }

The border width around the icon in QR modules. When IconSizeModules is set and this is null, defaults to 1.

property IconSizeModules

public int? IconSizeModules { get; set; }

The size of the icon body in QR modules. When set, module-based sizing is used and IconSizePercent / IconBorderWidth are ignored.

method FromImage

public static IconData FromImage(SKBitmap image, int iconSizePercent = 10, int iconBorderWidth = 2);

Create IconData from a bitmap image using percent/pixel sizing.

method FromImageByModules

public static IconData FromImageByModules(SKBitmap image, int iconSizeModules, int iconBorderModules = 1, int maxCoreOccupancyPercent = 30);

Create IconData from a bitmap image using module-based sizing.

constructor IconShape

protected IconShape();

method Draw

public abstract void Draw(SKCanvas canvas, SKRect rect, SKRect borderRect, SKColor backgroundColor);

Draw an icon bitmap at the specified location.

constructor ImageIconShape

public ImageIconShape(SKBitmap image);

Creates an icon from an image.

method Draw

public override void Draw(SKCanvas canvas, SKRect rect, SKRect borderRect, SKColor backgroundColor);

constructor ImageTextIconShape

public ImageTextIconShape(SKBitmap image, string text, SKColor textColor, SKFont font, SKTextAlign horizontalAlign = 1, TextVerticalAlignment verticalAlign = 0, int textPadding = 0);

Creates an icon shape that displays an image with text positioned relative to it.

method Draw

public override void Draw(SKCanvas canvas, SKRect rect, SKRect borderRect, SKColor backgroundColor);

constructor MicroQRCodeImageBuilder

public MicroQRCodeImageBuilder(MicroQRCodeData microQrCodeData);

Starts a builder that draws a Micro QR code you have already generated. The symbol is used exactly as given, so only the appearance options apply. Every encoding option throws InvalidOperationException on a builder created this way.

constructor MicroQRCodeImageBuilder

public MicroQRCodeImageBuilder(string content);

Starts a builder that will encode content when you ask for an image. Error correction, version and every other option keep their defaults until you set them.

method WithErrorCorrection

public MicroQRCodeImageBuilder WithErrorCorrection(MicroQREccLevel eccLevel);

Configure the error correction level for the Micro QR code.

method WithMaskPattern

public MicroQRCodeImageBuilder WithMaskPattern(int? maskPattern);

Pin one of the four Micro QR data mask patterns (0-3) instead of the automatic edge-score selection; see MaskPattern .

method WithSegmentation

public MicroQRCodeImageBuilder WithSegmentation(MicroQRSegmentation segmentation);

Split the content into mixed-mode segments when that lowers the version (see MicroQRSegmentation ). Defaults to Single . Never selects a larger version, and produces the identical symbol when a split would not shrink it.

method WithVersion

public MicroQRCodeImageBuilder WithVersion(MicroQRVersion version);

Configure the Micro QR version to generate.

method WithVersion

public MicroQRCodeImageBuilder WithVersion(MicroQRVersionRange versionRange);

Configure the versions the generator may choose from, rather than a single one.

method GetImageBytes

public static byte[] GetImageBytes(MicroQRCodeData microQrCodeData, SKEncodedImageFormat format, int size = 512, int quality = 100);

Generate a Micro QR code as image byte array with specified format.

method GetImageBytes

public static byte[] GetImageBytes(string content, SKEncodedImageFormat format, MicroQREccLevel eccLevel = 2, int size = 512, int quality = 100);

Generate a Micro QR code as image byte array with specified format.

method GetPngBytes

public static byte[] GetPngBytes(MicroQRCodeData microQrCodeData, int size = 512);

Generate a Micro QR code as PNG byte array with default settings.

method GetPngBytes

public static byte[] GetPngBytes(string content, MicroQREccLevel eccLevel = 2, int size = 512);

Generate a Micro QR code as PNG byte array with default settings.

method GetSvgBytes

public static byte[] GetSvgBytes(MicroQRCodeData microQrCodeData, int size = 512);

Generate a Micro QR code as SVG (UTF-8 encoded) byte array with default settings.

method GetSvgBytes

public static byte[] GetSvgBytes(string content, MicroQREccLevel eccLevel = 2, int size = 512);

Generate a Micro QR code as SVG (UTF-8 encoded) byte array with default settings.

method GetSvgString

public static string GetSvgString(MicroQRCodeData microQrCodeData, int size = 512);

Generate a Micro QR code as SVG document string with default settings.

method GetSvgString

public static string GetSvgString(string content, MicroQREccLevel eccLevel = 2, int size = 512);

Generate a Micro QR code as SVG document string with default settings.

method SavePng

public static void SavePng(MicroQRCodeData microQrCodeData, Stream output, int size = 512);

Generate a Micro QR code and save to stream with default PNG settings.

method SavePng

public static void SavePng(string content, Stream output, MicroQREccLevel eccLevel = 2, int size = 512);

Generate a Micro QR code and save to stream with default PNG settings.

method SaveSvg

public static void SaveSvg(MicroQRCodeData microQrCodeData, Stream output, int size = 512);

Generate a Micro QR code and save as SVG to stream with default settings.

method SaveSvg

public static void SaveSvg(string content, Stream output, MicroQREccLevel eccLevel = 2, int size = 512);

Generate a Micro QR code and save as SVG to stream with default settings.

method WriteImage

public static void WriteImage(MicroQRCodeData microQrCodeData, IBufferWriter<byte> writer, SKEncodedImageFormat format, int size = 512, int quality = 100);

Generate a Micro QR code and write to an IBufferWriter with specified format.

method WriteImage

public static void WriteImage(string content, IBufferWriter<byte> writer, SKEncodedImageFormat format, MicroQREccLevel eccLevel = 2, int size = 512, int quality = 100);

Generate a Micro QR code and write to an IBufferWriter with specified format.

method WritePng

public static void WritePng(MicroQRCodeData microQrCodeData, IBufferWriter<byte> writer, int size = 512);

Generate a Micro QR code and write to an IBufferWriter with default PNG settings.

method WritePng

public static void WritePng(string content, IBufferWriter<byte> writer, MicroQREccLevel eccLevel = 2, int size = 512);

Generate a Micro QR code and write to an IBufferWriter with default PNG settings.

method WriteSvg

public static void WriteSvg(MicroQRCodeData microQrCodeData, IBufferWriter<byte> writer, int size = 512);

Generate a Micro QR code and write as SVG (UTF-8 encoded) to an IBufferWriter with default settings.

method WriteSvg

public static void WriteSvg(string content, IBufferWriter<byte> writer, MicroQREccLevel eccLevel = 2, int size = 512);

Generate a Micro QR code and write as SVG (UTF-8 encoded) to an IBufferWriter with default settings.

method TryDecode

public static bool TryDecode(SKBitmap bitmap, out string text);

method TryDecode

public static bool TryDecode(SKBitmap bitmap, out string text, out MicroQRCodeDecodeInfo info);

constructor ModuleShape

protected ModuleShape();

property RequiresAntialiasing

public bool RequiresAntialiasing { get; }

Gets whether this shape requires antialiasing for smooth rendering.

method Draw

public abstract void Draw(SKCanvas canvas, SKRect rect, SKPaint paint);

Draw a module at the specified location.

method Render

public static void Render(SKCanvas canvas, MicroQRCodeData data, SKRect area, SKColor? clearColor = null, SKColor? codeColor = null, SKColor? backgroundColor = null, ModuleShape? moduleShape = null, float moduleSizePercent = 1, GradientOptions? gradientOptions = null);

Renders a Micro QR code on the canvas with custom colors.

method Render

public static void Render(SKCanvas canvas, MicroQRCodeData data, int width, int height, SKColor? clearColor = null, SKColor? codeColor = null, SKColor? backgroundColor = null, ModuleShape? moduleShape = null, float moduleSizePercent = 1, GradientOptions? gradientOptions = null);

Renders a Micro QR code on the canvas with default colors.

method Render

public static void Render(SKCanvas canvas, QRCodeData data, SKRect area, SKColor? clearColor = null, SKColor? codeColor = null, SKColor? backgroundColor = null, IconData? iconData = null, ModuleShape? moduleShape = null, float moduleSizePercent = 1, GradientOptions? gradientOptions = null, FinderPatternShape? finderPatternShape = null);

Renders a QR code on the canvas with custom colors.

method Render

public static void Render(SKCanvas canvas, QRCodeData data, int width, int height, SKColor? clearColor = null, SKColor? codeColor = null, SKColor? backgroundColor = null, IconData? iconData = null, ModuleShape? moduleShape = null, float moduleSizePercent = 1, GradientOptions? gradientOptions = null, FinderPatternShape? finderPatternShape = null);

Renders a QR code on the canvas with default colors.

method Render

public static void Render(SKCanvas canvas, RmQRCodeData data, SKRect area, SKColor? clearColor = null, SKColor? codeColor = null, SKColor? backgroundColor = null, ModuleShape? moduleShape = null, float moduleSizePercent = 1, GradientOptions? gradientOptions = null);

Renders an rMQR code on the canvas with custom colors.

method Render

public static void Render(SKCanvas canvas, RmQRCodeData data, int width, int height, SKColor? clearColor = null, SKColor? codeColor = null, SKColor? backgroundColor = null, ModuleShape? moduleShape = null, float moduleSizePercent = 1, GradientOptions? gradientOptions = null);

Renders an rMQR code on the canvas with default colors.

constructor QRCodeImageBuilder

public QRCodeImageBuilder(QRCodeData qrCodeData);

Starts a builder that draws a QR code you have already generated. The symbol is used exactly as given, so only the appearance options apply. Most encoding options throw InvalidOperationException on a builder created this way; WithErrorCorrection and WithEciMode are accepted and then ignored, because they shipped that way in 1.1.1.

constructor QRCodeImageBuilder

public QRCodeImageBuilder(string content);

Starts a builder that will encode content when you ask for an image. Error correction, version and every other option keep their defaults until you set them.

method WithEciMode

public QRCodeImageBuilder WithEciMode(EciMode eciMode);

Configure the ECI (Extended Channel Interpretation) mode for character encoding.

method WithErrorCorrection

public QRCodeImageBuilder WithErrorCorrection(ECCLevel eccLevel);

Configure the error correction level for the QR code.

method WithErrorCorrectionBoost

public QRCodeImageBuilder WithErrorCorrectionBoost(bool boostEccLevel = true);

Raise the error correction level above the one configured with WithErrorCorrection when the chosen version's capacity allows it, without changing the version or the symbol size. Recommended together with WithIcon : the spare capacity absorbs the modules the icon covers.

method WithFinderPatternShape

public QRCodeImageBuilder WithFinderPatternShape(FinderPatternShape? finderPatternShape);

Configure the shape of the finder patterns.

method WithIcon

public QRCodeImageBuilder WithIcon(IconData? iconData);

Configure an icon to overlay on the center of the QR code.

method WithMaskPattern

public QRCodeImageBuilder WithMaskPattern(int? maskPattern);

Pin one of the eight data mask patterns (0-7) instead of the automatic penalty-scored selection; see MaskPattern .

method WithSegmentation

public QRCodeImageBuilder WithSegmentation(QRCodeSegmentation segmentation);

Split the content into mixed-mode segments when that lowers the version (see QRCodeSegmentation ). Defaults to Single . Never selects a larger version, and produces the identical symbol when a split would not shrink it.

method WithVersion

public QRCodeImageBuilder WithVersion(QRCodeVersionRange versionRange);

Configure the versions the generator may choose from, rather than a single one.

method WithVersion

public QRCodeImageBuilder WithVersion(int version);

Configure the QR code version to generate.

method GetImageBytes

public static byte[] GetImageBytes(QRCodeData qrCodeData, SKEncodedImageFormat format, int size = 512, int quality = 100);

Generate a QR code as image byte array with specified format.

method GetImageBytes

public static byte[] GetImageBytes(string content, SKEncodedImageFormat format, ECCLevel eccLevel = 1, int size = 512, int quality = 100);

Generate a QR code as image byte array with specified format.

method GetPngBytes

public static byte[] GetPngBytes(QRCodeData qrCodeData, int size = 512);

Generate a QR code as PNG byte array with default settings.

method GetPngBytes

public static byte[] GetPngBytes(string content, ECCLevel eccLevel = 1, int size = 512);

Generate a QR code as PNG byte array with default settings.

method GetSvgBytes

public static byte[] GetSvgBytes(QRCodeData qrCodeData, int size = 512);

Generate a QR code as SVG (UTF-8 encoded) byte array with default settings.

method GetSvgBytes

public static byte[] GetSvgBytes(string content, ECCLevel eccLevel = 1, int size = 512);

Generate a QR code as SVG (UTF-8 encoded) byte array with default settings.

method GetSvgString

public static string GetSvgString(QRCodeData qrCodeData, int size = 512);

Generate a QR code as SVG document string with default settings.

method GetSvgString

public static string GetSvgString(string content, ECCLevel eccLevel = 1, int size = 512);

Generate a QR code as SVG document string with default settings.

method SavePng

public static void SavePng(QRCodeData qrCodeData, Stream output, int size = 512);

Generate a QR code and save to stream with default PNG settings.

method SavePng

public static void SavePng(string content, Stream output, ECCLevel eccLevel = 1, int size = 512);

Generate a QR code and save to stream with default PNG settings.

method SaveSvg

public static void SaveSvg(QRCodeData qrCodeData, Stream output, int size = 512);

Generate a QR code and save as SVG to stream with default settings.

method SaveSvg

public static void SaveSvg(string content, Stream output, ECCLevel eccLevel = 1, int size = 512);

Generate a QR code and save as SVG to stream with default settings.

method WriteImage

public static void WriteImage(QRCodeData qrCodeData, IBufferWriter<byte> writer, SKEncodedImageFormat format, int size = 512, int quality = 100);

Generate a QR code and write to an IBufferWriter with specified format.

method WriteImage

public static void WriteImage(string content, IBufferWriter<byte> writer, SKEncodedImageFormat format, ECCLevel eccLevel = 1, int size = 512, int quality = 100);

Generate a QR code and write to an IBufferWriter with specified format.

method WritePng

public static void WritePng(QRCodeData qrCodeData, IBufferWriter<byte> writer, int size = 512);

Generate a QR code and write to an IBufferWriter with default PNG settings.

method WritePng

public static void WritePng(string content, IBufferWriter<byte> writer, ECCLevel eccLevel = 1, int size = 512);

Generate a QR code and write to an IBufferWriter with default PNG settings.

method WriteSvg

public static void WriteSvg(QRCodeData qrCodeData, IBufferWriter<byte> writer, int size = 512);

Generate a QR code and write as SVG (UTF-8 encoded) to an IBufferWriter with default settings.

method WriteSvg

public static void WriteSvg(string content, IBufferWriter<byte> writer, ECCLevel eccLevel = 1, int size = 512);

Generate a QR code and write as SVG (UTF-8 encoded) to an IBufferWriter with default settings.

method ToBitmap

public SKBitmap ToBitmap();

Generate the symbol image and return as SKBitmap.

method ToImage

public SKImage ToImage();

Generate the symbol image and return as SKImage.

method WithColors

public TSelf WithColors(SKColor? codeColor = null, SKColor? backgroundColor = null, SKColor? clearColor = null);

Configure the colors used in the image.

method WithFormat

public TSelf WithFormat(SKEncodedImageFormat format, int quality = 100);

Configure the output image format and quality.

method WithGradient

public TSelf WithGradient(GradientOptions? gradientOptions);

Configure gradient options for the modules.

method WithModulePixelSize

public TSelf WithModulePixelSize(int modulePixelSize);

Configure content size from pixels-per-module.

method WithModuleShape

public TSelf WithModuleShape(ModuleShape? moduleShape, float sizePercent = 1);

Configure the shape of the modules.

method WithQuietZone

public TSelf WithQuietZone(int size);

Configure the quiet zone size (light border) around the symbol.

method WithSize

public TSelf WithSize(int width, int height);

Configure the output image size in absolute pixels.

method ToByteArray

public byte[] ToByteArray();

Generate the symbol image and return as byte array.

method ToSvgString

public string ToSvgString();

Generate the symbol and return as SVG document string.

method SaveTo

public void SaveTo(IBufferWriter<byte> writer);

Generate the symbol image and write to an IBufferWriter. This is more efficient than SaveTo(Stream) as it avoids intermediate buffering.

method SaveTo

public void SaveTo(Stream output);

Generate the symbol image and save to stream.

method SaveToSvg

public void SaveToSvg(IBufferWriter<byte> writer);

Generate the symbol and write as SVG document to an IBufferWriter.

method SaveToSvg

public void SaveToSvg(Stream output);

Generate the symbol and save as SVG document to stream.

method TryDecode

public static bool TryDecode(SKBitmap bitmap, out string text);

method TryDecode

public static bool TryDecode(SKBitmap bitmap, out string text, out QRCodeDecodeInfo info);

method GetFinderPatternRect

public static SKRect GetFinderPatternRect(QRCodeData data, int patternIndex, SKRect renderArea);

Gets the rectangle area for a specified finder pattern in the rendered QR code area.

method GetIconRects

public static ValueTuple<SKRect, SKRect> GetIconRects(QRCodeData data, SKRect area, IconData iconData);

Calculates icon and border rectangles for the given QR code area.

method Render

public static void Render(SKCanvas canvas, SKRect area, MicroQRCodeData data, SKColor? codeColor, SKColor? backgroundColor, ModuleShape? moduleShape = null, float moduleSizePercent = 1, GradientOptions? gradientOptions = null);

Render the specified Micro QR data into the given area of the target canvas.

method Render

public static void Render(SKCanvas canvas, SKRect area, QRCodeData data, SKColor? codeColor, SKColor? backgroundColor, IconData? iconData = null, ModuleShape? moduleShape = null, float moduleSizePercent = 1, GradientOptions? gradientOptions = null, FinderPatternShape? finderPatternShape = null);

Render the specified data into the given area of the target canvas.

method Render

public static void Render(SKCanvas canvas, SKRect area, RmQRCodeData data, SKColor? codeColor, SKColor? backgroundColor, ModuleShape? moduleShape = null, float moduleSizePercent = 1, GradientOptions? gradientOptions = null);

Renders an rMQR code onto the canvas. The rectangular symbol (quiet zone included) is drawn with a uniform module scale and centered in area (letterbox); the whole area receives the background.

field Default

public static readonly RectangleFinderPatternShape Default;

Gets the default instance.

property RequiresAntialiasing

public bool RequiresAntialiasing { get; }

Antialiasing disabled; straight-edged rectangles render cleanly without it.

method Draw

public override void Draw(SKCanvas canvas, SKRect rect, SKPaint paint);

method Draw

public override void Draw(SKCanvas canvas, SKRect rect, SKPaint paint, SKColor backgroundColor);

method Draw

public override void Draw(SKCanvas canvas, SKRect rect, SKPaint paint, SKPaint backgroundPaint);

field Default

public static readonly RectangleModuleShape Default;

Gets the default instance.

property RequiresAntialiasing

public bool RequiresAntialiasing { get; }

Antialiasing disabled to prevent gray borders between modules.

method Draw

public override void Draw(SKCanvas canvas, SKRect rect, SKPaint paint);

constructor RmQRCodeImageBuilder

public RmQRCodeImageBuilder(RmQRCodeData rmQrCodeData);

Starts a builder that draws an rMQR code you have already generated. The symbol is used exactly as given, so only the appearance options apply. Every encoding option throws InvalidOperationException on a builder created this way.

constructor RmQRCodeImageBuilder

public RmQRCodeImageBuilder(string content);

Starts a builder that will encode content when you ask for an image. Error correction, version and fit keep their defaults until you set them.

method WithEciMode

public RmQRCodeImageBuilder WithEciMode(EciMode eciMode);

Configure the ECI character encoding declaration.

method WithErrorCorrection

public RmQRCodeImageBuilder WithErrorCorrection(RmQREccLevel eccLevel);

Configure the error correction level (M or H).

method WithFitStrategy

public RmQRCodeImageBuilder WithFitStrategy(RmQRFitStrategy fitStrategy);

Configure how the version is chosen among those that hold the content (default MinimizeArea , fewest modules; note it may prefer a taller, narrower symbol, use MinimizeHeight or WithHeight for the flattest fit).

method WithHeight

public RmQRCodeImageBuilder WithHeight(RmQRHeight height);

Restrict automatic version selection to one symbol height (fixed height, automatic width). Must agree with WithVersion when both are used.

method WithSegmentation

public RmQRCodeImageBuilder WithSegmentation(RmQRSegmentation segmentation);

Split the content into mixed-mode segments when that lowers the module count (see RmQRSegmentation ). Defaults to Single . Fewer modules is not the same as a smaller image: a flatter, wider symbol can render onto a larger grid.

method WithVersion

public RmQRCodeImageBuilder WithVersion(RmQRVersion version);

Configure the exact rMQR version to generate.

method WithWidth

public RmQRCodeImageBuilder WithWidth(int width);

Configure the image width in pixels; the height follows the symbol aspect ratio (rounded to whole pixels), the background covers the whole image and the symbol is drawn at a uniform module scale inside it. This is the static helpers' sizing rule and the default (512) when no size is configured. QRCodeImageBuilderBase (letterbox into an exact canvas) or QRCodeImageBuilderBase (exact matrix) take precedence when also called.

method GetImageBytes

public static byte[] GetImageBytes(RmQRCodeData rmQrCodeData, SKEncodedImageFormat format, int size = 512, int quality = 100);

Generate an rMQR code as image byte array with specified format.

method GetImageBytes

public static byte[] GetImageBytes(string content, SKEncodedImageFormat format, RmQREccLevel eccLevel = 0, int size = 512, int quality = 100);

Generate an rMQR code as image byte array with specified format.

method GetPngBytes

public static byte[] GetPngBytes(RmQRCodeData rmQrCodeData, int size = 512);

Generate an rMQR code as PNG byte array with default settings.

method GetPngBytes

public static byte[] GetPngBytes(string content, RmQREccLevel eccLevel = 0, int size = 512);

Generate an rMQR code as PNG byte array with default settings.

method GetSvgBytes

public static byte[] GetSvgBytes(RmQRCodeData rmQrCodeData, int size = 512);

Generate an rMQR code as SVG byte array.

method GetSvgBytes

public static byte[] GetSvgBytes(string content, RmQREccLevel eccLevel = 0, int size = 512);

Generate an rMQR code as SVG byte array.

method GetSvgString

public static string GetSvgString(RmQRCodeData rmQrCodeData, int size = 512);

Generate an rMQR code as SVG string.

method GetSvgString

public static string GetSvgString(string content, RmQREccLevel eccLevel = 0, int size = 512);

Generate an rMQR code as SVG string.

method SavePng

public static void SavePng(RmQRCodeData rmQrCodeData, Stream output, int size = 512);

Generate an rMQR code and save as PNG to stream.

method SavePng

public static void SavePng(string content, Stream output, RmQREccLevel eccLevel = 0, int size = 512);

Generate an rMQR code and save as PNG to stream.

method SaveSvg

public static void SaveSvg(RmQRCodeData rmQrCodeData, Stream output, int size = 512);

Generate an rMQR code and save as SVG to stream.

method SaveSvg

public static void SaveSvg(string content, Stream output, RmQREccLevel eccLevel = 0, int size = 512);

Generate an rMQR code and save as SVG to stream.

method WriteImage

public static void WriteImage(RmQRCodeData rmQrCodeData, IBufferWriter<byte> writer, SKEncodedImageFormat format, int size = 512, int quality = 100);

Generate an rMQR code and write encoded image bytes to a buffer writer.

method WriteImage

public static void WriteImage(string content, IBufferWriter<byte> writer, SKEncodedImageFormat format, RmQREccLevel eccLevel = 0, int size = 512, int quality = 100);

Generate an rMQR code and write encoded image bytes to a buffer writer.

method WritePng

public static void WritePng(RmQRCodeData rmQrCodeData, IBufferWriter<byte> writer, int size = 512);

Generate an rMQR code and write PNG bytes to a buffer writer.

method WritePng

public static void WritePng(string content, IBufferWriter<byte> writer, RmQREccLevel eccLevel = 0, int size = 512);

Generate an rMQR code and write PNG bytes to a buffer writer.

method WriteSvg

public static void WriteSvg(RmQRCodeData rmQrCodeData, IBufferWriter<byte> writer, int size = 512);

Generate an rMQR code and write the SVG document to a buffer writer.

method WriteSvg

public static void WriteSvg(string content, IBufferWriter<byte> writer, RmQREccLevel eccLevel = 0, int size = 512);

Generate an rMQR code and write the SVG document to a buffer writer.

method TryDecode

public static bool TryDecode(SKBitmap bitmap, out string text);

method TryDecode

public static bool TryDecode(SKBitmap bitmap, out string text, out RmQRCodeDecodeInfo info);

field Default

public static readonly RoundedRectangleCircleFinderPatternShape Default;

Gets the default instance.

constructor RoundedRectangleCircleFinderPatternShape

public RoundedRectangleCircleFinderPatternShape(float cornerRadiusPercent = 0.3);

Initializes a new instance with the specified corner radius.

property RequiresAntialiasing

public bool RequiresAntialiasing { get; }

Requires antialiasing to prevent jagged edges on curves.

method Draw

public override void Draw(SKCanvas canvas, SKRect rect, SKPaint paint);

method Draw

public override void Draw(SKCanvas canvas, SKRect rect, SKPaint paint, SKColor backgroundColor);

method Draw

public override void Draw(SKCanvas canvas, SKRect rect, SKPaint paint, SKPaint backgroundPaint);

field Default

public static readonly RoundedRectangleFinderPatternShape Default;

Gets the default instance.

constructor RoundedRectangleFinderPatternShape

public RoundedRectangleFinderPatternShape(float cornerRadiusPercent = 0.2);

Initializes a new instance with the specified corner radius.

property RequiresAntialiasing

public bool RequiresAntialiasing { get; }

Requires antialiasing to prevent jagged edges on curves.

method Draw

public override void Draw(SKCanvas canvas, SKRect rect, SKPaint paint);

method Draw

public override void Draw(SKCanvas canvas, SKRect rect, SKPaint paint, SKColor backgroundColor);

method Draw

public override void Draw(SKCanvas canvas, SKRect rect, SKPaint paint, SKPaint backgroundPaint);

field Default

public static readonly RoundedRectangleModuleShape Default;

Gets the default instance.

constructor RoundedRectangleModuleShape

public RoundedRectangleModuleShape(float cornerRadiusPercent = 0.3);

Initializes a new instance with the specified corner radius.

property RequiresAntialiasing

public bool RequiresAntialiasing { get; }

Requires antialiasing to prevent jagged edges on curves.

method Draw

public override void Draw(SKCanvas canvas, SKRect rect, SKPaint paint);

Bottom = 0,

Text is positioned below the icon (default).

Center = 1,

Text is centered vertically with the icon.

Top = 2,

Text is positioned above the icon.

field One

public static readonly Vector2Slim One;

Returns the vector (1,1).

field UnitX

public static readonly Vector2Slim UnitX;

Returns the vector (1,0).

field UnitY

public static readonly Vector2Slim UnitY;

Returns the vector (0,1).

field Zero

public static readonly Vector2Slim Zero;

Returns the vector (0,0).

constructor Vector2Slim

public Vector2Slim(int value);

Creates a vector with both components set to the same value.

constructor Vector2Slim

public Vector2Slim(int x, int y);

Creates a vector from its two components.

property X

public int X { get; }

The X component of the vector.

property Y

public int Y { get; }

The Y component of the vector.

method CopyTo

public void CopyTo(Span<int> span);

Copies the vector elements to the specified span.

method CopyTo

public void CopyTo(Span<int> span, int index);

Copies the vector elements to the specified span starting at the specified index.

method CopyTo

public void CopyTo(int[] array);

Copies the vector elements to the specified array.

method CopyTo

public void CopyTo(int[] array, int index);

Copies the vector elements to the specified array starting at the specified index.