Class ShadowStage

Shadow map render stage

Hierarchy

RenderStage
- ShadowStage

Index

Properties

Accessors

Methods

Object literals

initInfo

Properties

Private _additiveShadowQueue

_additiveShadowQueue: RenderShadowMapBatchedQueue

Protected _flow

_flow: RenderFlow

Private _light

_light: Light | null = null

Protected _name

_name: string = ""

Name

Protected _pipeline

_pipeline: RenderPipeline

Protected _priority

_priority: number = 0

Priority

Private _renderArea

_renderArea: Rect = new Rect()

Private _shadowFrameBuffer

_shadowFrameBuffer: Framebuffer | null = null

Protected _tag

_tag: number = 0

Type

Accessors

name

get name(): string

Inherited from RenderStage.name
- Defined in cocos/core/pipeline/render-stage.ts:62
Name of the current stage

Returns string

priority

get priority(): number

Inherited from RenderStage.priority
- Defined in cocos/core/pipeline/render-stage.ts:70
Priority of the current stage

Returns number

tag

get tag(): number

Inherited from RenderStage.tag
- Defined in cocos/core/pipeline/render-stage.ts:78
Tag of the current stage

Returns number

Methods

activate

activate(pipeline: ForwardPipeline, flow: ShadowFlow): void

Overrides RenderStage.activate
- Defined in cocos/core/pipeline/shadow/shadow-stage.ts:121
Parameters
- pipeline: ForwardPipeline
- flow: ShadowFlow
Returns void

clearFramebuffer

clearFramebuffer(camera: Camera): void

- Defined in cocos/core/pipeline/shadow/shadow-stage.ts:80
Parameters
- camera: Camera
Returns void

destroy

destroy(): void

Overrides RenderStage.destroy
- Defined in cocos/core/pipeline/shadow/shadow-stage.ts:76
Returns void

initialize

initialize(info: IRenderStageInfo): boolean

Inherited from RenderStage.initialize
- Defined in cocos/core/pipeline/render-stage.ts:113
The initialization process, user shouldn't use it in most case, only useful when need to generate render pipeline programmatically.

Parameters
- info: IRenderStageInfo
  
  The render stage information
Returns boolean

render

render(camera: Camera): void

Overrides RenderStage.render
- Defined in cocos/core/pipeline/shadow/shadow-stage.ts:92
Parameters
- camera: Camera
Returns void

setUsage

setUsage(light: Light, shadowFrameBuffer: Framebuffer): void

- Defined in cocos/core/pipeline/shadow/shadow-stage.ts:66
Sets the frame buffer for shadow map

Parameters
- light: Light
- shadowFrameBuffer: Framebuffer
Returns void

Object literals

Static initInfo

initInfo: object

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

name

name: string = "ShadowStage"

priority

priority: ForwardStagePriority = ForwardStagePriority.FORWARD

tag

tag: number = 0

Generated using TypeDoc