Class SSAORenderingPipeline
Hierarchy
-
PostProcessRenderPipeline
- SSAORenderingPipeline
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
Parameters
-
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 }
-
Optional cameras: Camera[]
The array of cameras that the rendering pipeline will be attached to
Returns SSAORenderingPipeline
-
Properties
areaSearch playground for 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
baseSearch playground for base
The base color of the SSAO post-process The final result is "base + ssao" between [0, 1]
fall OffSearch playground for fallOff
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 Custom PropertiesSearch playground for inspectableCustomProperties
List of inspectable custom properties (used by the Inspector)
radiusSearch playground for radius
The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
total StrengthSearch playground for totalStrength
The output strength of the SSAO post-process. Default value is 1.0.
Accessors
cameras
-
Gets the list of attached cameras
Returns Camera[]
is Supported
-
If all the render effects in the pipeline are supported
Returns boolean
name
-
Gets pipeline name
Returns string
scene
-
Gets active scene
Returns Scene
Methods
add EffectSearch playground for addEffect
-
Adds an effect to the pipeline
Parameters
-
renderEffect: PostProcessRenderEffect
the effect to add
Returns void
-
disposeSearch playground for dispose
-
Removes the internal pipeline assets and detatches the pipeline from the scene cameras
Parameters
-
Optional disableDepthRender: boolean
Returns void
-
get Class NameSearch playground for getClassName
-
Get the class name
Returns string
"SSAORenderingPipeline"
set Pre Pass RendererSearch playground for setPrePassRenderer
-
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.
-
Render pipeline to produce ssao effect