UIStage | Creator3dAPI

UI渲阶段。

Hierarchy

RenderStage
- UIStage

Index

Constructors

constructor

Properties

Accessors

Methods

Object literals

initInfo

Constructors

constructor

new UIStage(): UIStage

Overrides RenderStage.constructor
- Defined in cocos/core/pipeline/ui/ui-stage.ts:29
Returns UIStage

Properties

Protected _clearColors

_clearColors: IGFXColor[] | null = null

清空颜色数组。

Protected _clearDepth

_clearDepth: number = 1

清空深度。

Protected _clearStencil

_clearStencil: number = 0

清空模板。

Protected _cmdBuff

_cmdBuff: GFXCommandBuffer | null = null

命令缓冲。

Protected _device

_device: GFXDevice | null = null

GFX设备。

Protected _flow

_flow: RenderFlow = null!

渲染流程。

Protected _framebuffer

_framebuffer: GFXFramebuffer | null = null

渲染流程。

Protected _name

_name: string = ""

名称。

Protected _pass

_pass: Pass | null = null

着色过程。

Protected _pipeline

_pipeline: RenderPipeline = null!

渲染管线。

Protected _priority

_priority: number = 0

优先级。

Protected _pso

_pso: GFXPipelineState | null = null

GFX管线状态。

Protected _renderArea

_renderArea: IGFXRect | null = null

渲染区域。

Protected _renderQueues

_renderQueues: RenderQueue[] = []

Protected frameBuffer

frameBuffer: string = ""

Protected renderQueues

renderQueues: RenderQueueDesc[] = []

Accessors

flow

get flow(): RenderFlow

Inherited from RenderStage.flow
- Defined in cocos/core/pipeline/render-stage.ts:66
渲染流程。

Returns RenderFlow

framebuffer

get framebuffer(): GFXFramebuffer | null

Inherited from RenderStage.framebuffer
- Defined in cocos/core/pipeline/render-stage.ts:90
渲染流程。

Returns GFXFramebuffer | null

pipeline

get pipeline(): RenderPipeline

Inherited from RenderStage.pipeline
- Defined in cocos/core/pipeline/render-stage.ts:74
渲染管线。

Returns RenderPipeline

priority

get priority(): number

Inherited from RenderStage.priority
- Defined in cocos/core/pipeline/render-stage.ts:82
优先级。

Returns number

Methods

activate

activate(flow: RenderFlow): void

Overrides RenderStage.activate
- Defined in cocos/core/pipeline/ui/ui-stage.ts:35
Parameters
- flow: RenderFlow
Returns void

createCmdBuffer

createCmdBuffer(): void

Inherited from RenderStage.createCmdBuffer
- Defined in cocos/core/pipeline/render-stage.ts:393
Returns void

destroy

destroy(): void

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

executeCommandBuffer

executeCommandBuffer(view: RenderView): void

Inherited from RenderStage.executeCommandBuffer
- Defined in cocos/core/pipeline/render-stage.ts:358
Parameters
- view: RenderView
Returns void

initialize

initialize(info: IRenderStageInfo): boolean

Inherited from RenderStage.initialize
- Defined in cocos/core/pipeline/render-stage.ts:207
初始化函数，用于不从资源加载RenderPipeline时使用。

Parameters
- info: IRenderStageInfo
  
  渲染阶段描述信息。
Returns boolean

rebuild

rebuild(): void

Overrides RenderStage.rebuild
- Defined in cocos/core/pipeline/ui/ui-stage.ts:54
Returns void

render

render(view: RenderView): void

Overrides RenderStage.render
- Defined in cocos/core/pipeline/ui/ui-stage.ts:57
Parameters
- view: RenderView
Returns void

Protected renderQueueClearFunc

renderQueueClearFunc(rq: RenderQueue): void

Inherited from RenderStage.renderQueueClearFunc
- Defined in cocos/core/pipeline/render-stage.ts:400
Parameters
- rq: RenderQueue
Returns void

Protected renderQueueSortFunc

renderQueueSortFunc(rq: RenderQueue): void

Inherited from RenderStage.renderQueueSortFunc
- Defined in cocos/core/pipeline/render-stage.ts:404
Parameters
- rq: RenderQueue
Returns void

resize

resize(width: number, height: number): void

Overrides RenderStage.resize
- Defined in cocos/core/pipeline/ui/ui-stage.ts:51
Parameters
- width: number
- height: number
Returns void

setClearColor

setClearColor(color: IGFXColor): void

Inherited from RenderStage.setClearColor
- Defined in cocos/core/pipeline/render-stage.ts:301
设置清空颜色。

Parameters
- color: IGFXColor
Returns void

setClearColors

setClearColors(colors: IGFXColor[]): void

Inherited from RenderStage.setClearColors
- Defined in cocos/core/pipeline/render-stage.ts:313
设置清空颜色数组。

Parameters
- colors: IGFXColor[]
Returns void

setClearDepth

setClearDepth(depth: number): void

Inherited from RenderStage.setClearDepth
- Defined in cocos/core/pipeline/render-stage.ts:321
设置清空深度。

Parameters
- depth: number
Returns void

setClearStencil

setClearStencil(stencil: number): void

Inherited from RenderStage.setClearStencil
- Defined in cocos/core/pipeline/render-stage.ts:329
设置清空模板。

Parameters
- stencil: number
Returns void

setRenderArea

setRenderArea(width: number, height: number): void

Inherited from RenderStage.setRenderArea
- Defined in cocos/core/pipeline/render-stage.ts:337
设置渲染区域。

Parameters
- width: number
- height: number
Returns void

sortRenderQueue

sortRenderQueue(): void

Inherited from RenderStage.sortRenderQueue
- Defined in cocos/core/pipeline/render-stage.ts:342
Returns void

Object literals

Static initInfo

initInfo: object

framebuffer

framebuffer: string = "window"

name

name: string = "UIStage"

priority

priority: number = 0

renderQueues

renderQueues: object[] = [{isTransparent: true,stages: ['default'],sortMode: RenderQueueSortMode.BACK_TO_FRONT,}]

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

Returns UIStage

Properties

Protected _clearColors

Protected _clearDepth

Protected _clearStencil

Protected _cmdBuff

Protected _device

Protected _flow

Protected _framebuffer

Protected _name

Protected _pass

Protected _pipeline

Protected _priority

Protected _pso

Protected _renderArea

Protected _renderQueues

Protected frameBuffer

Protected renderQueues

Accessors

flow

Returns RenderFlow

framebuffer

Returns GFXFramebuffer | null

pipeline

Returns RenderPipeline

priority

Returns number

Methods

activate

Parameters

flow: RenderFlow

Returns void

createCmdBuffer

Returns void

destroy

Returns void

executeCommandBuffer

Parameters

view: RenderView

Returns void

initialize

Parameters

info: IRenderStageInfo

Returns boolean

rebuild

Returns void

render

Parameters

view: RenderView

Returns void

Protected renderQueueClearFunc

Parameters

rq: RenderQueue

Returns void

Protected renderQueueSortFunc

Parameters

rq: RenderQueue

Returns void

resize

Parameters

width: number

height: number

Returns void

setClearColor

Parameters

color: IGFXColor

Returns void

setClearColors

Parameters

colors: IGFXColor[]

Returns void