Class RenderedImage

A rendered QR code: an RGBA raster with PNG and JPEG encoders.

Implements

RgbaImage

Index

Constructors

Properties

width height pixels

Methods

Constructors

constructor

new RenderedImage(image: RgbaImage): RenderedImage
Wraps image (its buffer is used as is, not copied); InvalidParameter unless it is a well-formed RgbaImage.
Parameters
- image: RgbaImage
Returns RenderedImage
- Defined in render.ts:91

Properties

`Readonly`width

width: number

Width in pixels.

`Readonly`height

height: number

Height in pixels.

`Readonly`pixels

pixels: Uint8Array

The RGBA pixels, row-major, width * height * 4 bytes.

Methods

toPng

toPng(): Uint8Array
PNG bytes (RGBA, 8-bit).

Returns Uint8Array
- Defined in render.ts:100

toJpeg

toJpeg(options?: { quality?: number }): Uint8Array
JPEG bytes at quality, an integer 0–255 clamped to 1–100 as the reference's encoder clamps it (default 90). Alpha is dropped.
Parameters
- options: { quality?: number } = {}
Returns Uint8Array
- Defined in render.ts:118