Announcing Release of 1.0.0

[guitarrapc]

Announcing Release of 1.0.0

Thank you to everyone who has used and contributed to this project. We’re finally at a release we can call 1.0.0.

With this release, we believe SkiaSharp.QrCode has become a fast, easy-to-use QR code library.

We’ve also added decoding, which wasn’t supported before — we’d love to hear your feedback. That said, the library is designed for clean image inputs; it isn’t intended to handle raw camera captures that require computer vision. Please keep that in mind.

Highlights

• Faster encoding, SIMD-accelerated Reed–Solomon (GFNI / SSSE3 / ARM AdvSimd / NEON), bit-parallel module placement, optimized masking, and tighter allocation patterns across the encode pipeline.
• Zero-allocation encoding, CreateQrCode(..., Span<byte> destination) writes the module matrix into a caller-provided buffer with no per-encode heap allocation.
• Decoding, QRCodeDecoder reads QR codes from module matrices and from images (rotation, mirroring, inverted palettes; Reed–Solomon error correction included).

Overview

• Major encode-path performance work (ECC, interleaving, bit packing, data placement, masking).
• SVG output API, GetSvgString(), GetSvgBytes(), SaveSvg(), SaveToSvg(), ToSvgString() on QRCodeImageBuilder (all styling options supported).
• QrCode class removed, deprecated since 0.9.0; use QRCodeImageBuilder instead.
• WithModulePixelSize() and WithVersion() for sharper module-aligned output and logo placement.
• Browser Playground (WebAssembly): https://guitarrapc.github.io/SkiaSharp.QrCode/
• Update SkiaSharp dependencies to 4.148.0.

Usage

Quick start (PNG / SVG)

using SkiaSharp.QrCode.Image;
File.WriteAllBytes("qrcode.png", QRCodeImageBuilder.GetPngBytes("https://example.com"));
File.WriteAllText("qrcode.svg", QRCodeImageBuilder.GetSvgString("https://example.com"));

Zero allocation encode

var calculated = QRCodeGenerator.GetRequiredBufferSize("content", ECCLevel.M);
var buffer = ArrayPool<byte>.Shared.Rent(calculated.BufferSize);
try
{
    var written = QRCodeGenerator.CreateQrCode("content", ECCLevel.M, buffer);
    var matrix = buffer.AsSpan(0, written); // 0 = light, 1 = dark, row-major
}
finally
{
    ArrayPool<byte>.Shared.Return(buffer);
}

Decode

// From generated data (round-trip)
var qrData = QRCodeGenerator.CreateQrCode("content", ECCLevel.M);
if (QRCodeDecoder.TryDecode(qrData, out var text))
    Console.WriteLine(text);
// From an image
using var bitmap = SKBitmap.Decode("qr.png");
if (QRCodeDecoder.TryDecode(bitmap, out var text, out var info))
    Console.WriteLine($"{text} (v{info.Version}, ECC {info.EccLevel})");

Migration

The obsolete QrCode class has been removed in 1.0.0. Replace it with QRCodeImageBuilder.

See the Migration Guide for before/after examples (stream output, format/quality, overlays, and default ECC level change: QrCode used ECCLevel.L, QRCodeImageBuilder defaults to ECCLevel.M).