Class NodeRenderGraphSSAO2PostProcessBlock
Hierarchy (View Summary)
- NodeRenderGraphBasePostProcessBlock
- NodeRenderGraphSSAO2PostProcessBlock
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
new NodeRenderGraphSSAO2PostProcessBlock(
name: string,
frameGraph: FrameGraph,
scene: Scene,
ratioSSAO?: number,
ratioBlur?: number,
textureType?: any,
): NodeRenderGraphSSAO2PostProcessBlockCreate a new NodeRenderGraphSSAO2PostProcessBlock
Parameters
- name: string
defines the block name
- frameGraph: FrameGraph
defines the hosting frame graph
- scene: Scene
defines the hosting scene
- ratioSSAO: number = 1
The ratio between the SSAO texture size and the source texture size (default: 1)
- ratioBlur: number = 1
The ratio between the SSAO blur texture size and the source texture size (default: 1)
- textureType: any = Constants.TEXTURETYPE_UNSIGNED_BYTE
The texture type used by the different post processes created by SSAO2 (default: Constants.TEXTURETYPE_UNSIGNED_BYTE)
Returns NodeRenderGraphSSAO2PostProcessBlock
- 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
base
-
get base(): number
The base color of the SSAO post-process. The final result is "base + ssao" between [0, 1]
Returns number
-
set base(value: number): void
Parameters
- value: number
Returns void
bilateral
-
get bilateralSamples(): number
The number of samples the bilateral filter uses in both dimensions when denoising the SSAO calculations.
Returns number
-
set bilateralSamples(value: number): void
Parameters
- value: number
Returns void
bilateral
-
get bilateralSoften(): number
Controls the shape of the denoising kernel used by the bilateral filter.
Returns number
-
set bilateralSoften(value: number): void
Parameters
- value: number
Returns void
bilateral
-
get bilateralTolerance(): number
How forgiving the bilateral denoiser should be when rejecting samples.
Returns number
-
set bilateralTolerance(value: number): void
Parameters
- value: number
Returns void
bypass
-
get bypassBlur(): boolean
Skips the denoising (blur) stage of the SSAO calculations.
Returns boolean
-
set bypassBlur(value: boolean): void
Parameters
- value: boolean
Returns void
camera
-
get camera(): NodeRenderGraphConnectionPoint
Gets the camera 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
epsilon
-
get epsilon(): number
Used in SSAO calculations to compensate for accuracy issues with depth values.
Returns number
-
set epsilon(value: number): void
Parameters
- value: number
Returns void
expensive
-
get expensiveBlur(): boolean
Enables the configurable bilateral denoising (blurring) filter.
Returns boolean
-
set expensiveBlur(value: boolean): void
Parameters
- value: boolean
Returns void
geom
-
get geomDepth(): NodeRenderGraphConnectionPoint
Gets the geometry depth input component
Returns NodeRenderGraphConnectionPoint
geom
-
get geomNormal(): NodeRenderGraphConnectionPoint
Gets the geometry normal input component
Returns NodeRenderGraphConnectionPoint
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
max
-
get maxZ(): number
Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
Returns number
-
set maxZ(value: number): void
Parameters
- value: number
Returns void
min
-
get minZAspect(): number
In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much.
Returns number
-
set minZAspect(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[]
radius
-
get radius(): number
The radius around the analyzed pixel used by the SSAO post-process.
Returns number
-
set radius(value: number): void
Parameters
- value: number
Returns void
ratio
-
get ratioBlur(): number
The ratio between the SSAO blur texture size and the source texture size
Returns number
-
set ratioBlur(value: number): void
Parameters
- value: number
Returns void
ratio
-
get ratioSSAO(): number
The ratio between the SSAO texture size and the source texture size
Returns number
-
set ratioSSAO(value: number): void
Parameters
- value: number
Returns void
samples
-
get samples(): number
Number of samples used for the SSAO calculations. Default value is 8.
Returns number
-
set samples(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
target
-
get target(): NodeRenderGraphConnectionPoint
Gets the target input component
Returns NodeRenderGraphConnectionPoint
task
-
Gets the frame graph task associated with this block
Returns FrameGraphSSAO2RenderingPipelineTask
texture
-
get textureType(): number
The texture type used by the different post processes created by SSAO2
Returns number
-
set textureType(value: number): void
Parameters
- value: number
Returns void
total
-
get totalStrength(): number
The strength of the SSAO post-process. Default value is 1.0.
Returns number
-
set totalStrength(value: number): void
Parameters
- value: number
Returns void
use
-
get useViewportInCombineStage(): boolean
Indicates that the combine stage should use the current camera viewport to render the SSAO result on only a portion of the output texture.
Returns boolean
-
set useViewportInCombineStage(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,
): NodeRenderGraphSSAO2PostProcessBlockRegister 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 NodeRenderGraphSSAO2PostProcessBlock
the current block
- name: string
register
-
registerOutput(
name: string,
type: NodeRenderGraphBlockConnectionPointTypes,
point?: NodeRenderGraphConnectionPoint,
): NodeRenderGraphSSAO2PostProcessBlockRegister 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 NodeRenderGraphSSAO2PostProcessBlock
the current block
- name: string
serialize
-
Serializes this block in a JSON representation
Returns any
the serialized block object
Block that implements the SSAO2 post process