QRCode-Kotlin/qrcode/QRCodeBuilder

QRCodeBuilder

class QRCodeBuilder @JvmOverloads constructor(shape: QRCodeShapesEnum, customShapeFunction: QRCodeShapeFunction? = null)(source)

Constructors

QRCodeBuilder

@JvmOverloads

constructor(shape: QRCodeShapesEnum, customShapeFunction: QRCodeShapeFunction? = null)

Functions

build

fun build(data: String): QRCode

Builds a QRCode instance ready to use.

withAfterRenderAction

fun withAfterRenderAction(action: QRCode.(QRCodeGraphics) -> Unit): QRCodeBuilder

Run a piece of code after the rendering is done.

withBackgroundColor

fun withBackgroundColor(bgColor: Int): QRCodeBuilder

Background color of the QRCode.

withBeforeRenderAction

fun withBeforeRenderAction(action: QRCode.(QRCodeGraphics) -> Unit): QRCodeBuilder

Run a piece of code before the rendering is done.

withCanvasSize

fun withCanvasSize(size: Int): QRCodeBuilder

Size, in pixels, of the canvas the QRCode will be drawn into. The resulting image will be a square of size by size.

withColor

fun withColor(color: Int): QRCodeBuilder

Color of the cells of the QRCode.

withCustomColorFunction

fun withCustomColorFunction(colorFn: QRCodeColorFunction?): QRCodeBuilder

Sets the QRCode.colorFn value to a custom one. If set, the builder will ignore color and background.

withCustomShapeFunction

fun withCustomShapeFunction(shapeFn: QRCodeShapeFunction?): QRCodeBuilder

Sets the QRCode.shapeFn value to a custom one. If set, the builder will ignore the shape parameter.

withErrorCorrectionLevel

fun withErrorCorrectionLevel(ecl: ErrorCorrectionLevel): QRCodeBuilder

The level of error correction to apply to the QR Code. Defaults to ErrorCorrectionLevel.LOW.

withGradientColor

@JvmOverloads

fun withGradientColor(startColor: Int, endColor: Int?, vertical: Boolean = true): QRCodeBuilder

Uses a LinearGradientColorFunction to choose colors for the QRCode.

withGraphicsFactory

fun withGraphicsFactory(factory: QRCodeGraphicsFactory): QRCodeBuilder

Use a custom QRCodeGraphicsFactory instead of the default. Use this to have a way to better control how and where the QRCode drawing will occur.

withInformationDensity

fun withInformationDensity(informationDensity: Int): QRCodeBuilder

The level of "information density" this QRCode will support.

withInnerSpacing

@JvmOverloads

fun withInnerSpacing(innerSpacing: Int? = null): QRCodeBuilder

How much space there should be around each QRCode Cell. Defaults to 1 pixel, or 0 if a custom shape function is being used.

withLogo

@JvmOverloads

fun withLogo(logo: ByteArray?, width: Int, height: Int, clearLogoArea: Boolean = true): QRCodeBuilder

Adds an image on top of the QRCode, at the center of it.

withMargin

fun withMargin(margin: Int): QRCodeBuilder

Adds extra space around the QRCode.

withMaskPattern

fun withMaskPattern(maskPattern: MaskPattern): QRCodeBuilder

Which MaskPattern to apply on the QRCode. Mostly for aesthetics. Defaults to MaskPattern.PATTERN000.

withRadius

fun withRadius(radius: Int): QRCodeBuilder

Radius of the edges of the Rounded Squares. Only applies for Rounded Squares. If set to a negative number, the default radius will be used.

withShape

fun withShape(shape: QRCodeShapesEnum): QRCodeBuilder

Changes the Shape of the QRCode.

withSize

fun withSize(size: Int): QRCodeBuilder

Size of each individual space in the QRCode (each cell).

withXOffset

fun withXOffset(xOffset: Int): QRCodeBuilder

Offset drawing the QRCode on the X-axis (horizontal) by this many pixels.

withYOffset

fun withYOffset(yOffset: Int): QRCodeBuilder

Offset drawing the QRCode on the Y-axis (vertical) by this many pixels.