Interface Config

Hold all configurable parameters for the viewer

interface Config {
    3dCommerceCertified?: boolean;
    basisTranscoder?: {
        urlConfig?: {
            jsModuleUrl?: string;
            wasmModuleUrl?: string;
        };
    };
    cameraConfig?: CameraConfig;
    dracoCompression?: {
        decoders?: {
            fallbackUrl?: string;
            wasmBinaryUrl?: string;
            wasmUrl?: string;
        };
        defaultNumWorkers?: number;
    };
    enableDragAndDrop?: boolean;
    engineConfig?: {
        antialiasing?: boolean;
        disableResize?: boolean;
        engineOptions?: EngineOptions;
        useNullEngine?: boolean;
    };
    extensionConfig?: object;
    ktx2Decoder?: {
        defaultNumWorkers?: number;
        urlConfig?: {
            jsDecoderModule: string;
            jsMSCTranscoder: null | string;
            wasmMSCTranscoder: null | string;
            wasmUASTCToASTC: null | string;
            wasmUASTCToBC7: null | string;
            wasmUASTCToR8_UNORM: null | string;
            wasmUASTCToRG8_UNORM: null | string;
            wasmUASTCToRGBA_SRGB: null | string;
            wasmUASTCToRGBA_UNORM: null | string;
            wasmZSTDDecoder: null | string;
        };
    };
    lightingConfig?: LightingConfig;
    meshoptCompression?: {
        decoder?: {
            url: string;
        };
    };
    renderingPipelineConfig?: RenderingPipelineConfig;
    sceneConfig?: SceneConfig;
}

Index

Properties

3dCommerceCertified? basisTranscoder? cameraConfig? dracoCompression? enableDragAndDrop? engineConfig? extensionConfig? ktx2Decoder? lightingConfig? meshoptCompression? renderingPipelineConfig? sceneConfig?

Properties

`Optional`3dCommerceCertified

3dCommerceCertified?: boolean

Whether to enable 3D Commerce Certified Viewer

See

https://doc.babylonjs.com/setup/support/3D_commerce_certif

Default

true

`Optional`basisTranscoder

basisTranscoder?: {
    urlConfig?: {
        jsModuleUrl?: string;
        wasmModuleUrl?: string;
    };
}

Basis transcoder configuration

Type declaration

OptionalurlConfig?: {
jsModuleUrl?: string;
wasmModuleUrl?: string;
}
Define where to find transcoder files. It can be an external URL or a local file path.
Default
```
empty string for all urls
```
- OptionaljsModuleUrl?: string
- OptionalwasmModuleUrl?: string

See

https://doc.babylonjs.com/typedoc/modules/BABYLON#BasisToolsOptions

`Optional`cameraConfig

cameraConfig?: CameraConfig

Camera configuration

Default

create an ArcRotateCamera with alpha = 0, beta = 0, radius = 1, and target = Vector3.Zero

`Optional`dracoCompression

dracoCompression?: {
    decoders?: {
        fallbackUrl?: string;
        wasmBinaryUrl?: string;
        wasmUrl?: string;
    };
    defaultNumWorkers?: number;
}

Draco compression configuration

Type declaration

Optionaldecoders?: {
    fallbackUrl?: string;
    wasmBinaryUrl?: string;
    wasmUrl?: string;
}
Define where to find decoders. It can be an external URL or a local file path.
Default
```
empty string for all urls
```
- OptionalfallbackUrl?: string
- OptionalwasmBinaryUrl?: string
- OptionalwasmUrl?: string
OptionaldefaultNumWorkers?: number
Default number of workers to create when creating the draco compression object
Default
```
defer to babylon.js
```

See

https://doc.babylonjs.com/typedoc/classes/BABYLON.DracoCompression

`Optional`enableDragAndDrop

enableDragAndDrop?: boolean

Whether to enable drag and drop feature. When enabled, users are able to drag and drop their local model files to the viewer.

Default

false

`Optional`engineConfig

engineConfig?: {
    antialiasing?: boolean;
    disableResize?: boolean;
    engineOptions?: EngineOptions;
    useNullEngine?: boolean;
}

Engine configuration

Type declaration

Optionalantialiasing?: boolean
Whether to enable antialiasing
Default
```
true
```
OptionaldisableResize?: boolean
Whether to disable handling 'resize' event
Default
```
false
```
OptionalengineOptions?: EngineOptions
Interface defining initialization parameters for Engine class
OptionaluseNullEngine?: boolean
Whether to use NullEngine which provides support for headless version of babylon.js. This can be used in server side scenario or for testing purposes.
See
https://doc.babylonjs.com/typedoc/classes/BABYLON.NullEngine
Default
```
false
```

`Optional`extensionConfig

extensionConfig?: object

Extension configuration

`Optional`ktx2Decoder

ktx2Decoder?: {
    defaultNumWorkers?: number;
    urlConfig?: {
        jsDecoderModule: string;
        jsMSCTranscoder: null | string;
        wasmMSCTranscoder: null | string;
        wasmUASTCToASTC: null | string;
        wasmUASTCToBC7: null | string;
        wasmUASTCToR8_UNORM: null | string;
        wasmUASTCToRG8_UNORM: null | string;
        wasmUASTCToRGBA_SRGB: null | string;
        wasmUASTCToRGBA_UNORM: null | string;
        wasmZSTDDecoder: null | string;
    };
}

Khronos Texture Extension 2 (KTX2) decoder configuration

Type declaration

OptionaldefaultNumWorkers?: number
Default number of workers used to handle data decoding
Default
```
defer to babylon.js
```
OptionalurlConfig?: {
    jsDecoderModule: string;
    jsMSCTranscoder: null | string;
    wasmMSCTranscoder: null | string;
    wasmUASTCToASTC: null | string;
    wasmUASTCToBC7: null | string;
    wasmUASTCToR8_UNORM: null | string;
    wasmUASTCToRG8_UNORM: null | string;
    wasmUASTCToRGBA_SRGB: null | string;
    wasmUASTCToRGBA_UNORM: null | string;
    wasmZSTDDecoder: null | string;
}
Define where to find decoders. It can be an external URL or a local file path.
Default
```
empty string or null for all urls
```
- jsDecoderModule: string
- jsMSCTranscoder: null | string
- wasmMSCTranscoder: null | string
- wasmUASTCToASTC: null | string
- wasmUASTCToBC7: null | string
- wasmUASTCToR8_UNORM: null | string
- wasmUASTCToRG8_UNORM: null | string
- wasmUASTCToRGBA_SRGB: null | string
- wasmUASTCToRGBA_UNORM: null | string
- wasmZSTDDecoder: null | string

See

https://doc.babylonjs.com/typedoc/classes/BABYLON.KhronosTextureContainer2

`Optional`lightingConfig

lightingConfig?: LightingConfig

Lighting configuration

`Optional`meshoptCompression

meshoptCompression?: {
    decoder?: {
        url: string;
    };
}

Meshopt compression configuration

Type declaration

Optionaldecoder?: {
url: string;
}
Define where to find decoder file. It can be an external URL or a local file path.
Default
```
empty string for all urls
```
- url: string

See

https://doc.babylonjs.com/typedoc/classes/BABYLON.MeshoptCompression

`Optional`renderingPipelineConfig

renderingPipelineConfig?: RenderingPipelineConfig

Rendering pipeline configuration

`Optional`sceneConfig

sceneConfig?: SceneConfig

Scene configuration

Interface Config

Index

Properties

Properties

Optional3dCommerceCertified

See

Default

OptionalbasisTranscoder

Type declaration

OptionalurlConfig?: { jsModuleUrl?: string; wasmModuleUrl?: string; }

Default

OptionaljsModuleUrl?: string

OptionalwasmModuleUrl?: string

See

OptionalcameraConfig

Default

OptionaldracoCompression

Type declaration

Optionaldecoders?: { fallbackUrl?: string; wasmBinaryUrl?: string; wasmUrl?: string; }

Default

OptionalfallbackUrl?: string

OptionalwasmBinaryUrl?: string

OptionalwasmUrl?: string

OptionaldefaultNumWorkers?: number

Default

See

OptionalenableDragAndDrop

Default

OptionalengineConfig

Type declaration

Optionalantialiasing?: boolean

Default

OptionaldisableResize?: boolean

Default

OptionalengineOptions?: EngineOptions

OptionaluseNullEngine?: boolean

See

Default

OptionalextensionConfig

Optionalktx2Decoder

Type declaration

OptionaldefaultNumWorkers?: number

Default

Default

jsDecoderModule: string

jsMSCTranscoder: null | string

wasmMSCTranscoder: null | string

wasmUASTCToASTC: null | string

wasmUASTCToBC7: null | string

wasmUASTCToR8_UNORM: null | string

wasmUASTCToRG8_UNORM: null | string

wasmUASTCToRGBA_SRGB: null | string

wasmUASTCToRGBA_UNORM: null | string

wasmZSTDDecoder: null | string

See

OptionallightingConfig

OptionalmeshoptCompression

Type declaration

Optionaldecoder?: { url: string; }

Default

url: string

See

OptionalrenderingPipelineConfig

OptionalsceneConfig

Settings

On This Page

`Optional`3dCommerceCertified

`Optional`basisTranscoder

`Optional`urlConfig?: {
jsModuleUrl?: string;
wasmModuleUrl?: string;
}

`Optional`jsModuleUrl?: string

`Optional`wasmModuleUrl?: string

`Optional`cameraConfig

`Optional`dracoCompression

`Optional`decoders?: {
fallbackUrl?: string;
wasmBinaryUrl?: string;
wasmUrl?: string;
}

`Optional`fallbackUrl?: string

`Optional`wasmBinaryUrl?: string

`Optional`wasmUrl?: string

`Optional`defaultNumWorkers?: number

`Optional`enableDragAndDrop

`Optional`engineConfig

`Optional`antialiasing?: boolean

`Optional`disableResize?: boolean

`Optional`engineOptions?: EngineOptions

`Optional`useNullEngine?: boolean

`Optional`extensionConfig

`Optional`ktx2Decoder

`Optional`defaultNumWorkers?: number

`Optional`lightingConfig

`Optional`meshoptCompression

`Optional`decoder?: {
url: string;
}

`Optional`renderingPipelineConfig

`Optional`sceneConfig