Oscore.QrCodes.ImageSharp 1.0.2

QrCodes

Modern and efficient cross-platform QR code generation, rendering and serialization.

🔥 Features 🔥

• Use SkiaSharp/ImageSharp instead of System.Drawing to be cross-platform.
• Support latest dotnet versions.
• Generate QR code with logo image.
• Allows many different styles.
• Supports many predefined payloads:
  • BezahlCode
  • Bitcoin like address
  • Bookmark
  • CalendarEvent
  • ContactData
  • Geolocation
  • Girocode
  • Mail
  • MMS
  • MoneroTransaction
  • OneTimePassword
  • PhoneNumber
  • ShadowSocksConfig
  • SkypeCall
  • SloveniaUpnQR
  • SMS
  • SwissQRCode
  • Url
  • WhatsAppMessage
  • Telegram
  • Wi-Fi
• Supports next renderers
  • Ascii
  • Base64
  • SVG
  • PostScript
  • PDF
  • FastPngRenderer - fast but not support all features
  • Bitmap(.bmp) - fast but not support all features
  • ImageSharp - powerful, allows many features and export formats
  • SkiaSharp - powerful, allows many features and export formats
  • System.Drawing - legacy, only windows, not support all features
• Supports helpers for MAUI
  • QrCodeSource - ImageSource to produce QR code
  • QrCodeExtension markup extension - Simplifies usage of QrCodeSource

Usage

// Base library with all payloads and some renderers(Ascii, Base64, Pdf, FastBitmap, FastPng, SVG, PostScript)
dotnet add package Oscore.QrCodes

// SkiaSharpRenderer(Gif, Jpeg, Png, WebP, Bmp, Ico, Wbmp, Pkm, Ktx, Astc, Dng, Heif, Avif)
dotnet add package Oscore.QrCodes.SkiaSharp
// ImageSharpRenderer(Gif, Jpeg, Png, WebP, Bmp, Pbm, Tga, Tiff)
dotnet add package Oscore.QrCodes.ImageSharp
// SystemDrawingRenderer(Gif, Jpeg, Png, Bmp, Tiff)
dotnet add package Oscore.QrCodes.System.Drawing

// MAUI helpers(QrCodeSource and QrCodeExtension markup extension). Uses SkiaSharpRenderer.
dotnet add package Oscore.QrCodes.Maui

Generate QR code

var qrCode = QrCodeGenerator.Generate(
    plainText: new Mail(email: "hello@oscore.io").ToString(),
    eccLevel: ErrorCorrectionLevel.High);
using var pngBytes = SkiaSharpRenderer.RenderToBytes(
    data,
    settings: new RendererSettings
    {
        DarkColor = Color.Red,
    });

Generate ImageSource for MAUI

You can test all variants using QrCodes.SampleApp MAUI app

xmlns:qr="clr-namespace:QrCodes.Maui;assembly=QrCodes.Maui"

<Image Source="{qr:QrCode 'https://oscore.io/'}" />

Links

• https://github.com/SixLabors/ImageSharp
• https://github.com/codebude/QRCoder
• https://github.com/JPlenert/QRCoder-ImageSharp
• https://dev.to/vhugogarcia/generate-qr-code-in-net-maui-3c8n
• https://qrapi.io/
• https://github.com/manuelbl/QrCodeGenerator
• https://qr.io/

Benchmarks

You can view the reports for each version here

BenchmarkDotNet v0.13.12, macOS Sonoma 14.2.1 (23C71) [Darwin 23.2.0]
Apple M1 Pro, 1 CPU, 10 logical and 10 physical cores
.NET SDK 8.0.100
  [Host]     : .NET 8.0.0 (8.0.23.53103), Arm64 RyuJIT AdvSIMD
  DefaultJob : .NET 8.0.0 (8.0.23.53103), Arm64 RyuJIT AdvSIMD

Categories=Renderers  

Benchmarks with issues: Benchmarks.SkiaSharpRenderer_Bmp: DefaultJob

Legal information and credits

It was forked from the QRCoder-ImageSharp project.
QRCoder is a project by Raffael Herrmann and was first released in 10/2013.
QRCoder-ImageSharp is a project by Joerg Plenert.
It's licensed under the MIT license.

Disclaimer

Although the library includes many things, we only use and support QrCodes/SkiaSharp/Maui functionality.
But we will be happy to accept your PR regarding ImageSharp/SystemDrawing/WPF/other renderers.