QRCode-Kotlin/qrcode/QRCode

QRCode

class QRCode @JvmOverloads constructor(val data: String, squareSize: Int = DEFAULT_SQUARE_SIZE, canvasSize: Int = DEFAULT_QRCODE_SIZE, val xOffset: Int = DEFAULT_X_OFFSET, val yOffset: Int = DEFAULT_Y_OFFSET, val colorFn: QRCodeColorFunction = DefaultColorFunction(), val shapeFn: QRCodeShapeFunction = DefaultShapeFunction(squareSize, innerSpace = 0), var graphicsFactory: QRCodeGraphicsFactory = QRCodeGraphicsFactory(), val errorCorrectionLevel: ErrorCorrectionLevel = ErrorCorrectionLevel.LOW, val informationDensity: Int = QRCodeProcessor.infoDensityForDataAndECL(data, errorCorrectionLevel), val maskPattern: MaskPattern = MaskPattern.PATTERN000, 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

Constructors

QRCode

@JvmOverloads

constructor(data: String, squareSize: Int = DEFAULT_SQUARE_SIZE, canvasSize: Int = DEFAULT_QRCODE_SIZE, xOffset: Int = DEFAULT_X_OFFSET, yOffset: Int = DEFAULT_Y_OFFSET, colorFn: QRCodeColorFunction = DefaultColorFunction(), shapeFn: QRCodeShapeFunction = DefaultShapeFunction(squareSize, innerSpace = 0), graphicsFactory: QRCodeGraphicsFactory = QRCodeGraphicsFactory(), errorCorrectionLevel: ErrorCorrectionLevel = ErrorCorrectionLevel.LOW, informationDensity: Int = QRCodeProcessor.infoDensityForDataAndECL(data, errorCorrectionLevel), maskPattern: MaskPattern = MaskPattern.PATTERN000, doBefore: QRCode.(QRCodeGraphics, Int, Int) -> Unit = EMPTY_FN, doAfter: QRCode.(QRCodeGraphics, Int, Int) -> Unit = EMPTY_FN)

Types

Companion

object Companion

Properties

canvasSize

var canvasSize: Int

Size of the canvas where the QRCode will be drawn into (the final image will be a square of canvasSize by canvasSize)

colorFn

val colorFn: QRCodeColorFunction

Function that will handle color processing (which color is "light" and which is "dark") - Defaults to DefaultColorFunction.

data

val data: String

Data that will be encoded.

errorCorrectionLevel

val errorCorrectionLevel: ErrorCorrectionLevel

Error Correction Level to add to embed in the QRCode. The higher the ErrorCorrectionLevel is, the higher will be the QRCode tolerance to damage - Defaults to ErrorCorrectionLevel.LOW.

graphics

var graphics: QRCodeGraphics

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

graphicsFactory

var graphicsFactory: QRCodeGraphicsFactory

Factory of QRCodeGraphics instances - Defaults to QRCodeGraphicsFactory.

informationDensity

val informationDensity: Int

Information Density (formerly known as typeNum). A number that represents how much data this QRCode can hold - Defaults to a value computed by QRCodeProcessor.infoDensityForDataAndECL.

maskPattern

val maskPattern: MaskPattern

Which mask pattern to apply to the QRCode. Slightly change the squares. Mostly for aesthetics.

qrCodeProcessor

val qrCodeProcessor: QRCodeProcessor

The underlying QRCodeProcessor object that will do all calculations

rawData

val rawData: QRCodeRawData

Raw QRCode data computed by QRCodeProcessor

shapeFn

val shapeFn: QRCodeShapeFunction

Function that will handle drawing the shapes of each square - Defaults to DefaultShapeFunction with innerSpace = 0.

squareSize

var squareSize: Int

xOffset

val xOffset: Int

Offset drawing the QRCode by this amount on the X axis (horizontal) - Defaults to 0 (zero)

yOffset

val yOffset: Int

Offset drawing the QRCode by this amount on the Y axis (vertical) - Defaults to 0 (zero)

Functions

fitIntoArea

fun fitIntoArea(width: Int, height: Int): QRCode

Computes a squareSize to make sure the QRCode can fit into an area of width by height pixels

render

@JvmOverloads

fun render(qrCodeGraphics: QRCodeGraphics = graphics, xOffset: Int = this.xOffset, yOffset: Int = this.yOffset): QRCodeGraphics

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

renderToBytes

@JvmOverloads

fun renderToBytes(qrCodeGraphics: QRCodeGraphics = graphics, xOffset: Int = this.xOffset, yOffset: Int = this.yOffset, format: String = "PNG"): ByteArray

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

reset

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.

resize

fun resize(size: Int): QRCode

Computes a squareSize to make sure the QRCode can fit into an area of width by height pixels

toString

open override fun toString(): String

QRCode

Author

See also

Constructors

Types

Properties

Functions