README
¶
Image Exporter
This exporter accepts QR code matrix and exports it to image.Image
Documentation
¶
Index ¶
- Variables
- func ParseFromHex(s string) color.RGBA
- type Exporter
- type GradientConfig
- type GradientDirection
- type ImageOption
- func WithBgColor(c color.Color) ImageOption
- func WithBgColorHex(hex string) ImageOption
- func WithFgColor(c color.Color) ImageOption
- func WithFgColorHex(hex string) ImageOption
- func WithFinderShape(c shapes.FinderDrawConfig) ImageOption
- func WithGradient(d GradientDirection, colors ...color.Color) ImageOption
- func WithImageSize(size int) ImageOption
- func WithLogo(img image.Image) ImageOption
- func WithModuleGap(gap float64) ImageOption
- func WithModuleShape(drawer shapes.ModuleDrawer) ImageOption
- func WithQuietZone(size int) ImageOption
- func WithSpaceAroundLogo() ImageOption
Constants ¶
This section is empty.
Variables ¶
var DefaultImageOptions = imageOptions{ // contains filtered or unexported fields }
Functions ¶
func ParseFromHex ¶
ParseFromHex convert hex string into color.RGBA
Types ¶
type Exporter ¶
type Exporter struct {
// contains filtered or unexported fields
}
Exporter exports gqr.Matrix to image.Image
func NewExporter ¶
func NewExporter(opts ...ImageOption) Exporter
NewExporter creates new Exporter. (see DefaultImageOptions)
type GradientConfig ¶
type GradientConfig struct {
// contains filtered or unexported fields
}
type GradientDirection ¶
type GradientDirection = int
const ( // GradientDirectionTLBR - Top Left -> Bottom Right GradientDirectionTLBR GradientDirection = iota // GradientDirectionTRBL - Top Right -> Bottom Left GradientDirectionTRBL GradientDirection = iota )
type ImageOption ¶
type ImageOption interface {
// contains filtered or unexported methods
}
func WithFgColor ¶
func WithFgColor(c color.Color) ImageOption
WithFgColor sets color that is used to draw modules (ignored if gradient is set)
func WithFgColorHex ¶
func WithFgColorHex(hex string) ImageOption
WithFgColorHex Hex string to set QR Color
func WithFinderShape ¶
func WithFinderShape(c shapes.FinderDrawConfig) ImageOption
WithFinderShape sets config for drawing 3 finders in corners of QR code. See: shapes.SquareFinderShape, shapes.RoundedFinderShape.
func WithGradient ¶
func WithGradient(d GradientDirection, colors ...color.Color) ImageOption
WithGradient will use gradient to paint modules instead of foregroundColor (if set by WithFgColor or WithFgColorHex)
func WithImageSize ¶
func WithImageSize(size int) ImageOption
WithImageSize sets size of outputted image in pixels Values less than 1 are ignored
func WithLogo ¶
func WithLogo(img image.Image) ImageOption
WithLogo embeds image at the center of the QR
func WithModuleGap ¶
func WithModuleGap(gap float64) ImageOption
WithModuleGap will set gaps between modules in percents relative to dynamic module size (determined by quiet zone and image size)
Note: gap should be in range [0; 1). Other values are ignored
func WithModuleShape ¶
func WithModuleShape(drawer shapes.ModuleDrawer) ImageOption
WithModuleShape sets function that will draw modules on the image See: shapes.SquareModuleShape, shapes.RoundedModuleShape.
func WithQuietZone ¶
func WithQuietZone(size int) ImageOption
WithQuietZone set padding around QR code. Note: actual size of the QR code is equal to size - quietZone * 2 (padding applied on every side )
func WithSpaceAroundLogo ¶
func WithSpaceAroundLogo() ImageOption
WithSpaceAroundLogo adds empty space behind logo, so it's not drawn on top of modules
Source Files
Directories