BabylonPress Lite Viewer - v0.1.0
    Preparing search index...

    Type Alias LiteViewerOptions

    Startup and lifecycle options for LiteViewer.

    type LiteViewerOptions = {
        alphaMode?: LiteViewerAlphaMode;
        autoPlayAnimations?: boolean;
        autoStart?: boolean;
        clearColor?: LiteViewerClearColor;
        lightIntensity?: number;
        onError?: (error: unknown) => void;
        onInitialized?: (details: LiteViewerDetails) => void;
        onLoaded?: (details: LiteViewerDetails) => void;
        source?: LiteViewerSource;
    }
    Index

    Properties

    alphaMode? autoPlayAnimations? autoStart? clearColor? lightIntensity? onError? onInitialized? onLoaded? source?

    Properties

    alphaMode?: LiteViewerAlphaMode

    Canvas alpha compositing mode.

    Defaults to "opaque".

    autoPlayAnimations?: boolean

    Controls whether loaded glTF animation groups start automatically.

    Defaults to true.

    autoStart?: boolean

    Controls whether the render loop starts automatically after initialization.

    Defaults to true. Set this to false when you want to call LiteViewer.start manually.

    clearColor?: LiteViewerClearColor

    Optional scene clear color.

    lightIntensity?: number

    Intensity for the default hemispheric light.

    Defaults to 1.

    onError?: (error: unknown) => void

    Called when initialization or model loading fails.

    onInitialized?: (details: LiteViewerDetails) => void

    Called after the engine, scene, and camera are ready.

    onLoaded?: (details: LiteViewerDetails) => void

    Called after a model has been loaded and added to the scene.

    source?: LiteViewerSource

    Optional model to load during initialization.

    Settings

    Member Visibility

    On This Page

    Properties