Interface ThreeViewerOptions

Options for the ThreeViewer creation.

interface ThreeViewerOptions {
    assetManager?: AssetManagerOptions;
    camera?: {
        controlsMode?: string;
        position?: Vector3;
        target?: Vector3;
    };
    canvas?: HTMLCanvasElement;
    container?: HTMLElement;
    debug?: boolean;
    dropzone?: boolean | DropzonePluginOptions;
    forceZPrepass?: boolean;
    isAntialiased?: boolean;
    load?: {
        background?: null | string | ITexture | IAsset;
        environment?: null | string | ITexture | IAsset;
        src?: ValOrArr<null | string | IAsset>;
    };
    msaa?: boolean;
    onLoad?: ((results) => void);
    plugins?: (IViewerPluginSync<ThreeViewer> | Class<IViewerPluginSync<ThreeViewer>>)[];
    renderScale?: number | "auto";
    rgbm?: boolean;
    screenShader?: TViewerScreenShader;
    tonemap?: boolean;
    useGBufferDepth?: boolean;
    useRgbm?: boolean;
    zPrepass?: boolean;
}

Properties

assetManager? camera? canvas? container? debug? dropzone? forceZPrepass? isAntialiased? load? msaa? onLoad? plugins? renderScale? rgbm? screenShader? tonemap? useGBufferDepth? useRgbm? zPrepass?

Properties

Optional assetManager

assetManager?: AssetManagerOptions

Options for the asset manager.

Optional camera

camera?: {
    controlsMode?: string;
    position?: Vector3;
    target?: Vector3;
}

Type declaration

  • Optional controlsMode?: string
  • Optional position?: Vector3
  • Optional target?: Vector3

Optional canvas

canvas?: HTMLCanvasElement

The canvas element to use for rendering. Only one of container and canvas must be specified.

Optional container

container?: HTMLElement

The container for the canvas. A new canvas will be created in this container. Only one of container and canvas must be specified.

Optional debug

debug?: boolean

Optional dropzone

dropzone?: boolean | DropzonePluginOptions

Add the dropzone plugin to the viewer, allowing to drag and drop files into the viewer over the canvas/container. Set to true/false to enable/disable the plugin, or pass options to configure the plugin. Assuming true if options are passed.

Default

- false

Optional forceZPrepass

forceZPrepass?: boolean

Force z-prepass even if there are transparent/transmissive objects with render to depth buffer enabled.

Optional isAntialiased

isAntialiased?: boolean

Deprecated

use msaa instead

Optional load

load?: {
    background?: null | string | ITexture | IAsset;
    environment?: null | string | ITexture | IAsset;
    src?: ValOrArr<null | string | IAsset>;
}

Type declaration

  • Optional background?: null | string | ITexture | IAsset

    Load background map

  • Optional environment?: null | string | ITexture | IAsset

    Load environment map

  • Optional src?: ValOrArr<null | string | IAsset>

    Load one or more source files

Optional msaa

msaa?: boolean

Use MSAA.

Optional onLoad

onLoad?: ((results) => void)

Type declaration

    • (results): void

    • Parameters

      • results: any

      Returns void

Optional plugins

plugins?: (IViewerPluginSync<ThreeViewer> | Class<IViewerPluginSync<ThreeViewer>>)[]

Add initial plugins.

Optional renderScale

renderScale?: number | "auto"

Optional rgbm

rgbm?: boolean

Use Uint8 RGBM HDR Render Pipeline. Provides better performance with post-processing. RenderManager Uses Half-float if set to false.

Optional screenShader

screenShader?: TViewerScreenShader

The fragment shader snippet to render on screen.

Optional tonemap

tonemap?: boolean

TonemapPlugin is added to the viewer if this is true.

Default

true

Optional useGBufferDepth

useGBufferDepth?: boolean

Deprecated

use zPrepass instead

Optional useRgbm

useRgbm?: boolean

Deprecated

use rgbm instead

Optional zPrepass

zPrepass?: boolean

Use rendered gbuffer as depth-prepass / z-prepass. (Requires DepthBufferPlugin/GBufferPlugin) todo: It will be disabled when there are any transparent/transmissive objects with render to depth buffer enabled.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc