Documentation

# Class: ScreenSpaceShadowMapPass

configurator-core/src/roomle-configurator..ScreenSpaceShadowMapPass

# Hierarchy

# Table of contents

# Constructors

# Properties

# Accessors

# Methods

# Constructors

# constructor

• new ScreenSpaceShadowMapPass(renderPassManager, viewportSize, parameters)

# Parameters

Name Type
renderPassManager RenderPassManager
viewportSize Vector2
parameters ScreenSpaceShadowMapConstructorParameters

# Overrides

RenderPass.constructor

# Defined in

packages/common-core/src/webgl/renderer/pass/screen-space-shadow-map-pass.ts:147 (opens new window)

# Properties

# castShadow

• castShadow: boolean

# Defined in

packages/common-core/src/webgl/renderer/pass/screen-space-shadow-map-pass.ts:135 (opens new window)

# drawGround

• drawGround: boolean = true

# Defined in

packages/common-core/src/webgl/renderer/pass/screen-space-shadow-map-pass.ts:125 (opens new window)

# needsUpdate

• needsUpdate: boolean = false

# Defined in

packages/common-core/src/webgl/renderer/pass/screen-space-shadow-map-pass.ts:124 (opens new window)

# parameters

• parameters: ScreenSpaceShadowMapParameters

# Defined in

packages/common-core/src/webgl/renderer/pass/screen-space-shadow-map-pass.ts:123 (opens new window)

# shadowConfiguration

• shadowConfiguration: ShadowTypeConfiguration

# Defined in

packages/common-core/src/webgl/renderer/pass/screen-space-shadow-map-pass.ts:127 (opens new window)

# shadowTypeNeedsUpdate

• shadowTypeNeedsUpdate: boolean = true

# Defined in

packages/common-core/src/webgl/renderer/pass/screen-space-shadow-map-pass.ts:126 (opens new window)

# Accessors

# shadowOnGround

• set shadowOnGround(value): void

# Parameters

Name Type
value boolean

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/pass/screen-space-shadow-map-pass.ts:143 (opens new window)

# shadowTexture

• get shadowTexture(): Texture

# Returns

Texture

# Defined in

packages/common-core/src/webgl/renderer/pass/screen-space-shadow-map-pass.ts:139 (opens new window)

# Methods

# addRectAreaLight

▸ addRectAreaLight(rectAreaLight, parent): void

# Parameters

Name Type
rectAreaLight RectAreaLight
parent Object3D<Object3DEventMap>

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/pass/screen-space-shadow-map-pass.ts:241 (opens new window)

# createShadowFromLightSources

▸ createShadowFromLightSources(parent, lightSources): void

# Parameters

Name Type
parent Object3D<Object3DEventMap>
lightSources LightSource[]

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/pass/screen-space-shadow-map-pass.ts:287 (opens new window)

# dispose

▸ dispose(): void

# Returns

void

# Overrides

RenderPass.dispose

# Defined in

packages/common-core/src/webgl/renderer/pass/screen-space-shadow-map-pass.ts:186 (opens new window)

# findShadowLightSource

▸ findShadowLightSource(lightSource): Light<LightShadow<Camera>>

# Parameters

Name Type
lightSource Light<LightShadow<Camera>>

# Returns

Light<LightShadow<Camera>>

# Defined in

packages/common-core/src/webgl/renderer/pass/screen-space-shadow-map-pass.ts:235 (opens new window)

# forceShadowUpdate

▸ forceShadowUpdate(): void

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/pass/screen-space-shadow-map-pass.ts:223 (opens new window)

# getShadowLightSources

▸ getShadowLightSources(): Light<LightShadow<Camera>>[]

# Returns

Light<LightShadow<Camera>>[]

# Defined in

packages/common-core/src/webgl/renderer/pass/screen-space-shadow-map-pass.ts:228 (opens new window)

# render

▸ render(renderer, _writeBuffer, _readBuffer, _deltaTime, _maskActive): void

# Parameters

Name Type
renderer WebGLRenderer
_writeBuffer WebGLRenderTarget<Texture>
_readBuffer WebGLRenderTarget<Texture>
_deltaTime number
_maskActive boolean

# Returns

void

# Inherited from

RenderPass.render

# Defined in

packages/common-core/src/webgl/renderer/pass/render-pass.ts:40 (opens new window)

# renderPass

▸ renderPass(renderer): void

# Parameters

Name Type
renderer WebGLRenderer

# Returns

void

# Overrides

RenderPass.renderPass

# Defined in

packages/common-core/src/webgl/renderer/pass/screen-space-shadow-map-pass.ts:373 (opens new window)

# setSize

▸ setSize(width, height): void

# Parameters

Name Type
width number
height number

# Returns

void

# Overrides

RenderPass.setSize

# Defined in

packages/common-core/src/webgl/renderer/pass/screen-space-shadow-map-pass.ts:361 (opens new window)

# switchType

▸ switchType(type): boolean

# Parameters

Name Type
type string

# Returns

boolean

# Defined in

packages/common-core/src/webgl/renderer/pass/screen-space-shadow-map-pass.ts:524 (opens new window)

# updateBounds

▸ updateBounds(sceneBounds, scaleShadow): void

# Parameters

Name Type
sceneBounds SceneVolume
scaleShadow number

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/pass/screen-space-shadow-map-pass.ts:201 (opens new window)

# updateParameters

▸ updateParameters(parameters): void

# Parameters

Name Type
parameters ScreenSpaceShadowMapParameters

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/pass/screen-space-shadow-map-pass.ts:193 (opens new window)

# updatePositionAndTarget

▸ updatePositionAndTarget(): void

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/pass/screen-space-shadow-map-pass.ts:369 (opens new window)

# updateRectAreaLights

▸ updateRectAreaLights(rectAreaLights, parent): void

# Parameters

Name Type
rectAreaLights RectAreaLight[]
parent Object3D<Object3DEventMap>

# Returns

void

# Defined in

packages/common-core/src/webgl/renderer/pass/screen-space-shadow-map-pass.ts:255 (opens new window)