Class SSAO2RenderingPipeline
Hierarchy
- PostProcessRenderPipeline
- SSAO2RenderingPipeline
Index
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, blurRatio: 1.0 }
Optional cameras: Camera[]
The array of cameras that the rendering pipeline will be attached to
Optional forceGeometryBuffer: boolean
Set to true if you want to use the legacy geometry buffer renderer
Optional textureType: number
The texture type used by the different post processes created by SSAO (default: Constants.TEXTURETYPE_UNSIGNED_INT)
Returns SSAO2RenderingPipeline
Properties
baseSearch playground for base
The base color of the SSAO post-process The final result is "base + ssao" between [0, 1]
inspectable Custom PropertiesSearch playground for inspectableCustomProperties
List of inspectable custom properties (used by the Inspector)
maxZSearch playground for maxZ
Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
minZAspectSearch playground for minZAspect
In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
radiusSearch playground for radius
The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
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[]
expensive Blur
If bilateral blur should be used
Returns boolean
If bilateral blur should be used
Parameters
b: boolean
Returns void
is Supported
If all the render effects in the pipeline are supported
Returns boolean
name
Gets pipeline name
Returns string
samples
Number of samples used for the SSAO calculations. Default value is 8
Returns number
Number of samples used for the SSAO calculations. Default value is 8
Parameters
n: number
Returns void
scene
Gets active scene
Returns Scene
texture Samples
Number of samples to use for antialiasing
Returns number
Number of samples to use for antialiasing
Parameters
n: number
Returns void
Static Is Supported
Support test.
Returns boolean
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 detaches the pipeline from the scene cameras
Parameters
Optional disableGeometryBufferRenderer: boolean
Returns void
get Class NameSearch playground for getClassName
Get the class name
Returns string
"SSAO2RenderingPipeline"
serializeSearch playground for serialize
Serialize the rendering pipeline (Used when exporting)
Returns any
the serialized object
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.
Static ParseSearch playground for Parse
Parse the serialized pipeline
Parameters
source: any
Source pipeline.
scene: Scene
The scene to load the pipeline to.
rootUrl: string
The URL of the serialized pipeline.
Returns SSAO2RenderingPipeline
An instantiated pipeline from the serialized object.
Render pipeline to produce ssao effect