Class ForwardBaseRG

默认的内置前向渲染管线。
实际上包含了Forward Add部分。

Hierarchy

RenderGraph
- ForwardBaseRG

Index

Constructors

constructor

Events

Accessors

Methods

Constructors

constructor

new ForwardBaseRG(_name: string, _options: any): ForwardBaseRG

Inherited from RenderGraph.constructor
- Defined in src/engine/render-graph/RenderGraph.ts:58
Parameters
- _name: string
- _options: any
Returns ForwardBaseRG

Events

onActive

onActive(context: RenderSystem): void

Inherited from RenderGraph.onActive
- Defined in src/engine/render-graph/internal/ForwardBaseRG.ts:75
图在被第一次真正使用时的回调。

Parameters
- context: RenderSystem
Returns void

onCamerasChange

onCamerasChange(cameras: default[], changeCameras: default[]): void

Inherited from RenderGraph.onCamerasChange
- Defined in src/engine/render-graph/internal/ForwardBaseRG.ts:98
在渲染上下文中的相机改变时调用，一般用于重新构建图。

Parameters
- cameras: default[]
- changeCameras: default[]
Returns void

onDisable

onDisable(context: RenderSystem): void

Inherited from RenderGraph.onDisable
- Defined in src/engine/render-graph/internal/ForwardBaseRG.ts:241
在图不再使用时调用。

Parameters
- context: RenderSystem
Returns void

onExecuteBegin

onExecuteBegin(context: RenderSystem): void

Inherited from RenderGraph.onExecuteBegin
- Defined in src/engine/render-graph/internal/ForwardBaseRG.ts:161
在图每帧执行前调用。

Parameters
- context: RenderSystem
Returns void

onExecuteDone

onExecuteDone(context: RenderSystem): void

Inherited from RenderGraph.onExecuteDone
- Defined in src/engine/render-graph/internal/ForwardBaseRG.ts:214
在图每帧执行后调用。

Parameters
- context: RenderSystem
Returns void

Accessors

context

get context(): RenderSystem

- Defined in src/engine/render-graph/RenderGraph.ts:54
当前的渲染上下文。

Returns RenderSystem

game

get game(): Game

- Defined in src/engine/render-graph/RenderGraph.ts:47
当前正在运行的Game实例。

Returns Game

name

get name(): string

- Defined in src/engine/render-graph/RenderGraph.ts:40
图名字。

Returns string

Methods

connect

connect<TToNode>(from: TRGNodeAny, to: TToNode, inputKey?: keyof TToNode["inputTypes"]): void

Inherited from RenderGraph.connect
- Defined in src/engine/render-graph/RenderGraph.ts:110
连接两个节点。

Type parameters
- TToNode: RGNode<any, any, any, TToNode>
Parameters
- from: TRGNodeAny
- to: TToNode
- Optional inputKey: keyof TToNode["inputTypes"]
  
  需要将from节点的输出连接到哪个to节点的输入。
Returns void

createNode

createNode<TRGNode>(name: string, clz: new (...args: any) => TRGNode, options: TRGNode["options"]): TRGNode

Inherited from RenderGraph.createNode
- Defined in src/engine/render-graph/RenderGraph.ts:66
创建一个节点。

Type parameters
- TRGNode: RGNode<any, any, any, TRGNode>
Parameters
- name: string
- clz: new (...args: any) => TRGNode
  - - new (...args: any): TRGNode
    - Parameters
      - Rest ...args: any
      Returns TRGNode
- options: TRGNode["options"]
Returns TRGNode

destroyNode

destroyNode(rgNode: TRGNodeAny): void

Inherited from RenderGraph.destroyNode
- Defined in src/engine/render-graph/RenderGraph.ts:92
销毁一个节点。

Parameters
- rgNode: TRGNodeAny
Returns void

disconnect

disconnect(from: TRGNodeAny, to: TRGNodeAny): void

Inherited from RenderGraph.disconnect
- Defined in src/engine/render-graph/RenderGraph.ts:132
断开两个节点的连接。

Parameters
- from: TRGNodeAny
- to: TRGNodeAny
Returns void

showDebugInfo

showDebugInfo(callback?: (digraph: IDigraphNode[], sorted: TRGNodeAny[]) => void): string

Inherited from RenderGraph.showDebugInfo
- Defined in src/engine/render-graph/RenderGraph.ts:319
Parameters
- Optional callback: (digraph: IDigraphNode[], sorted: TRGNodeAny[]) => void
  - - (digraph: IDigraphNode[], sorted: TRGNodeAny[]): void
    - Parameters
      - digraph: IDigraphNode[]
      - sorted: TRGNodeAny[]
      Returns void
Returns string

Generated using TypeDoc