Class Logo

An RGBA logo to overlay on the centre of a QR code. Instances are frozen and own their pixels.

Implements

RgbaImage

Index

Properties

pixels width height fraction clearBorder clearShape

Methods

fromRgba fromImageBytes

Properties

`Readonly`pixels

pixels: Uint8Array

The straight-alpha RGBA pixels, row-major.

`Readonly`width

width: number

Width in pixels.

`Readonly`height

height: number

Height in pixels.

`Readonly`fraction

fraction: number

The logo's width as a fraction of the QR code's module width.

`Readonly`clearBorder

clearBorder: number

Modules cleared around the logo.

`Readonly`clearShape

clearShape: LogoClearShape

The cleared area's shape.

Methods

`Static`fromRgba

fromRgba(image: RgbaImage, options?: LogoOptions): Logo
A logo from a raw RGBA raster (copied).
Parameters
- image: RgbaImage
- options: LogoOptions = {}
Returns Logo
- Defined in logo.ts:74

`Static`fromImageBytes

fromImageBytes(data: Uint8Array, options?: LogoOptions): Logo
A logo decoded from PNG or JPEG bytes, the formats the reference is built with, as its into_rgba8 decodes them: every PNG colour type and bit depth (palettes and tRNS expanded, sub-byte grey scaled, 16-bit samples as (c + 128) / 257). Any other format, or bytes that do not decode, are ImageEncode (failed to decode image: … with the reference's wording: The image format Gif is not supported, The image format could not be determined). SVG needs the /svg-logo entry (logoFromSvg).
Parameters
- data: Uint8Array
- options: LogoOptions = {}
Returns Logo
- Defined in logo.ts:95