Documentation
¶
Index ¶
- func Encode(content string, level RecoveryLevel, size int) ([]byte, error)
- func WriteColorFile(content string, level RecoveryLevel, size int, ...) error
- func WriteFile(content string, level RecoveryLevel, size int, filename string) error
- type Bitset
- func (b *Bitset) Append(other *Bitset)
- func (b *Bitset) AppendBools(bits ...bool)
- func (b *Bitset) AppendByte(value byte, numBits int)
- func (b *Bitset) AppendBytes(data []byte)
- func (b *Bitset) AppendNumBools(num int, value bool)
- func (b *Bitset) AppendUint32(value uint32, numBits int)
- func (b *Bitset) At(index int) bool
- func (b *Bitset) Bits() []bool
- func (b *Bitset) ByteAt(index int) byte
- func (b *Bitset) Equals(other *Bitset) bool
- func (b *Bitset) Len() int
- func (b *Bitset) String() string
- func (b *Bitset) Substr(start int, end int) *Bitset
- type QRCode
- func (q *QRCode) Bitmap() [][]bool
- func (q *QRCode) Image(size int) image.Image
- func (q *QRCode) PNG(size int) ([]byte, error)
- func (q *QRCode) ToSmallString(inverseColor bool) string
- func (q *QRCode) ToString(inverseColor bool) string
- func (q *QRCode) Write(size int, out io.Writer) error
- func (q *QRCode) WriteFile(size int, filename string) error
- type RecoveryLevel
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Encode ¶
func Encode(content string, level RecoveryLevel, size int) ([]byte, error)
Encode a QR Code and return a raw PNG image.
size is both the image width and height in pixels. If size is too small then a larger image is silently returned. Negative values for size cause a variable sized image to be returned: See the documentation for Image().
To serve over HTTP, remember to send a Content-Type: image/png header.
func WriteColorFile ¶
func WriteColorFile(content string, level RecoveryLevel, size int, background, foreground color.Color, filename string) error
WriteColorFile encodes, then writes a QR Code to the given filename in PNG format. With WriteColorFile you can also specify the colors you want to use.
size is both the image width and height in pixels. If size is too small then a larger image is silently written. Negative values for size cause a variable sized image to be written: See the documentation for Image().
func WriteFile ¶
func WriteFile(content string, level RecoveryLevel, size int, filename string) error
WriteFile encodes, then writes a QR Code to the given filename in PNG format.
size is both the image width and height in pixels. If size is too small then a larger image is silently written. Negative values for size cause a variable sized image to be written: See the documentation for Image().
Types ¶
type Bitset ¶
type Bitset struct {
// contains filtered or unexported fields
}
Bitset stores an array of bits.
func EncodeBit ¶
Encode data for QR Code 2005 using the appropriate Reed-Solomon code.
numECBytes is the number of error correction bytes to append, and is determined by the target QR Code's version and error correction level.
ISO/IEC 18004 table 9 specifies the numECBytes required. e.g. a 1-L code has numECBytes=7.
func NewFromBase2String ¶
NewFromBase2String constructs and returns a Bitset from a string. The string consists of '1', '0' or ' ' characters, e.g. "1010 0101". The '1' and '0' characters represent true/false bits respectively, and ' ' characters are ignored.
The function panics if the input string contains other characters.
func (*Bitset) AppendBools ¶
AppendBools appends bits to the Bitset.
func (*Bitset) AppendByte ¶
AppendByte appends the numBits least significant bits from value.
func (*Bitset) AppendBytes ¶
AppendBytes appends a list of whole bytes.
func (*Bitset) AppendNumBools ¶
AppendNumBools appends num bits of value value.
func (*Bitset) AppendUint32 ¶
AppendUint32 appends the numBits least significant bits from value.
type QRCode ¶
type QRCode struct {
// Original content encoded.
Content string
// QR Code type.
Level RecoveryLevel
VersionNumber int
// User settable drawing options.
ForegroundColor color.Color
BackgroundColor color.Color
// Disable the QR Code border.
DisableBorder bool
// contains filtered or unexported fields
}
A QRCode represents a valid encoded QRCode.
func New ¶
func New(content string, level RecoveryLevel) (*QRCode, error)
New constructs a QRCode.
var q *qrcode.QRCode
q, err := qrcode.New("my content", qrcode.Medium)
An error occurs if the content is too long.
func NewWithForcedVersion ¶
func NewWithForcedVersion(content string, version int, level RecoveryLevel) (*QRCode, error)
NewWithForcedVersion constructs a QRCode of a specific version.
var q *qrcode.QRCode
q, err := qrcode.NewWithForcedVersion("my content", 25, qrcode.Medium)
An error occurs in case of invalid version.
func (*QRCode) Bitmap ¶
Bitmap returns the QR Code as a 2D array of 1-bit pixels.
bitmap[y][x] is true if the pixel at (x, y) is set.
The bitmap includes the required "quiet zone" around the QR Code to aid decoding.
func (*QRCode) Image ¶
Image returns the QR Code as an image.Image.
A positive size sets a fixed image width and height (e.g. 256 yields an 256x256px image).
Depending on the amount of data encoded, fixed size images can have different amounts of padding (white space around the QR Code). As an alternative, a variable sized image can be generated instead:
A negative size causes a variable sized image to be returned. The image returned is the minimum size required for the QR Code. Choose a larger negative number to increase the scale of the image. e.g. a size of -5 causes each module (QR Code "pixel") to be 5px in size.
func (*QRCode) PNG ¶
PNG returns the QR Code as a PNG image.
size is both the image width and height in pixels. If size is too small then a larger image is silently returned. Negative values for size cause a variable sized image to be returned: See the documentation for Image().
func (*QRCode) ToSmallString ¶
ToSmallString produces a multi-line string that forms a QR-code image, a factor two smaller in x and y then ToString.
func (*QRCode) Write ¶
Write writes the QR Code as a PNG image to io.Writer.
size is both the image width and height in pixels. If size is too small then a larger image is silently written. Negative values for size cause a variable sized image to be written: See the documentation for Image().
func (*QRCode) WriteFile ¶
WriteFile writes the QR Code as a PNG image to the specified file.
size is both the image width and height in pixels. If size is too small then a larger image is silently written. Negative values for size cause a variable sized image to be written: See the documentation for Image().
type RecoveryLevel ¶
type RecoveryLevel int
Error detection/recovery capacity. There are several levels of error detection/recovery capacity. Higher levels of error recovery are able to correct more errors, with the trade-off of increased symbol size.
const ( // Level L: 7% error recovery. Low RecoveryLevel = iota // Level M: 15% error recovery. Good default choice. Medium // Level Q: 25% error recovery. High // Level H: 30% error recovery. Highest )
Source Files
![func (q *QRCode) PNG(size int) ([]byte, error)](#QRCode.PNG){kind=link}