Class NodeRenderGraphInputBlock
Hierarchy (View Summary)
- NodeRenderGraphBlock
- NodeRenderGraphInputBlock
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
new NodeRenderGraphInputBlock(
name: string,
frameGraph: FrameGraph,
scene: Scene,
type?: NodeRenderGraphBlockConnectionPointTypes,
): NodeRenderGraphInputBlockCreates a new NodeRenderGraphInputBlock
Parameters
- name: string
defines the block name
- frameGraph: FrameGraph
defines the hosting frame graph
- scene: Scene
defines the hosting scene
- type: NodeRenderGraphBlockConnectionPointTypes = NodeRenderGraphBlockConnectionPointTypes.Undefined
defines the type of the input (can be set to NodeRenderGraphBlockConnectionPointTypes.Undefined)
Returns NodeRenderGraphInputBlock
- name: string
Properties
comments
A free comment about the block
creation
Gets or sets the options to create the input value
is
Indicates that the input is externally managed
on
Gets an observable raised when the block is built
on
Gets an observable raised when the value is changed
unique
Gets or sets the unique id of the node
visible
Gets or sets a boolean indicating that this input can be edited from a collapsed frame
Accessors
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
-
Gets the list of input points
Returns NodeRenderGraphConnectionPoint[]
is
-
get isDebug(): boolean
Gets a boolean indicating if this block is a debug block
Returns boolean
is
-
get isInput(): boolean
Gets a boolean indicating if this block is an input
Returns boolean
is
-
get isTeleportIn(): boolean
Gets a boolean indicating if this block is a teleport in
Returns boolean
is
-
get isTeleportOut(): boolean
Gets a boolean indicating if this block is a teleport out
Returns boolean
is
-
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
output
-
get output(): NodeRenderGraphConnectionPoint
Gets the output component
Returns NodeRenderGraphConnectionPoint
outputs
-
Gets the list of output points
Returns NodeRenderGraphConnectionPoint[]
task
-
get task(): any
Gets the frame graph task associated with this block
Returns any
type
-
Gets or sets the connection point type (default is Undefined)
Returns NodeRenderGraphBlockConnectionPointTypes
value
-
get value(): Nullable<any>
Gets or sets the value of that point.
Returns Nullable<any>
-
set value(value: Nullable<any>): void
Parameters
- value: Nullable<any>
Returns void
Methods
auto
-
Lets the block try to connect some inputs automatically
Returns void
build
-
Build the current node and generate the vertex data
Parameters
- state: NodeRenderGraphBuildState
defines the current generation state
Returns boolean
true if already built
- state: NodeRenderGraphBuildState
clone
-
Clone the current block to a new identical block
Returns NodeRenderGraphBlock | null
a copy of the current block
dispose
-
Release resources
Returns void
get
-
Gets the current class name
Returns string
the class name
get
-
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
- predicate: (block: NodeRenderGraphBlock) => boolean
get
-
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
- name: string
get
-
Gets the value as an internal texture
Returns Nullable<InternalTexture>
The internal texture stored in value if value is an internal texture, otherwise null
get
-
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
- name: string
get
-
Gets the value as a specific type
Type Parameters
- T extends any
Returns T
the value as a specific type
initialize
-
Initialize the block and prepare the context for build
Returns void
is
-
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
- block: NodeRenderGraphBlock
is
-
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
- type: string
is
-
Check if the block is a texture of any type
Returns boolean
true if the block is a texture
is
-
Gets a boolean indicating that the connection point is the back buffer texture
Returns boolean
true if the connection point is the back buffer texture
is
-
Gets a boolean indicating that the connection point is a depth/stencil attachment texture
Returns boolean
true if the connection point is a depth/stencil attachment texture
is
-
Check if the block is a camera
Returns boolean
true if the block is a camera
is
-
Check if the block is an object list
Returns boolean
true if the block is an object list
is
-
Check if the block is a shadow light
Returns boolean
true if the block is a shadow light
register
-
registerInput(
name: string,
type: NodeRenderGraphBlockConnectionPointTypes,
isOptional?: boolean,
point?: NodeRenderGraphConnectionPoint,
): NodeRenderGraphInputBlockRegister 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: NodeRenderGraphConnectionPointan already created connection point. If not provided, create a new one
Returns NodeRenderGraphInputBlock
the current block
- name: string
register
-
registerOutput(
name: string,
type: NodeRenderGraphBlockConnectionPointTypes,
point?: NodeRenderGraphConnectionPoint,
): NodeRenderGraphInputBlockRegister 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: NodeRenderGraphConnectionPointan already created connection point. If not provided, create a new one
Returns NodeRenderGraphInputBlock
the current block
- name: string
serialize
-
Serializes this block in a JSON representation
Returns any
the serialized block object
set
-
Set the input block to its default value (based on its type)
Returns void
Block used to expose an input value