Class UIFlow

The UI render flow

Hierarchy

RenderFlow
- UIFlow

Index

Properties

Accessors

Methods

Object literals

initInfo

Properties

Protected _name

_name: string = ""

Protected _pipeline

_pipeline: RenderPipeline

Protected _priority

_priority: number = 0

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:31
The name of the render flow

Returns string

priority

get priority(): number

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

Returns number

stages

get stages(): RenderStage[]

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

readonly

Returns RenderStage[]

tag

get tag(): number

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

Returns number

Methods

activate

activate(pipeline: RenderPipeline): void

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

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

destroy

destroy(): void

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

initialize

initialize(info: IRenderFlowInfo): boolean

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

render

render(view: RenderView): void

Overrides RenderFlow.render
- Defined in cocos/core/pipeline/ui/ui-flow.ts:41
Parameters
- view: RenderView
Returns void

Object literals

Static initInfo

initInfo: object

name

name: string = "UIFlow"

priority

priority: ForwardFlowPriority = ForwardFlowPriority.UI

tag

tag: RenderFlowTag = RenderFlowTag.UI

Generated using TypeDoc