@mbtech-nl/bitmap / renderImage

Function: renderImage()

function renderImage(image: RawImageData, options?: ImageRenderOptions): LabelBitmap;

Defined in: image.ts:71

Convert RGBA pixel data to a packed 1bpp bitmap.

Inside renderImage the pipeline runs in this fixed order; each step is optional:

rgba → luminance(weights) → autoLevels → gamma → threshold | dither → rotate

For multi-colour printers (Brother QL-800 with red+black tape, two-colour DYMO/Zebra), see renderMultiPlaneImage instead.

Parameters

Parameter	Type	Description
image	RawImageData	RGBA pixel data; compatible with browser ImageData.
options	ImageRenderOptions	See ImageRenderOptions.

Returns

LabelBitmap

A 1bpp LabelBitmap whose dimensions match the input (or are swapped when rotate is 90 or 270).

Throws

If image dimensions are zero or data.length does not match width * height * 4. Also if gamma is non-finite or non-positive, or if a custom luminanceWeights tuple has invalid values.

Examples

const bmp = renderImage(rgba, { threshold: 128 });

const bmp = renderImage(rgba, { dither: 'atkinson', rotate: 90 });

const bmp = renderImage(rgba, { autoLevels: true, dither: 'floyd-steinberg' });