Skip to content

ReferenceImage

An interface specifying an image template that is fed to an Image Tracker.

Guidelines for Images

Read Guidelines for Images for tips on how to design images that are suitable for tracking.

Properties

name

referenceImage.name: string, read-only

A name used to identify this reference image in a database.

image

referenceImage.image: HTMLImageElement | ImageBitmap | ImageData, read-only

Image template with pixel data.

Note: ImageData is acceptable since version 0.4.0.

👨‍💻 Need help?