Interface Settings

interface Settings {
    analyticsEnabled?: boolean;
    animationTime?: number;
    antialias?: boolean;
    background?: BackgroundSetting;
    backgroundAlpha?: number;
    backgroundRotation?: number;
    clippingHighlight?: boolean;
    clippingHighlightColor?: Color;
    color?: Color;
    continuousRendering?: boolean;
    customAngleFormatter?: CustomAngleFormatter;
    customLengthFormatter?: CustomLengthFormatter;
    customSlopeAngleFormatter?: CustomSlopeAngleFormatter;
    darkModeMaterials?: boolean;
    debugRenderVertices?: boolean;
    debugRenderWireframe?: boolean;
    debugVerticesColor?: Color;
    debugWireframeColor?: Color;
    decimals?: number;
    environmentMapColorSpace?: ColorSpace;
    environmentMapExposure?: number;
    environmentMapToneMapping?: ToneMapping;
    environmentMapUrl?: string;
    forceDoubleSideMaterials?: boolean;
    fxaa?: boolean;
    globalOpacity?: number;
    hoverColor?: Color;
    hoverHighlightEnabled?: boolean;
    lengthUnit?: LengthUnit;
    maxGpuMemoryCache?: number;
    maxMemoryCache?: number;
    msaa?: boolean;
    navigationSnapDistance?: number;
    orderIndependentTransparency?: boolean;
    progressiveRendering?: boolean;
    renderEdges?: boolean;
    sandbox?: boolean;
    selectionColor?: Color;
    snapDistance?: number;
    ssao?: boolean;
    staticRootUrl?: string;
    transparencyPeelsCount?: number;
    useWebgpu?: boolean;
    vertexInterpolationMaterials?: boolean;
    xrCompatible?: boolean;
}

Properties

analyticsEnabled? animationTime? antialias? background? backgroundAlpha? backgroundRotation? clippingHighlight? clippingHighlightColor? color? continuousRendering? customAngleFormatter? customLengthFormatter? customSlopeAngleFormatter? darkModeMaterials? debugRenderVertices? debugRenderWireframe? debugVerticesColor? debugWireframeColor? decimals? environmentMapColorSpace? environmentMapExposure? environmentMapToneMapping? environmentMapUrl? forceDoubleSideMaterials? fxaa? globalOpacity? hoverColor? hoverHighlightEnabled? lengthUnit? maxGpuMemoryCache? maxMemoryCache? msaa? navigationSnapDistance? orderIndependentTransparency? progressiveRendering? renderEdges? sandbox? selectionColor? snapDistance? ssao? staticRootUrl? transparencyPeelsCount? useWebgpu? vertexInterpolationMaterials? xrCompatible?

Properties

Optional analyticsEnabled

analyticsEnabled?: boolean

Optional animationTime

animationTime?: number

Optional antialias

antialias?: boolean

Deprecated

use fxaa instead

Optional background

background?: BackgroundSetting

Optional backgroundAlpha

backgroundAlpha?: number

Optional backgroundRotation

backgroundRotation?: number

Optional clippingHighlight

clippingHighlight?: boolean

Optional clippingHighlightColor

clippingHighlightColor?: Color

Optional color

color?: Color

Optional continuousRendering

continuousRendering?: boolean

Optional customAngleFormatter

customAngleFormatter?: CustomAngleFormatter

Optional customLengthFormatter

customLengthFormatter?: CustomLengthFormatter

Optional customSlopeAngleFormatter

customSlopeAngleFormatter?: CustomSlopeAngleFormatter

Optional darkModeMaterials

darkModeMaterials?: boolean

Optional debugRenderVertices

debugRenderVertices?: boolean

Optional debugRenderWireframe

debugRenderWireframe?: boolean

Optional debugVerticesColor

debugVerticesColor?: Color

Optional debugWireframeColor

debugWireframeColor?: Color

Optional decimals

decimals?: number

Optional environmentMapColorSpace

environmentMapColorSpace?: ColorSpace

Optional environmentMapExposure

environmentMapExposure?: number

Optional environmentMapToneMapping

environmentMapToneMapping?: ToneMapping

Optional environmentMapUrl

environmentMapUrl?: string

Optional forceDoubleSideMaterials

forceDoubleSideMaterials?: boolean

Optional fxaa

fxaa?: boolean

Optional globalOpacity

globalOpacity?: number

Optional hoverColor

hoverColor?: Color

Optional hoverHighlightEnabled

hoverHighlightEnabled?: boolean

Optional lengthUnit

lengthUnit?: LengthUnit

Optional maxGpuMemoryCache

maxGpuMemoryCache?: number

Optional maxMemoryCache

maxMemoryCache?: number

Optional msaa

msaa?: boolean

Optional navigationSnapDistance

navigationSnapDistance?: number

Optional orderIndependentTransparency

orderIndependentTransparency?: boolean

Optional progressiveRendering

progressiveRendering?: boolean

Optional renderEdges

renderEdges?: boolean

Optional sandbox

sandbox?: boolean

Optional selectionColor

selectionColor?: Color

Optional snapDistance

snapDistance?: number

Optional ssao

ssao?: boolean

Optional staticRootUrl

staticRootUrl?: string

Optional transparencyPeelsCount

transparencyPeelsCount?: number

Optional useWebgpu

useWebgpu?: boolean

Optional vertexInterpolationMaterials

vertexInterpolationMaterials?: boolean

Optional xrCompatible

xrCompatible?: boolean

Deprecated

dont use, xr mode is switched on automatically, use msaa for antialiasing

Settings

Member Visibility

Theme

On This Page

analyticsEnabledanimationTimeantialiasbackgroundbackgroundAlphabackgroundRotationclippingHighlightclippingHighlightColorcolorcontinuousRenderingcustomAngleFormattercustomLengthFormattercustomSlopeAngleFormatterdarkModeMaterialsdebugRenderVerticesdebugRenderWireframedebugVerticesColordebugWireframeColordecimalsenvironmentMapColorSpaceenvironmentMapExposureenvironmentMapToneMappingenvironmentMapUrlforceDoubleSideMaterialsfxaaglobalOpacityhoverColorhoverHighlightEnabledlengthUnitmaxGpuMemoryCachemaxMemoryCachemsaanavigationSnapDistanceorderIndependentTransparencyprogressiveRenderingrenderEdgessandboxselectionColorsnapDistancessaostaticRootUrltransparencyPeelsCountuseWebgpuvertexInterpolationMaterialsxrCompatible