Class NodeRenderGraphSSRPostProcessBlock
Hierarchy (View Summary)
- NodeRenderGraphBasePostProcessBlock
- NodeRenderGraphSSRPostProcessBlock
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
new NodeRenderGraphSSRPostProcessBlock(
name: string,
frameGraph: FrameGraph,
scene: Scene,
textureType?: any,
): NodeRenderGraphSSRPostProcessBlockCreate a new NodeRenderGraphSSRPostProcessBlock
Parameters
- name: string
defines the block name
- frameGraph: FrameGraph
defines the hosting frame graph
- scene: Scene
defines the hosting scene
- textureType: any = Constants.TEXTURETYPE_UNSIGNED_BYTE
The texture type used by the different post processes created by SSR (default: Constants.TEXTURETYPE_UNSIGNED_BYTE)
Returns NodeRenderGraphSSRPostProcessBlock
- 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
alpha
-
get alphaMode(): number
The alpha mode to use when applying the post process.
Returns number
-
set alphaMode(value: number): void
Parameters
- value: number
Returns void
attenuate
-
get attenuateBackfaceReflection(): boolean
Gets or sets a boolean indicating if the backface reflections should be attenuated
Returns boolean
-
set attenuateBackfaceReflection(value: boolean): void
Parameters
- value: boolean
Returns void
attenuate
-
get attenuateFacingCamera(): boolean
Gets or sets a boolean indicating if the reflections should be attenuated when the reflection ray is facing the camera (the view direction)
Returns boolean
-
set attenuateFacingCamera(value: boolean): void
Parameters
- value: boolean
Returns void
attenuate
-
get attenuateIntersectionDistance(): boolean
Gets or sets a boolean indicating if the reflections should be attenuated according to the distance of the intersection
Returns boolean
-
set attenuateIntersectionDistance(value: boolean): void
Parameters
- value: boolean
Returns void
attenuate
-
get attenuateIntersectionIterations(): boolean
Gets or sets a boolean indicating if the reflections should be attenuated according to the number of iterations performed to find the intersection
Returns boolean
-
set attenuateIntersectionIterations(value: boolean): void
Parameters
- value: boolean
Returns void
attenuate
-
get attenuateScreenBorders(): boolean
Gets or sets a boolean indicating if the reflections should be attenuated at the screen borders
Returns boolean
-
set attenuateScreenBorders(value: boolean): void
Parameters
- value: boolean
Returns void
blur
-
get blurDispersionStrength(): number
Gets or sets the blur dispersion strength. Set this value to 0 to disable blurring
Returns number
-
set blurDispersionStrength(value: number): void
Parameters
- value: number
Returns void
blur
-
get blurDownsample(): number
Gets or sets the downsample factor used to reduce the size of the textures used to blur the reflection effect
Returns number
-
set blurDownsample(value: number): void
Parameters
- value: number
Returns void
camera
-
get camera(): NodeRenderGraphConnectionPoint
Gets the camera input component
Returns NodeRenderGraphConnectionPoint
clip
-
get clipToFrustum(): boolean
Gets or sets a boolean indicating if the ray should be clipped to the frustum
Returns boolean
-
set clipToFrustum(value: boolean): void
Parameters
- value: boolean
Returns void
debug
-
get debug(): boolean
Gets or sets a boolean indicating if the effect should be rendered in debug mode
Returns boolean
-
set debug(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
-
get enableAutomaticThicknessComputation(): boolean
Gets or sets a boolean defining if geometry thickness should be computed automatically
Returns boolean
-
set enableAutomaticThicknessComputation(value: boolean): void
Parameters
- value: boolean
Returns void
enable
-
get enableSmoothReflections(): boolean
Gets or sets whether or not smoothing reflections is enabled
Returns boolean
-
set enableSmoothReflections(value: boolean): void
Parameters
- value: boolean
Returns void
generate
-
get generateOutputInGammaSpace(): boolean
Gets or sets a boolean defining if the output color texture generated by the SSR pipeline should be in gamma space
Returns boolean
-
set generateOutputInGammaSpace(value: boolean): void
Parameters
- value: boolean
Returns void
geom
-
get geomBackDepth(): NodeRenderGraphConnectionPoint
Gets the geometry back depth input component
Returns NodeRenderGraphConnectionPoint
geom
-
get geomDepth(): NodeRenderGraphConnectionPoint
Gets the geometry depth input component
Returns NodeRenderGraphConnectionPoint
geom
-
get geomNormal(): NodeRenderGraphConnectionPoint
Gets the geometry normal input component
Returns NodeRenderGraphConnectionPoint
geom
-
get geomReflectivity(): NodeRenderGraphConnectionPoint
Gets the geometry reflectivity input component
Returns NodeRenderGraphConnectionPoint
inputs
-
Gets the list of input points
Returns NodeRenderGraphConnectionPoint[]
input
-
get inputTextureColorIsInGammaSpace(): boolean
Gets or sets a boolean defining if the input color texture is in gamma space
Returns boolean
-
set inputTextureColorIsInGammaSpace(value: boolean): void
Parameters
- value: boolean
Returns void
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
max
-
get maxDistance(): number
Gets or sets the max distance used to define how far we look for reflection during the ray-marching on the reflected ray
Returns number
-
set maxDistance(value: number): void
Parameters
- value: number
Returns void
max
-
get maxSteps(): number
Maximum number of steps during the ray marching process after which we consider an intersection could not be found
Returns number
-
set maxSteps(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
output
-
get output(): NodeRenderGraphConnectionPoint
Gets the output component
Returns NodeRenderGraphConnectionPoint
outputs
-
Gets the list of output points
Returns NodeRenderGraphConnectionPoint[]
reflection
-
get reflectionSpecularFalloffExponent(): number
Gets or sets the falloff exponent used to compute the reflection strength. Higher values lead to fainter reflections
Returns number
-
set reflectionSpecularFalloffExponent(value: number): void
Parameters
- value: number
Returns void
reflectivity
-
get reflectivityThreshold(): number
Gets or sets the minimum value for one of the reflectivity component of the material to consider it for SSR
Returns number
-
set reflectivityThreshold(value: number): void
Parameters
- value: number
Returns void
roughness
-
get roughnessFactor(): number
Gets or sets the factor applied when computing roughness
Returns number
-
set roughnessFactor(value: number): void
Parameters
- value: number
Returns void
self
-
get selfCollisionNumSkip(): number
Number of steps to skip at start when marching the ray to avoid self collisions
Returns number
-
set selfCollisionNumSkip(value: number): void
Parameters
- value: number
Returns void
source
-
get source(): NodeRenderGraphConnectionPoint
Gets the source input component
Returns NodeRenderGraphConnectionPoint
source
-
get sourceSamplingMode(): number
Sampling mode used to sample from the source texture
Returns number
-
set sourceSamplingMode(value: number): void
Parameters
- value: number
Returns void
ssr
-
get ssrDownsample(): number
Gets or sets the downsample factor used to reduce the size of the texture used to compute the SSR contribution
Returns number
-
set ssrDownsample(value: number): void
Parameters
- value: number
Returns void
step
-
get step(): number
Gets or sets the step size used to iterate until the effect finds the color of the reflection's pixel
Returns number
-
set step(value: number): void
Parameters
- value: number
Returns void
strength
-
get strength(): number
Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results
Returns number
-
set strength(value: number): void
Parameters
- value: number
Returns void
target
-
get target(): NodeRenderGraphConnectionPoint
Gets the target input component
Returns NodeRenderGraphConnectionPoint
task
-
Gets the frame graph task associated with this block
Returns FrameGraphSSRRenderingPipelineTask
texture
-
get textureType(): number
The texture type used by the different post processes created by SSR
Returns number
-
set textureType(value: number): void
Parameters
- value: number
Returns void
thickness
-
get thickness(): number
Gets or sets the thickness value used as tolerance when computing the intersection between the reflected ray and the scene
Returns number
-
set thickness(value: number): void
Parameters
- value: number
Returns void
use
-
get useFresnel(): boolean
Gets or sets a boolean indicating whether the blending between the current color pixel and the reflection color should be done with a Fresnel coefficient
Returns boolean
-
set useFresnel(value: boolean): void
Parameters
- value: boolean
Returns void
Methods
_
-
Parameters
- serializationObject: any
Returns void
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,
): NodeRenderGraphSSRPostProcessBlockRegister 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 NodeRenderGraphSSRPostProcessBlock
the current block
- name: string
register
-
registerOutput(
name: string,
type: NodeRenderGraphBlockConnectionPointTypes,
point?: NodeRenderGraphConnectionPoint,
): NodeRenderGraphSSRPostProcessBlockRegister 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 NodeRenderGraphSSRPostProcessBlock
the current block
- name: string
serialize
-
Serializes this block in a JSON representation
Returns any
the serialized block object
Block that implements the SSR post process