Class NodeRenderGraphBlock

constructor

• new NodeRenderGraphBlock(
      name: string,
      frameGraph: FrameGraph,
      scene: Scene,
      ..._additionalConstructionParameters: unknown[],
  ): NodeRenderGraphBlock

  Creates a new NodeRenderGraphBlock

  Parameters

  • name: string

    defines the block name

  • frameGraph: FrameGraph

    defines the hosting frame graph

  • scene: Scene

    defines the hosting scene

  • ..._additionalConstructionParameters: unknown[]

    defines additional parameters to pass to the block constructor

  Returns NodeRenderGraphBlock

comments

onBuildObservable

uniqueId

visibleOnFrame

disabled

• get disabled(): boolean

  Gets or sets the disable flag of the task associated with this block

  Returns boolean

• set disabled(value: boolean): void

  Parameters

  • value: boolean

  Returns void

inputs

• get inputs(): NodeRenderGraphConnectionPoint[]

  Gets the list of input points

  Returns NodeRenderGraphConnectionPoint[]

isDebug

• get isDebug(): boolean

  Gets a boolean indicating if this block is a debug block

  Returns boolean

isInput

• get isInput(): boolean

  Gets a boolean indicating if this block is an input

  Returns boolean

isTeleportIn

• get isTeleportIn(): boolean

  Gets a boolean indicating if this block is a teleport in

  Returns boolean

isTeleportOut

• get isTeleportOut(): boolean

  Gets a boolean indicating if this block is a teleport out

  Returns boolean

isUnique

• get isUnique(): boolean

  Gets a boolean indicating that this block can only be used once per node render graph

  Returns boolean

name

• get name(): string

  Gets or set the name of the block

  Returns string

• set name(value: string): void

  Parameters

  • value: string

  Returns void

outputs

• get outputs(): NodeRenderGraphConnectionPoint[]

  Gets the list of output points

  Returns NodeRenderGraphConnectionPoint[]

task

• get task(): any

  Gets the frame graph task associated with this block

  Returns any

autoConfigure

• autoConfigure(): void

  Lets the block try to connect some inputs automatically

  Returns void

build

• build(state: NodeRenderGraphBuildState): boolean

  Build the current node and generate the vertex data

  Parameters

  • state: NodeRenderGraphBuildState

    defines the current generation state

  Returns boolean

  true if already built

clone

• clone(): NodeRenderGraphBlock | null

  Clone the current block to a new identical block

  Returns NodeRenderGraphBlock | null

  a copy of the current block

dispose

• dispose(): void

  Release resources

  Returns void

getClassName

• getClassName(): string

  Gets the current class name e.g. "NodeRenderGraphBlock"

  Returns string

  the class name

getDescendantOfPredicate

• getDescendantOfPredicate(
      predicate: (block: NodeRenderGraphBlock) => boolean,
  ): Nullable<NodeRenderGraphBlock>

  Get the first descendant using a predicate

  Parameters

  • predicate: (block: NodeRenderGraphBlock) => boolean

    defines the predicate to check

  Returns Nullable<NodeRenderGraphBlock>

  descendant or null if none found

getInputByName

• getInputByName(name: string): NodeRenderGraphConnectionPoint | null

  Find an input by its name

  Parameters

  • name: string

    defines the name of the input to look for

  Returns NodeRenderGraphConnectionPoint | null

  the input or null if not found

getOutputByName

• getOutputByName(name: string): NodeRenderGraphConnectionPoint | null

  Find an output by its name

  Parameters

  • name: string

    defines the name of the output to look for

  Returns NodeRenderGraphConnectionPoint | null

  the output or null if not found

initialize

• initialize(): void

  Initialize the block and prepare the context for build

  Returns void

isAnAncestorOf

• isAnAncestorOf(block: NodeRenderGraphBlock): boolean

  Checks if the current block is an ancestor of a given block

  Parameters

  • block: NodeRenderGraphBlock

    defines the potential descendant block to check

  Returns boolean

  true if block is a descendant

isAnAncestorOfType

• isAnAncestorOfType(type: string): boolean

  Checks if the current block is an ancestor of a given type

  Parameters

  • type: string

    defines the potential type to check

  Returns boolean

  true if block is a descendant

registerInput

• registerInput(
      name: string,
      type: NodeRenderGraphBlockConnectionPointTypes,
      isOptional?: boolean,
      point?: NodeRenderGraphConnectionPoint,
  ): NodeRenderGraphBlock

  Register a new input. Must be called inside a block constructor

  Parameters

  • name: string

    defines the connection point name

  • type: NodeRenderGraphBlockConnectionPointTypes

    defines the connection point type

  • isOptional: boolean = false

    defines a boolean indicating that this input can be omitted

  • Optionalpoint: NodeRenderGraphConnectionPoint

    an already created connection point. If not provided, create a new one

  Returns NodeRenderGraphBlock

  the current block

registerOutput

• registerOutput(
      name: string,
      type: NodeRenderGraphBlockConnectionPointTypes,
      point?: NodeRenderGraphConnectionPoint,
  ): NodeRenderGraphBlock

  Register a new output. Must be called inside a block constructor

  Parameters

  • name: string

    defines the connection point name

  • type: NodeRenderGraphBlockConnectionPointTypes

    defines the connection point type

  • Optionalpoint: NodeRenderGraphConnectionPoint

    an already created connection point. If not provided, create a new one

  Returns NodeRenderGraphBlock

  the current block

serialize

• serialize(): any

  Serializes this block in a JSON representation

  Returns any

  the serialized block object