Class NodeRenderGraphObjectRendererBlock

comments

onBuildObservable

uniqueId

visibleOnFrame

camera

• get camera(): NodeRenderGraphConnectionPoint

  Gets the camera input component

  Returns NodeRenderGraphConnectionPoint

dependencies

• get dependencies(): NodeRenderGraphConnectionPoint

  Gets the dependencies input component

  Returns NodeRenderGraphConnectionPoint

depth

• get depth(): NodeRenderGraphConnectionPoint

  Gets the depth texture input component

  Returns NodeRenderGraphConnectionPoint

depthTest

• get depthTest(): boolean

  Indicates if depth testing must be enabled or disabled

  Returns boolean

• set depthTest(value: boolean): void

  Parameters

  • value: boolean

  Returns void

depthWrite

• get depthWrite(): boolean

  Indicates if depth writing must be enabled or disabled

  Returns boolean

• set depthWrite(value: boolean): void

  Parameters

  • value: boolean

  Returns void

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

disableShadows

• get disableShadows(): boolean

  Indicates if shadows must be enabled or disabled

  Returns boolean

• set disableShadows(value: boolean): void

  Parameters

  • value: boolean

  Returns void

doNotChangeAspectRatio

• get doNotChangeAspectRatio(): boolean

  True (default) to not change the aspect ratio of the scene in the RTT

  Returns boolean

• set doNotChangeAspectRatio(value: boolean): void

  Parameters

  • value: boolean

  Returns void

enableBoundingBoxRendering

• get enableBoundingBoxRendering(): boolean

  Indicates if bounding boxes should be rendered

  Returns boolean

• set enableBoundingBoxRendering(value: boolean): void

  Parameters

  • value: boolean

  Returns void

enableClusteredLights

• get enableClusteredLights(): boolean

  True (default) to enable clustered lights

  Returns boolean

• set enableClusteredLights(value: boolean): void

  Parameters

  • value: boolean

  Returns void

enableOutlineRendering

• get enableOutlineRendering(): boolean

  Indicates if outlines/overlays should be rendered

  Returns boolean

• set enableOutlineRendering(value: boolean): void

  Parameters

  • value: boolean

  Returns void

forceLayerMaskCheck

• get forceLayerMaskCheck(): boolean

  Indicates if layer mask check must be forced

  Returns boolean

• set forceLayerMaskCheck(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

isMainObjectRenderer

• get isMainObjectRenderer(): boolean

  Indicates that this object renderer is the main object renderer of the frame graph.

  Returns boolean

• set isMainObjectRenderer(value: boolean): void

  Parameters

  • value: boolean

  Returns void

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

objectRenderer

• get objectRenderer(): NodeRenderGraphConnectionPoint

  Gets the objectRenderer component

  Returns NodeRenderGraphConnectionPoint

objects

• get objects(): NodeRenderGraphConnectionPoint

  Gets the objects input component

  Returns NodeRenderGraphConnectionPoint

oitPassCount

• get oitPassCount(): number

  Defines the number of passes to use for Order Independent Transparency

  Returns number

• set oitPassCount(value: number): void

  Parameters

  • value: number

  Returns void

output

• get output(): NodeRenderGraphConnectionPoint

  Gets the output component

  Returns NodeRenderGraphConnectionPoint

outputDepth

• get outputDepth(): NodeRenderGraphConnectionPoint

  Gets the output depth component

  Returns NodeRenderGraphConnectionPoint

outputs

• get outputs(): NodeRenderGraphConnectionPoint[]

  Gets the list of output points

  Returns NodeRenderGraphConnectionPoint[]

renderAlphaTestMeshes

• get renderAlphaTestMeshes(): boolean

  Indicates if alpha tested meshes should be rendered

  Returns boolean

• set renderAlphaTestMeshes(value: boolean): void

  Parameters

  • value: boolean

  Returns void

renderDepthOnlyMeshes

• get renderDepthOnlyMeshes(): boolean

  Indicates if depth-only meshes should be rendered

  Returns boolean

• set renderDepthOnlyMeshes(value: boolean): void

  Parameters

  • value: boolean

  Returns void

renderInLinearSpace

• get renderInLinearSpace(): boolean

  If image processing should be disabled

  Returns boolean

• set renderInLinearSpace(value: boolean): void

  Parameters

  • value: boolean

  Returns void

renderMeshes

• get renderMeshes(): boolean

  Indicates if meshes should be rendered

  Returns boolean

• set renderMeshes(value: boolean): void

  Parameters

  • value: boolean

  Returns void

renderOpaqueMeshes

• get renderOpaqueMeshes(): boolean

  Indicates if opaque meshes should be rendered

  Returns boolean

• set renderOpaqueMeshes(value: boolean): void

  Parameters

  • value: boolean

  Returns void

renderParticles

• get renderParticles(): boolean

  Indicates if particles should be rendered

  Returns boolean

• set renderParticles(value: boolean): void

  Parameters

  • value: boolean

  Returns void

renderSprites

• get renderSprites(): boolean

  Indicates if sprites should be rendered

  Returns boolean

• set renderSprites(value: boolean): void

  Parameters

  • value: boolean

  Returns void

renderTransparentMeshes

• get renderTransparentMeshes(): boolean

  Indicates if transparent meshes should be rendered

  Returns boolean

• set renderTransparentMeshes(value: boolean): void

  Parameters

  • value: boolean

  Returns void

resolveMSAAColors

• get resolveMSAAColors(): boolean

  If true, MSAA color textures will be resolved at the end of the render pass (default: true)

  Returns boolean

• set resolveMSAAColors(value: boolean): void

  Parameters

  • value: boolean

  Returns void

resolveMSAADepth

• get resolveMSAADepth(): boolean

  If true, MSAA depth texture will be resolved at the end of the render pass (default: false)

  Returns boolean

• set resolveMSAADepth(value: boolean): void

  Parameters

  • value: boolean

  Returns void

shadowGenerators

• get shadowGenerators(): NodeRenderGraphConnectionPoint

  Gets the shadowGenerators input component

  Returns NodeRenderGraphConnectionPoint

target

• get target(): NodeRenderGraphConnectionPoint

  Gets the target texture input component

  Returns NodeRenderGraphConnectionPoint

task

• get task(): FrameGraphObjectRendererTask

  Gets the frame graph task associated with this block

  Returns FrameGraphObjectRendererTask

useOITForTransparentMeshes

• get useOITForTransparentMeshes(): boolean

  Indicates if use of Order Independent Transparency (OIT) for transparent meshes should be enabled

  Returns boolean

• set useOITForTransparentMeshes(value: boolean): void

  Parameters

  • value: boolean

  Returns void

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

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,
  ): NodeRenderGraphObjectRendererBlock

  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 NodeRenderGraphObjectRendererBlock

  the current block

registerOutput

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

  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 NodeRenderGraphObjectRendererBlock

  the current block

serialize

• serialize(): any

  Serializes this block in a JSON representation

  Returns any

  the serialized block object