QRCode-Kotlin/qrcode/QRCode

QRCode

class QRCode @JvmOverloads constructor(val data: String, val squareSize: Int = DEFAULT_SQUARE_SIZE, val colorFn: QRCodeColorFunction = DefaultColorFunction(), val shapeFn: QRCodeShapeFunction = DefaultShapeFunction(squareSize, innerSpace = 0), var graphicsFactory: QRCodeGraphicsFactory = QRCodeGraphicsFactory(), errorCorrectionLevel: ErrorCorrectionLevel = ErrorCorrectionLevel.VERY_HIGH, minTypeNum: Int = 6, forceMinTypeNum: Boolean = false, doBefore: QRCode.(QRCodeGraphics, Int, Int) -> Unit = EMPTY_FN, doAfter: QRCode.(QRCodeGraphics, Int, Int) -> Unit = EMPTY_FN)(source)

A simple class to create easily create aesthetic pleasing QRCodes.

It'll create a QRCodeProcessor and build a custom render function on top of it.

It includes things like:

  • QR Codes with a logo at the center

  • QR Codes with dots instead of squares

  • Colorful QR Codes (including linear gradient colors)

If you have a suggestion for a nice QR Code style, feel free to open a PR, or an Issue with your suggestion :)

Author

Rafael Lins - g0dkar

See also

Constructors

Link copied to clipboard
@JvmOverloads
constructor(data: String, squareSize: Int = DEFAULT_SQUARE_SIZE, colorFn: QRCodeColorFunction = DefaultColorFunction(), shapeFn: QRCodeShapeFunction = DefaultShapeFunction(squareSize, innerSpace = 0), graphicsFactory: QRCodeGraphicsFactory = QRCodeGraphicsFactory(), errorCorrectionLevel: ErrorCorrectionLevel = ErrorCorrectionLevel.VERY_HIGH, minTypeNum: Int = 6, forceMinTypeNum: Boolean = false, doBefore: QRCode.(QRCodeGraphics, Int, Int) -> Unit = EMPTY_FN, doAfter: QRCode.(QRCodeGraphics, Int, Int) -> Unit = EMPTY_FN)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard
val computedSize: Int

Calculated size of the whole QRCode (the final image will be a square of computedSize by computedSize)

Link copied to clipboard
val data: String
Link copied to clipboard
val graphics: QRCodeGraphics

The QRCodeGraphics (aka "canvas") where all the drawing will happen

Link copied to clipboard
Link copied to clipboard
val qrCodeProcessor: QRCodeProcessor

The underlying QRCodeProcessor object that'll do all calculations

Link copied to clipboard
val rawData: Array<Array<QRCodeSquare>>

Raw QRCode data computed by QRCodeProcessor

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val typeNum: Int

Computed type number for the given data parameter

Functions

Link copied to clipboard
@JvmOverloads
fun render(qrCodeGraphics: QRCodeGraphics = graphics, xOffset: Int = 0, yOffset: Int = 0): QRCodeGraphics

Executes all the drawing of the QRCode and returns the QRCodeGraphics of the complete QRCode.

Link copied to clipboard
@JvmOverloads
fun renderToBytes(format: String = "PNG"): ByteArray

Calls render and then returns the bytes of a format (default = PNG) render of the QRCode.

Link copied to clipboard
fun reset()

Completely resets the QRCode drawing. After this, you can call renderToBytes or render to redraw the whole QRCode. Useful when you want, for example, a transparent background QRCode to add to a larger image and then the same QRCode drawn on top of a custom background.