imaging

Documentation

Overview

Package imaging provides utilities for generating and manipulating images. This includes QR code generation with customizable options.

Index

• func GenerateQRCodeDataURL(content string) (string, error)
• type QRCodeGenerator
  • func NewQRCodeGenerator() *QRCodeGenerator
  • func (g *QRCodeGenerator) GenerateDataURL(content string) (string, error)
  • func (g *QRCodeGenerator) GeneratePNG(content string) ([]byte, error)
  • func (g *QRCodeGenerator) WithRecoveryLevel(level RecoveryLevel) *QRCodeGenerator
  • func (g *QRCodeGenerator) WithSize(size int) *QRCodeGenerator
• type RecoveryLevel

Functions

func GenerateQRCodeDataURL

func GenerateQRCodeDataURL(content string) (string, error)

GenerateQRCodeDataURL is a convenience function to generate a QR code data URL with default settings (200x200, medium recovery).

Types

type QRCodeGenerator

type QRCodeGenerator struct {
	// contains filtered or unexported fields
}

QRCodeGenerator generates QR codes as data URLs or raw bytes.

func NewQRCodeGenerator

func NewQRCodeGenerator() *QRCodeGenerator

NewQRCodeGenerator creates a new QR code generator with default settings. Default size is 200x200 pixels with medium recovery level.

func (*QRCodeGenerator) GenerateDataURL

func (g *QRCodeGenerator) GenerateDataURL(content string) (string, error)

GenerateDataURL generates a QR code as a base64-encoded PNG data URL. The returned string can be used directly in HTML img src attributes. Example output: "data:image/png;base64,iVBORw0KGgoAAAANS..."

func (*QRCodeGenerator) GeneratePNG

func (g *QRCodeGenerator) GeneratePNG(content string) ([]byte, error)

GeneratePNG generates a QR code as raw PNG bytes.

func (*QRCodeGenerator) WithRecoveryLevel

func (g *QRCodeGenerator) WithRecoveryLevel(level RecoveryLevel) *QRCodeGenerator

WithRecoveryLevel sets the error recovery level.

func (*QRCodeGenerator) WithSize

func (g *QRCodeGenerator) WithSize(size int) *QRCodeGenerator

WithSize sets the QR code size in pixels.

type RecoveryLevel

type RecoveryLevel int

RecoveryLevel defines the error correction level for QR codes.

const (
	// RecoveryLow recovers from ~7% data loss.
	RecoveryLow RecoveryLevel = iota
	// RecoveryMedium recovers from ~15% data loss.
	RecoveryMedium
	// RecoveryHigh recovers from ~25% data loss.
	RecoveryHigh
	// RecoveryHighest recovers from ~30% data loss.
	RecoveryHighest
)