Interface LocatorConfiguration

Locator configuration

interface LocatorConfiguration {
    chromaReject?: boolean;
    forceSyncReadback?: boolean;
    impl?: "auto" | "webgl2";
    regionOfInterest?: RegionOfInterest;
}

Properties

chromaReject? forceSyncReadback? impl? regionOfInterest?

Properties

Optional chromaReject

chromaReject?: boolean

Disregard colorful areas, assume barcodes are printed black on white.

Remarks

This is an advanced setting and should normally not be changed.

Default Value

false

Optional forceSyncReadback

forceSyncReadback?: boolean

Disable asynchronous reads from GPU when using webgl2 LocatorConfiguration.impl.

Remarks

Some older iOS versions have issues with WebGL2 asynchronous reads. There is usually no need to change this setting from its default.

Default Value

false

Optional impl

impl?: "auto" | "webgl2"

The locator implementation to use.

Remarks

This is an advanced setting and should normally not be changed. It used to be possible to force WebGL 1, but starting with 1.5, WebGL1 is no longer supported. This property might be used in the future to switch to a WebGPU-powered locator.

Default Value

auto

Optional regionOfInterest

regionOfInterest?: RegionOfInterest

The region of interest in viewport coordinates.

Remarks

if no region of interest is specified, an appropriate one will automatically be selected at run-time depending on the configured symbologies.

Settings

Member Visibility

Theme

On This Page

chromaRejectforceSyncReadbackimplregionOfInterest