Class ShadowFlow

Shadow map render flow

Hierarchy

RenderFlow
- ShadowFlow

Index

Properties

Accessors

Methods

Object literals

initInfo

Properties

Protected _name

_name: string = ""

Protected _pipeline

_pipeline: RenderPipeline

Protected _priority

_priority: number = 0

Private _shadowRenderPass

_shadowRenderPass: RenderPass | null = null

Protected _stages

_stages: RenderStage[] = []

Protected _tag

_tag: number = 0

Accessors

name

get name(): string

Inherited from RenderFlow.name
- Defined in cocos/core/pipeline/render-flow.ts:57
The name of the render flow

Returns string

priority

get priority(): number

Inherited from RenderFlow.priority
- Defined in cocos/core/pipeline/render-flow.ts:65
Priority of the current flow

Returns number

stages

get stages(): RenderStage[]

Inherited from RenderFlow.stages
- Defined in cocos/core/pipeline/render-flow.ts:82
The stages of flow.

readonly

Returns RenderStage[]

tag

get tag(): number

Inherited from RenderFlow.tag
- Defined in cocos/core/pipeline/render-flow.ts:73
Tag of the current flow

Returns number

Methods

initShadowFrameBuffer

initShadowFrameBuffer(pipeline: ForwardPipeline, light: Light): void

- Defined in cocos/core/pipeline/shadow/shadow-flow.ts:137
Parameters
- pipeline: ForwardPipeline
- light: Light
Returns void

activate

activate(pipeline: RenderPipeline): void

Inherited from RenderFlow.activate
- Defined in cocos/core/pipeline/render-flow.ts:122
Activate the current render flow in the given pipeline

Parameters
- pipeline: RenderPipeline
  
  The render pipeline to activate this render flow
Returns void

Private clearShadowMap

clearShadowMap(validLights: Light[], camera: Camera): void

- Defined in cocos/core/pipeline/shadow/shadow-flow.ts:191
Parameters
- validLights: Light[]
- camera: Camera
Returns void

destroy

destroy(): void

Overrides RenderFlow.destroy
- Defined in cocos/core/pipeline/shadow/shadow-flow.ts:112
Returns void

initialize

initialize(info: IRenderFlowInfo): boolean

Overrides RenderFlow.initialize
- Defined in cocos/core/pipeline/shadow/shadow-flow.ts:67
Parameters
- info: IRenderFlowInfo
Returns boolean

render

render(camera: Camera): void

Overrides RenderFlow.render
- Defined in cocos/core/pipeline/shadow/shadow-flow.ts:78
Parameters
- camera: Camera
Returns void

Private resizeShadowMap

resizeShadowMap(light: Light, size: Vec2): void

- Defined in cocos/core/pipeline/shadow/shadow-flow.ts:207
Parameters
- light: Light
- size: Vec2
Returns void

Object literals

Static initInfo

initInfo: object

en: A common initialization info for shadow map render flow
zh: 一个通用的 ShadowFlow 的初始化信息对象

name

name: string = PIPELINE_FLOW_SHADOW

priority

priority: ForwardFlowPriority = ForwardFlowPriority.SHADOW

stages

stages: never[] = []

tag

tag: RenderFlowTag = RenderFlowTag.SCENE

Generated using TypeDoc