Class NodeRenderGraphIblShadowsRendererBlock
Hierarchy (View Summary)
- NodeRenderGraphBlock
- NodeRenderGraphIblShadowsRendererBlock
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
new NodeRenderGraphIblShadowsRendererBlock(
name: string,
frameGraph: FrameGraph,
scene: Scene,
): NodeRenderGraphIblShadowsRendererBlockCreate a new NodeRenderGraphIblShadowsRendererBlock
Parameters
- name: string
defines the block name
- frameGraph: FrameGraph
defines the hosting frame graph
- scene: Scene
defines the hosting scene
Returns NodeRenderGraphIblShadowsRendererBlock
- name: string
Properties
comments
A free comment about the block
on
Gets an observable raised when the block is built
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
camera
-
get camera(): NodeRenderGraphConnectionPoint
Gets the camera input component
Returns NodeRenderGraphConnectionPoint
colored
-
get coloredShadows(): boolean
Whether traced shadows preserve environment color
Returns boolean
-
set coloredShadows(value: boolean): void
Parameters
- value: boolean
Returns void
depth
-
get depth(): NodeRenderGraphConnectionPoint
Gets the depth texture input component
Returns NodeRenderGraphConnectionPoint
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
env
-
get envRotation(): number
Environment rotation in radians
Returns number
-
set envRotation(value: number): void
Parameters
- value: number
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
normal
-
get normal(): NodeRenderGraphConnectionPoint
Gets the normal texture input component
Returns NodeRenderGraphConnectionPoint
objects
-
get objects(): NodeRenderGraphConnectionPoint
Gets the objects input component
Returns NodeRenderGraphConnectionPoint
output
-
get output(): NodeRenderGraphConnectionPoint
Gets the output component
Returns NodeRenderGraphConnectionPoint
outputs
-
Gets the list of output points
Returns NodeRenderGraphConnectionPoint[]
position
-
get position(): NodeRenderGraphConnectionPoint
Gets the position texture input component
Returns NodeRenderGraphConnectionPoint
refresh
-
get refreshRate(): number
Voxelization refresh rate (-1: manual, 0: every frame, N: skip N frames)
Returns number
-
set refreshRate(value: number): void
Parameters
- value: number
Returns void
resolution
-
get resolutionExp(): number
Voxelization resolution exponent (actual resolution is 2^value)
Returns number
-
set resolutionExp(value: number): void
Parameters
- value: number
Returns void
sample
-
get sampleDirections(): number
Number of tracing sample directions
Returns number
-
set sampleDirections(value: number): void
Parameters
- value: number
Returns void
shadow
-
get shadowOpacity(): number
Final material shadow opacity
Returns number
-
set shadowOpacity(value: number): void
Parameters
- value: number
Returns void
shadow
-
get shadowRemanence(): number
Temporal shadow remanence while moving
Returns number
-
set shadowRemanence(value: number): void
Parameters
- value: number
Returns void
ss
-
get ssShadowDistanceScale(): number
Distance scale used by screen-space shadow tracing
Returns number
-
set ssShadowDistanceScale(value: number): void
Parameters
- value: number
Returns void
ss
-
get ssShadowOpacity(): number
Opacity of screen-space shadows
Returns number
-
set ssShadowOpacity(value: number): void
Parameters
- value: number
Returns void
ss
-
get ssShadowSampleCount(): number
Number of screen-space shadow samples
Returns number
-
set ssShadowSampleCount(value: number): void
Parameters
- value: number
Returns void
ss
-
get ssShadowStride(): number
Stride used by screen-space shadow sampling
Returns number
-
set ssShadowStride(value: number): void
Parameters
- value: number
Returns void
ss
-
get ssShadowThicknessScale(): number
Thickness scale used by screen-space shadow tracing
Returns number
-
set ssShadowThicknessScale(value: number): void
Parameters
- value: number
Returns void
task
-
get task(): FrameGraphIblShadowsRendererTask
Gets the frame graph task associated with this block
Returns FrameGraphIblShadowsRendererTask
tri
-
get triPlanarVoxelization(): boolean
Whether tri-planar voxelization is used
Returns boolean
-
set triPlanarVoxelization(value: boolean): void
Parameters
- value: boolean
Returns void
velocity
-
get velocity(): NodeRenderGraphConnectionPoint
Gets the velocity texture input component
Returns NodeRenderGraphConnectionPoint
voxel
-
get voxelDirectionBias(): number
Voxel tracing direction bias
Returns number
-
set voxelDirectionBias(value: number): void
Parameters
- value: number
Returns void
voxel
-
get voxelNormalBias(): number
Voxel tracing normal bias
Returns number
-
set voxelNormalBias(value: number): void
Parameters
- value: number
Returns void
voxel
-
get voxelShadowOpacity(): number
Opacity of voxel-traced shadows
Returns number
-
set voxelShadowOpacity(value: number): void
Parameters
- value: number
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
-
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
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
register
-
registerInput(
name: string,
type: NodeRenderGraphBlockConnectionPointTypes,
isOptional?: boolean,
point?: NodeRenderGraphConnectionPoint,
): NodeRenderGraphIblShadowsRendererBlockRegister 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 NodeRenderGraphIblShadowsRendererBlock
the current block
- name: string
register
-
registerOutput(
name: string,
type: NodeRenderGraphBlockConnectionPointTypes,
point?: NodeRenderGraphConnectionPoint,
): NodeRenderGraphIblShadowsRendererBlockRegister 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 NodeRenderGraphIblShadowsRendererBlock
the current block
- name: string
serialize
-
Serializes this block in a JSON representation
Returns any
the serialized block object
Block that implements IBL (image-based lighting) shadows using voxel tracing.