Class NodeRenderGraphCascadedShadowGeneratorBlock
Hierarchy
- NodeRenderGraphBaseShadowGeneratorBlock
- NodeRenderGraphCascadedShadowGeneratorBlock
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
new NodeRenderGraphCascadedShadowGeneratorBlock(
name: string,
frameGraph: FrameGraph,
scene: Scene,
): NodeRenderGraphCascadedShadowGeneratorBlockCreate a new NodeRenderGraphCascadedShadowGeneratorBlock
Parameters
- name: string
defines the block name
- frameGraph: FrameGraph
defines the hosting frame graph
- scene: Scene
defines the hosting scene
Returns NodeRenderGraphCascadedShadowGeneratorBlock
- name: string
Properties
comments
A free comment about the block
on Build Observable
Gets an observable raised when the block is built
unique Id
Gets or sets the unique id of the node
visible On Frame
Gets or sets a boolean indicating that this input can be edited from a collapsed frame
Accessors
auto Calc Depth Bounds
-
get autoCalcDepthBounds(): boolean
Gets or sets a value indicating whether the shadow generator should automatically calculate the depth bounds.
Returns boolean
-
set autoCalcDepthBounds(value: boolean): void
Parameters
- value: boolean
Returns void
auto Calc Depth Bounds Refresh Rate
-
get autoCalcDepthBoundsRefreshRate(): number
Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true.
Returns number
-
set autoCalcDepthBoundsRefreshRate(value: number): void
Parameters
- value: number
Returns void
bias
-
get bias(): number
Sets the bias
Returns number
-
set bias(value: number): void
Parameters
- value: number
Returns void
camera
-
get camera(): NodeRenderGraphConnectionPoint
Gets the camera input component
Returns NodeRenderGraphConnectionPoint
cascade Blend Percentage
-
get cascadeBlendPercentage(): number
Gets or sets the cascade blend percentage.
Returns number
-
set cascadeBlendPercentage(value: number): void
Parameters
- value: number
Returns void
darkness
-
get darkness(): number
Sets the darkness of the shadows
Returns number
-
set darkness(value: number): void
Parameters
- value: number
Returns void
debug
-
get debug(): boolean
Gets or sets a value indicating whether the shadow generator should display the cascades.
Returns boolean
-
set debug(value: boolean): void
Parameters
- value: boolean
Returns void
depth Clamp
-
get depthClamp(): boolean
Gets or sets a value indicating whether the shadow generator should use depth clamping.
Returns boolean
-
set depthClamp(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
enable Soft Transparent Shadow
-
get enableSoftTransparentShadow(): boolean
Enables or disables shadows with varying strength based on the transparency
Returns boolean
-
set enableSoftTransparentShadow(value: boolean): void
Parameters
- value: boolean
Returns void
filter
-
get filter(): number
Sets the filter method
Returns number
-
set filter(value: number): void
Parameters
- value: number
Returns void
filtering Quality
-
get filteringQuality(): number
Sets the filter quality (for PCF and PCSS)
Returns number
-
set filteringQuality(value: number): void
Parameters
- value: number
Returns void
generator
-
get generator(): NodeRenderGraphConnectionPoint
Gets the shadow generator component
Returns NodeRenderGraphConnectionPoint
geom Depth
-
get geomDepth(): NodeRenderGraphConnectionPoint
Gets the geometry (view / normalized view) depth component
Returns NodeRenderGraphConnectionPoint
inputs
-
Gets the list of input points
Returns NodeRenderGraphConnectionPoint[]
is Debug
-
get isDebug(): boolean
Gets a boolean indicating if this block is a debug block
Returns boolean
is Input
-
get isInput(): boolean
Gets a boolean indicating if this block is an input
Returns boolean
is Teleport In
-
get isTeleportIn(): boolean
Gets a boolean indicating if this block is a teleport in
Returns boolean
is Teleport Out
-
get isTeleportOut(): boolean
Gets a boolean indicating if this block is a teleport out
Returns boolean
is Unique
-
get isUnique(): boolean
Gets a boolean indicating that this block can only be used once per node render graph
Returns boolean
lambda
-
get lambda(): number
Gets or sets the lambda parameter of the shadow generator.
Returns number
-
set lambda(value: number): void
Parameters
- value: number
Returns void
light
-
get light(): NodeRenderGraphConnectionPoint
Gets the light input component
Returns NodeRenderGraphConnectionPoint
map Size
-
get mapSize(): number
Sets the size of the shadow texture
Returns number
-
set mapSize(value: number): void
Parameters
- value: number
Returns void
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 Bias
-
get normalBias(): number
Sets the normal bias
Returns number
-
set normalBias(value: number): void
Parameters
- value: number
Returns void
num Cascades
-
get numCascades(): number
Sets the number of cascades
Returns number
-
set numCascades(value: number): void
Parameters
- value: number
Returns void
objects
-
get objects(): NodeRenderGraphConnectionPoint
Gets the objects input component
Returns NodeRenderGraphConnectionPoint
output
-
get output(): NodeRenderGraphConnectionPoint
Gets the output texture component
Returns NodeRenderGraphConnectionPoint
outputs
-
Gets the list of output points
Returns NodeRenderGraphConnectionPoint[]
shadow Max Z
-
get shadowMaxZ(): number
Gets or sets the maximum shadow Z value.
Returns number
-
set shadowMaxZ(value: number): void
Parameters
- value: number
Returns void
stabilize Cascades
-
get stabilizeCascades(): boolean
Gets or sets a value indicating whether the shadow generator should stabilize the cascades.
Returns boolean
-
set stabilizeCascades(value: boolean): void
Parameters
- value: boolean
Returns void
task
-
Gets the frame graph task associated with this block
Returns FrameGraphCascadedShadowGeneratorTask
transparency Shadow
-
get transparencyShadow(): boolean
Gets or sets the ability to have transparent shadow
Returns boolean
-
set transparencyShadow(value: boolean): void
Parameters
- value: boolean
Returns void
use Float32 Texture Type
-
get useFloat32TextureType(): boolean
Sets the texture type to float (by default, half float is used if supported)
Returns boolean
-
set useFloat32TextureType(value: boolean): void
Parameters
- value: boolean
Returns void
use Opacity Texture For Transparent Shadow
-
get useOpacityTextureForTransparentShadow(): boolean
If this is true, use the opacity texture's alpha channel for transparent shadows instead of the diffuse one
Returns boolean
-
set useOpacityTextureForTransparentShadow(value: boolean): void
Parameters
- value: boolean
Returns void
use Red Texture Format
-
get useRedTextureFormat(): boolean
Sets the texture type to Red
Returns boolean
-
set useRedTextureFormat(value: boolean): void
Parameters
- value: boolean
Returns void
Methods
_ deserialize
-
Parameters
- serializationObject: any
Returns void
auto Configure
-
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 Class Name
-
Gets the current class name
Returns string
the class name
get Descendant Of Predicate
-
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 Input By Name
-
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 Output By Name
-
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 An Ancestor Of
-
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 An Ancestor Of Type
-
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 Input
-
registerInput(
name: string,
type: NodeRenderGraphBlockConnectionPointTypes,
isOptional?: boolean,
point?: NodeRenderGraphConnectionPoint,
): NodeRenderGraphCascadedShadowGeneratorBlockRegister 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 NodeRenderGraphCascadedShadowGeneratorBlock
the current block
- name: string
register Output
-
registerOutput(
name: string,
type: NodeRenderGraphBlockConnectionPointTypes,
point?: NodeRenderGraphConnectionPoint,
): NodeRenderGraphCascadedShadowGeneratorBlockRegister 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 NodeRenderGraphCascadedShadowGeneratorBlock
the current block
- name: string
serialize
-
Serializes this block
Returns any
the serialized object
Block that generates shadows through a shadow generator