love.yinlin.compose.components.qrcode/io.github.alexzhirkevich.qrose.options

Package-level declarations

Types

@Immutable

class Neighbors(val topLeft: Boolean = false, val topRight: Boolean = false, val left: Boolean = false, val top: Boolean = false, val right: Boolean = false, val bottomLeft: Boolean = false, val bottom: Boolean = false, val bottomRight: Boolean = false)

Status of the neighbor QR code pixels or eyes

QrBackground

@Stable

class QrBackground(val painter: Painter? = null, val fill: Brush? = null, val shape: Shape = RectangleShape)

QrBallShape

@Stable

interface QrBallShape : QrShapeModifier

Style of the qr-code eye internal ball.

QrBrush

@Stable

interface QrBrush

Color Brush factory for a QR code part.

QrBrushMode

enum QrBrushMode : Enum<QrBrushMode>

QrCodeMatrix

class QrCodeMatrix(val size: Int, initialFill: QrCodeMatrix.PixelType = PixelType.Background)

QrCodeShape

@Stable

interface QrCodeShape

Shape of the QR-code pattern.

QrColors

@Stable

class QrColors(val dark: QrBrush = QrBrush.Default, val light: QrBrush = QrBrush.Unspecified, val ball: QrBrush = QrBrush.Unspecified, val frame: QrBrush = QrBrush.Unspecified)

Colors of QR code elements

QrErrorCorrectionLevel

@Immutable

enum QrErrorCorrectionLevel : Enum<QrErrorCorrectionLevel>

QR code allows you to read encoded information even if a part of the QR code image is damaged. It also allows to have logo inside the code as a part of "damage".

QrFrameShape

@Stable

interface QrFrameShape : QrShapeModifier

Style of the qr-code eye frame.

QrLogo

@Stable

class QrLogo(val painter: Painter? = null, val size: Float = 0.25f, val padding: QrLogoPadding = QrLogoPadding.Empty, val shape: QrLogoShape = QrLogoShape.Default)

Logo (middle image) of the QR code.

QrLogoPadding

@Stable

sealed interface QrLogoPadding

Type of padding applied to the logo. Helps to highlight the logo inside the QR code pattern. Padding can be added regardless of the presence of a logo.

QrLogoShape

@Stable

interface QrLogoShape : QrShapeModifier

QrOptions

@Stable

class QrOptions(val shapes: QrShapes = QrShapes(), val colors: QrColors = QrColors(), val logo: QrLogo = QrLogo(), val background: QrBackground = QrBackground(), val errorCorrectionLevel: QrErrorCorrectionLevel = QrErrorCorrectionLevel.Auto, val fourEyed: Boolean = false, val scale: Float = 1.0f)

Styling options of the QR code

QrPixelShape

@Stable

fun interface QrPixelShape : QrShapeModifier

Style of the qr-code pixels.

QrShapeModifier

fun interface QrShapeModifier

QrShapes

@Immutable

class QrShapes(val code: QrCodeShape = QrCodeShape.Default, val darkPixel: QrPixelShape = QrPixelShape.Default, val lightPixel: QrPixelShape = QrPixelShape.Default, val ball: QrBallShape = QrBallShape.Default, val frame: QrFrameShape = QrFrameShape.Default, val centralSymmetry: Boolean = true)

Shapes of QR code elements