Interface WebGLOptions

WebGL renderer options

Export

SceneRendererOptions

Date

2023.12.26

Author

yisky

interface WebGLOptions {
    alpha?: boolean;
    antialias?: boolean;
    canvas?: HTMLCanvasElement | OffscreenCanvas;
    clearAlpha?: number;
    clearColor?: ColorRepresentation;
    context?: WebGLRenderingContext;
    depth?: boolean;
    failIfMajorPerformanceCaveat?: boolean;
    localClippingEnabled?: boolean;
    logarithmicDepthBuffer?: boolean;
    outputColorSpace?: ColorSpace;
    pixelRatio?: number;
    powerPreference?: string;
    precision?: string;
    premultipliedAlpha?: boolean;
    preserveDrawingBuffer?: boolean;
    shadowMap?: {
        autoUpdate?: boolean;
        enabled?: boolean;
        needsUpdate?: boolean;
        softShadow?: SoftShadowOptions;
        type?: ShadowMapType;
    };
    stencil?: boolean;
    toneMapping?: ToneMapping;
    toneMappingExposure?: number;
    viewport?: HTMLDivElement;
}

Hierarchy

  • WebGLRendererParameters
    • WebGLOptions

Properties

alpha? antialias? canvas? clearAlpha? clearColor? context? depth? failIfMajorPerformanceCaveat? localClippingEnabled? logarithmicDepthBuffer? outputColorSpace? pixelRatio? powerPreference? precision? premultipliedAlpha? preserveDrawingBuffer? shadowMap? stencil? toneMapping? toneMappingExposure? viewport?

Properties

Optionalalpha

alpha?: boolean

default is false.

Optionalantialias

antialias?: boolean

default is false.

Optionalcanvas

canvas?: HTMLCanvasElement | OffscreenCanvas

A Canvas where the renderer draws its output.

OptionalclearAlpha

clearAlpha?: number

Clear alpha, default is 1.0

Memberof

SceneRendererOptions

OptionalclearColor

clearColor?: ColorRepresentation

Clear color, default is '#f0fff0'

Memberof

SceneRendererOptions

Optionalcontext

context?: WebGLRenderingContext

A WebGL Rendering Context. (https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext) Default is null

Optionaldepth

depth?: boolean

default is true.

OptionalfailIfMajorPerformanceCaveat

failIfMajorPerformanceCaveat?: boolean

default is false.

OptionallocalClippingEnabled

localClippingEnabled?: boolean

Whether to enable local clipping, default is false

Memberof

SceneRendererOptions

OptionallogarithmicDepthBuffer

logarithmicDepthBuffer?: boolean

default is false.

OptionaloutputColorSpace

outputColorSpace?: ColorSpace

Output color space

Memberof

SceneRendererOptions

OptionalpixelRatio

pixelRatio?: number

Pixel ratio, default is window.devicePixelRatio

Memberof

SceneRendererOptions

OptionalpowerPreference

powerPreference?: string

Can be "high-performance", "low-power" or "default"

Optionalprecision

precision?: string

shader precision. Can be "highp", "mediump" or "lowp".

OptionalpremultipliedAlpha

premultipliedAlpha?: boolean

default is true.

OptionalpreserveDrawingBuffer

preserveDrawingBuffer?: boolean

default is false.

OptionalshadowMap

shadowMap?: {
    autoUpdate?: boolean;
    enabled?: boolean;
    needsUpdate?: boolean;
    softShadow?: SoftShadowOptions;
    type?: ShadowMapType;
}

Shadow map options, default is { enabled: false, autoUpdate: true, needsUpdate: false, softShadow: undefined, type: PCFSoftShadowMap }

Memberof

WebGLOptions

Optionalstencil

stencil?: boolean

default is false.

OptionaltoneMapping

toneMapping?: ToneMapping

ToneMapping type, default is NoToneMapping

Memberof

SceneRendererOptions

OptionaltoneMappingExposure

toneMappingExposure?: number

ToneMapping exposure, default is 1.0

Memberof

SceneRendererOptions

Optionalviewport

viewport?: HTMLDivElement

Rendering viewport, the div that will contain the render canvas, default is document.body

Memberof

SceneRendererOptions

Settings

Member Visibility

On This Page

Properties