Interface ContactShadowsOptions

ContactShadows component options

Export

ContactShadowsOptions

Date

2024.1.29

Author

yisky

interface ContactShadowsOptions {
    blur?: number;
    color?: ColorRepresentation;
    depthWrite?: boolean;
    far?: number;
    frames?: number;
    height?: number;
    lookAt?: Vector3;
    near?: number;
    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;
    smooth?: boolean;
    userData?: {
        [key: string]: any;
    };
    width?: number;
}

Hierarchy

  • RendererOptions
    • ContactShadowsOptions

Properties

blur? color? depthWrite? far? frames? height? lookAt? near? onAfterRender? onBeforeRender? opacity? position? quaternion? queryMask? renderOrder? resolution? rotation? scale? smooth? userData? width?

Properties

Optionalblur

blur?: number

Shadow render target blur counts.

Memberof

ContactShadowsOptions

Optionalcolor

color?: ColorRepresentation

Shadow plane color.

Memberof

ContactShadowsOptions

OptionaldepthWrite

depthWrite?: boolean

Whether enable depth write

Memberof

ContactShadowsOptions

Optionalfar

far?: number

Shadow camera frustum far plane

Memberof

ContactShadowsOptions

Optionalframes

frames?: number

Shadow render count.

Memberof

ContactShadowsOptions

Optionalheight

height?: number

Shadow plane height.

Memberof

ContactShadowsOptions

OptionallookAt

lookAt?: Vector3

Rotates the object to face a point in world space.

Memberof

LightformerOptions

Optionalnear

near?: number

Shadow camera frustum near plane.

Memberof

ContactShadowsOptions

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

Shadow plane opacity.

Memberof

ContactShadowsOptions

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

Shadow render target resolution.

Memberof

ContactShadowsOptions

Optionalrotation

rotation?: Euler

Local rotation

Memberof

LightformerOptions

Optionalscale

scale?: Vector3

Local Scale

Memberof

LightformerOptions

Optionalsmooth

smooth?: boolean

Whether to smooth the shadow render target.

Memberof

ContactShadowsOptions

OptionaluserData

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

The component user data, default is {}

Memberof

ComponentOptions

Optionalwidth

width?: number

Shadow plane width.

Memberof

ContactShadowsOptions

Settings

Member Visibility

On This Page

Properties