Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RGClearNode

用于清屏的节点。

Hierarchy

  • RGNode<{ camera: "Camera"; renderTarget: "RenderTarget" }, "None", {}>
    • RGClearNode

Index

Constructors

Events

Properties

Accessors

Methods

Constructors

constructor

  • 不要直接调用，请使用renderGraph.createNode方法。

    Parameters

    • _parent: RenderGraph<any>
    • _id: number
    • _name: string
    • _options: {}

    Returns RGClearNode

Events

onActive

  • 节点在真正被第一次使用时的回调。

    Parameters

    Returns void

onDisable

  • 节点在被图中移除时的回调。

    Parameters

    Returns void

onExecute

  • onExecute(context: RenderSystem, options: { lightMode: string }): void

  • 节点在每帧执行时的回调。

    Parameters

    • context: RenderSystem
    • options: { lightMode: string }
      • lightMode: string

    Returns void

onInit

  • onInit(options: {}): void

  • 节点初始化后的回调。

    Parameters

    • options: {}

    Returns void

Properties

inputTypes

inputTypes: { camera: "Camera"; renderTarget: "RenderTarget" } = ...

节点输入的数据类型。

Type declaration

  • camera: "Camera"
  • renderTarget: "RenderTarget"

outputType

outputType: "None" = 'None'

节点输出的数据类型。

type

type: ERGNodeType = ...

Accessors

game

  • 获取当前游戏实例。

    Returns Game

id

  • get id(): number

  • 节点id。

    Returns number

name

  • get name(): string

  • 节点名字。

    Returns string

options

  • get options(): IOptions

  • 节点的初始化配置参数。

    Returns IOptions

output

  • get output(): IRGData[TOutput]

  • 获取当前节点输出。

    Returns IRGData[TOutput]

Methods

getInput

  • getInput<TKey>(key: TKey): IRGData[{ camera: "Camera"; renderTarget: "RenderTarget" }[TKey]]

  • 获取某个节点的输入。

    Type parameters

    • TKey: "camera" | "renderTarget"

    Parameters

    • key: TKey

    Returns IRGData[{ camera: "Camera"; renderTarget: "RenderTarget" }[TKey]]

reset

  • reset(): void

  • 重置节点状态，清空输入，一般用于可缓存的节点优化。

    Returns void

Generated using TypeDoc