qrcode

README

设置头像

    qr.SetAvatar(&qrcode.Avatar{
		Src:    "../static/1.jpg",
		Width:  60,
		Height: 60,
		Round:  10,
	})

设置背景图

qr.SetBackgroundImage(&qrcode.SetBackgroundImage{
		Src:    "../static/3.png",
		X:      70,
		Y:      55,
		Width:  270,
		Height: 270,
	})

设置前景图

qr.SetForegroundImage("../static/2.png")

Documentation

Index

• Constants
• type Avatar
• type BackgroundImage
• type ForegroundImage
• type Generate
• type IQrCode
• type QrCode
  • func New(content string, level qrcode.RecoveryLevel) (*QrCode, error)
  • func (q *QrCode) DefaultCreateAvatar(img image.Image) (image.Image, error)
  • func (q *QrCode) DefaultCreateBackgroundImage(img image.Image) (image.Image, error)
  • func (q *QrCode) DefaultCreateForegroundImage(img image.Image) (image.Image, error)
  • func (q *QrCode) DisableBorder(disable bool)
  • func (q *QrCode) Image(size int) (image.Image, error)
  • func (q *QrCode) PNG(size int) ([]byte, error)
  • func (q *QrCode) SetAvatar(avatar *Avatar)
  • func (q *QrCode) SetBackgroundColor(color color.Color)
  • func (q *QrCode) SetBackgroundImage(img *BackgroundImage)
  • func (q *QrCode) SetCreateAvatar(create Generate)
  • func (q *QrCode) SetCreateBackgroundImage(create Generate)
  • func (q *QrCode) SetCreateForegroundImage(create Generate)
  • func (q *QrCode) SetForegroundColor(color color.Color)
  • func (q *QrCode) SetForegroundImage(src string)
  • func (q *QrCode) Write(size int, out io.Writer) error
  • func (q *QrCode) WriteFile(size int, filename string) error

Constants

const (
	// Level L: 7% error recovery.
	Low = qrcode.Low

	// Level M: 15% error recovery. Good default choice.
	Medium = qrcode.Medium

	// Level Q: 25% error recovery.
	High = qrcode.High

	// Level H: 30% error recovery.
	Highest = qrcode.Highest
)

Types

type Avatar

type Avatar struct {
	Src    string // 头像地址
	Width  int    // 头像宽度
	Height int    // 头像高度
}

type BackgroundImage

type BackgroundImage struct {
	Src    string
	X      int
	Y      int
	Width  int
	Height int
}

type ForegroundImage

type ForegroundImage struct {
	Src string
}

type Generate

type Generate func(image.Image) (image.Image, error)

type IQrCode

type IQrCode interface {
	// 设置头像
	SetAvatar(*Avatar)

	// 设置背景图
	SetBackgroundImage(*BackgroundImage)

	// 设置背景颜色
	SetBackgroundColor(color.Color)

	// 设置前景图
	SetForegroundImage(string)

	// 设置前景颜色
	SetForegroundColor(color.Color)

	DisableBorder(bool)

	// 返回生成的二维码图片
	Image(size int) (image.Image, error)

	// 返回 png 二维码图片
	PNG(size int) ([]byte, error)

	// 将二维码以PNG写入io.Writer
	Write(size int, out io.Writer) error

	// 将二维码以PNG写入指定的文件
	WriteFile(size int, filename string) error
}

type QrCode

type QrCode struct {
	Avatar                *Avatar
	ForegroundImage       *ForegroundImage
	BackgroundImage       *BackgroundImage
	CreateBackgroundImage Generate
	CreateForegroundImage Generate
	CreateAvatar          Generate
	// contains filtered or unexported fields
}

func New

func New(content string, level qrcode.RecoveryLevel) (*QrCode, error)

func (*QrCode) DefaultCreateAvatar

func (q *QrCode) DefaultCreateAvatar(img image.Image) (image.Image, error)

默认创建头像的方法

func (*QrCode) DefaultCreateBackgroundImage

func (q *QrCode) DefaultCreateBackgroundImage(img image.Image) (image.Image, error)

默认创建背景图的方法

func (*QrCode) DefaultCreateForegroundImage

func (q *QrCode) DefaultCreateForegroundImage(img image.Image) (image.Image, error)

默认创建前景图的方法

func (*QrCode) DisableBorder

func (q *QrCode) DisableBorder(disable bool)

func (*QrCode) Image

func (q *QrCode) Image(size int) (image.Image, error)

返回生成的二维码图片

func (*QrCode) PNG

func (q *QrCode) PNG(size int) ([]byte, error)

返回 png 二维码图片

func (*QrCode) SetAvatar

func (q *QrCode) SetAvatar(avatar *Avatar)

设置头像

func (*QrCode) SetBackgroundColor

func (q *QrCode) SetBackgroundColor(color color.Color)

设置背景颜色

func (*QrCode) SetBackgroundImage

func (q *QrCode) SetBackgroundImage(img *BackgroundImage)

设置背景图

func (*QrCode) SetCreateAvatar

func (q *QrCode) SetCreateAvatar(create Generate)

func (*QrCode) SetCreateBackgroundImage

func (q *QrCode) SetCreateBackgroundImage(create Generate)

func (*QrCode) SetCreateForegroundImage

func (q *QrCode) SetCreateForegroundImage(create Generate)

func (*QrCode) SetForegroundColor

func (q *QrCode) SetForegroundColor(color color.Color)

设置前景颜色

func (*QrCode) SetForegroundImage

func (q *QrCode) SetForegroundImage(src string)

设置前景图

func (*QrCode) Write

func (q *QrCode) Write(size int, out io.Writer) error

将二维码以PNG写入io.Writer

func (*QrCode) WriteFile

func (q *QrCode) WriteFile(size int, filename string) error

将二维码以PNG写入指定的文件