Class SSAORenderingPipeline
Hierarchy (View Summary)
- PostProcessRenderPipeline
- SSAORenderingPipeline
Constructors
constructor
-
new SSAORenderingPipeline(
name: string,
scene: Scene,
ratio: any,
cameras?: Camera[],
): SSAORenderingPipelineParameters
- name: string
The rendering pipeline name
- scene: Scene
The scene linked to this pipeline
- ratio: any
The size of the postprocesses. Can be a number shared between passes or an object for more precision: { ssaoRatio: 0.5, combineRatio: 1.0 }
Optionalcameras: Camera[]The array of cameras that the rendering pipeline will be attached to
Returns SSAORenderingPipeline
- name: string
Properties
area
Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel Must not be equal to fallOff and superior to fallOff. Default value is 0.0075
base
The base color of the SSAO post-process The final result is "base + ssao" between [0, 1]
fall
Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel Must not be equal to area and inferior to area. Default value is 0.000001
inspectable
List of inspectable custom properties (used by the Inspector)
radius
The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
SSAO
SSAO
SSAO
SSAO
SSAO
total
The output strength of the SSAO post-process. Default value is 1.0.
Readonlyunique
Gets the unique id of the post process rendering pipeline
Accessors
cameras
-
Gets the list of attached cameras
Returns Camera[]
engine
-
Gets the active engine
Returns AbstractEngine
is
-
get isSupported(): boolean
If all the render effects in the pipeline are supported
Returns boolean
name
-
get name(): string
Gets pipeline name
Returns string
scene
-
Gets active scene
Returns Scene
Methods
add
-
Adds an effect to the pipeline
Parameters
- renderEffect: PostProcessRenderEffect
the effect to add
Returns void
- renderEffect: PostProcessRenderEffect
dispose
-
Removes the internal pipeline assets and detaches the pipeline from the scene cameras
Parameters
- disableDepthRender: boolean = false
If the depth renderer should be disabled on the scene
Returns void
- disableDepthRender: boolean = false
get
-
Get the class name
Returns string
"SSAORenderingPipeline"
set
-
Sets the required values to the prepass renderer.
Parameters
- prePassRenderer: PrePassRenderer
defines the prepass renderer to setup.
Returns boolean
true if the pre pass is needed.
- prePassRenderer: PrePassRenderer
Render pipeline to produce ssao effect