Class RenderQueue

The render queue. It manages a GFX RenderPass queue which will be executed by the RenderStage.

Hierarchy

RenderQueue

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

newRenderQueue(desc: IRenderQueueDesc): RenderQueue

- Defined in cocos/core/pipeline/render-queue.ts:66
en

Construct a RenderQueue with render queue descriptor

zh

利用渲染队列描述来构造一个 RenderQueue。

Parameters
- desc: IRenderQueueDesc
  
  Render queue descriptor
Returns RenderQueue

Properties

Private _passDesc

_passDesc: IRenderQueueDesc

Private _passPool

_passPool: RecyclePool<IRenderPass>

queue

queue: CachedArray<IRenderPass>

A cached array of render passes

Methods

clear

clear(): void

- Defined in cocos/core/pipeline/render-queue.ts:89
Clear the render queue

Returns void

insertRenderPass

insertRenderPass(renderObj: IRenderObject, subModelIdx: number, passIdx: number): boolean

- Defined in cocos/core/pipeline/render-queue.ts:102
Insert a render pass into the queue

Parameters
- renderObj: IRenderObject
  
  The render object of the pass
- subModelIdx: number
- passIdx: number
  
  The pass id
Returns boolean

Whether the new render pass is successfully added

recordCommandBuffer

recordCommandBuffer(device: Device, renderPass: RenderPass, cmdBuff: CommandBuffer): void

- Defined in cocos/core/pipeline/render-queue.ts:128
Parameters
- device: Device
- renderPass: RenderPass
- cmdBuff: CommandBuffer
Returns void

sort

sort(): void

- Defined in cocos/core/pipeline/render-queue.ts:124
Sort the current queue

Returns void

Generated using TypeDoc