Interface ProgressiveShadowsOptions

Progressive Shadows component options

Export

ProgressiveShadowsOptions

Date

2024.2.4

Author

yisky

interface ProgressiveShadowsOptions {
    alphaTest?: number;
    blend?: number;
    color?: ColorRepresentation;
    frames?: number;
    height?: number;
    lights?: RandomizedLightOptions;
    lookAt?: Vector3;
    onAfterRender?: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry<NormalBufferAttributes>, material: Material, group: Group<Object3DEventMap>) => void);
    onBeforeRender?: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry<NormalBufferAttributes>, material: Material, group: Group<Object3DEventMap>) => void);
    opacity?: number;
    position?: Vector3;
    quaternion?: Quaternion;
    queryMask?: QueryMask;
    renderOrder?: RenderOrder;
    resolution?: number;
    rotation?: Euler;
    scale?: Vector3;
    userData?: {
        [key: string]: any;
    };
    width?: number;
}

Hierarchy

  • RendererOptions
    • ProgressiveShadowsOptions

Properties

alphaTest? blend? color? frames? height? lights? lookAt? onAfterRender? onBeforeRender? opacity? position? quaternion? queryMask? renderOrder? resolution? rotation? scale? userData? width?

Properties

OptionalalphaTest

alphaTest?: number

Discards alpha pixels, 0.65

Memberof

ProgressiveShadowsOptions

Optionalblend

blend?: number

How much colors turn to black, 0 is back. Default is 2.

Memberof

ProgressiveShadowsOptions

Optionalcolor

color?: ColorRepresentation

Shadow color. Default is black.

Memberof

ProgressiveShadowsOptions

Optionalframes

frames?: number

How many frames it can render, more yields cleaner results but takes more time. Default is 40.

Memberof

ProgressiveShadowsOptions

Optionalheight

height?: number

Shadow cast plane height. Default is 1.

Memberof

ProgressiveShadows

Optionallights

lights?: RandomizedLightOptions

Randomized lights shining from different angles to emulate raycasting.

Memberof

ProgressiveShadowsOptions

OptionallookAt

lookAt?: Vector3

Rotates the object to face a point in world space.

Memberof

LightformerOptions

OptionalonAfterRender

onAfterRender?: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry<NormalBufferAttributes>, material: Material, group: Group<Object3DEventMap>) => void)

After render callback

Memberof

RendererOptions

OptionalonBeforeRender

onBeforeRender?: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry<NormalBufferAttributes>, material: Material, group: Group<Object3DEventMap>) => void)

Before render callback

Memberof

RendererOptions

Optionalopacity

opacity?: number

Opacity of the plane. Default is 1.

Memberof

ProgressiveShadowsOptions

Optionalposition

position?: Vector3

Local Position

Memberof

LightformerOptions

Optionalquaternion

quaternion?: Quaternion

Local quaternion

Memberof

RendererOptions

OptionalqueryMask

queryMask?: QueryMask

Query mask

Memberof

RendererOptions

OptionalrenderOrder

renderOrder?: RenderOrder

Render order

Memberof

RendererOptions

Optionalresolution

resolution?: number

Light map resolution. Default is 1024.

Memberof

ProgressiveShadowsOptions

Optionalrotation

rotation?: Euler

Local rotation

Memberof

LightformerOptions

Optionalscale

scale?: Vector3

Local Scale

Memberof

LightformerOptions

OptionaluserData

userData?: {
    [key: string]: any;
}

The component user data, default is {}

Memberof

ComponentOptions

Optionalwidth

width?: number

Shadow cast plane width. Default is 1.

Memberof

ProgressiveShadowsOptions

Settings

Member Visibility

On This Page

Properties