Class RGRenderNode<TInputs>

渲染节点。

Type parameters

TInputs: {} = {}

Hierarchy

RGNode<TInputs & { camera: "Camera"; lightList: "LightList"; meshList: "MeshList"; renderTarget: "RenderTarget" }, "RenderTarget", IRGRenderNodeOptions<TInputs>>
- RGRenderNode
  - RGLightNode
  - RGFARenderNode

Index

Constructors

constructor

Events

Properties

Accessors

Methods

Constructors

constructor

new RGRenderNode<TInputs>(_parent: RenderGraph<any>, _id: number, _name: string, _options: IRGRenderNodeOptions<TInputs>): RGRenderNode<TInputs>

Inherited from RGNode.constructor
- Defined in src/engine/render-graph/RGNode.ts:121
不要直接调用，请使用renderGraph.createNode方法。

Type parameters
- TInputs: {} = {}
Parameters
- _parent: RenderGraph<any>
- _id: number
- _name: string
- _options: IRGRenderNodeOptions<TInputs>
Returns RGRenderNode<TInputs>

Events

onActive

onActive(context: RenderSystem, options: IRGRenderNodeOptions<TInputs>): void

Inherited from RGNode.onActive
- Defined in src/engine/render-graph/buildinRGNodes/core.ts:197
节点在真正被第一次使用时的回调。

Parameters
- context: RenderSystem
- options: IRGRenderNodeOptions<TInputs>
Returns void

onDisable

onDisable(): void

Inherited from RGNode.onDisable
- Defined in src/engine/render-graph/buildinRGNodes/core.ts:257
节点在被图中移除时的回调。

Returns void

onExecute

onExecute(context: RenderSystem, options: IRGRenderNodeOptions<TInputs>): void

Inherited from RGNode.onExecute
- Defined in src/engine/render-graph/buildinRGNodes/core.ts:201
节点在每帧执行时的回调。

Parameters
- context: RenderSystem
- options: IRGRenderNodeOptions<TInputs>
Returns void

onInit

onInit(options: IRGRenderNodeOptions<TInputs>): void

Inherited from RGNode.onInit
- Defined in src/engine/render-graph/buildinRGNodes/core.ts:193
节点初始化后的回调。

Parameters
- options: IRGRenderNodeOptions<TInputs>
Returns void

onRender

onRender(context: RenderSystem, options: IRGRenderNodeOptions<TInputs>): void

- Defined in src/engine/render-graph/buildinRGNodes/core.ts:237
渲染回调，如果要继承可以重写此方法。

Parameters
- context: RenderSystem
- options: IRGRenderNodeOptions<TInputs>
Returns void

Properties

inputTypes

inputTypes: any

节点输入的数据类型。

outputType

outputType: "RenderTarget" = 'RenderTarget'

节点输出的数据类型。

type

type: ERGNodeType = ...

Accessors

game

get game(): Game

- Defined in src/engine/render-graph/RGNode.ts:107
获取当前游戏实例。

Returns Game

id

get id(): number

- Defined in src/engine/render-graph/RGNode.ts:100
节点id。

Returns number

name

get name(): string

- Defined in src/engine/render-graph/RGNode.ts:93
节点名字。

Returns string

options

get options(): IOptions

- Defined in src/engine/render-graph/RGNode.ts:86
节点的初始化配置参数。

Returns IOptions

output

get output(): IRGData[TOutput]

- Defined in src/engine/render-graph/RGNode.ts:114
获取当前节点输出。

Returns IRGData[TOutput]

Methods

getInput

getInput<TKey>(key: TKey): IRGData[TInputs & { camera: "Camera"; lightList: "LightList"; meshList: "MeshList"; renderTarget: "RenderTarget" }[TKey]]

Inherited from RGNode.getInput
- Defined in src/engine/render-graph/RGNode.ts:140
获取某个节点的输入。

Type parameters
- TKey: string | number | symbol
Parameters
- key: TKey
Returns IRGData[TInputs & { camera: "Camera"; lightList: "LightList"; meshList: "MeshList"; renderTarget: "RenderTarget" }[TKey]]

reset

reset(): void

Inherited from RGNode.reset
- Defined in src/engine/render-graph/RGNode.ts:206
重置节点状态，清空输入，一般用于可缓存的节点优化。

Returns void

Generated using TypeDoc