Class DefaultRenderingPipeline
Hierarchy
- PostProcessRenderPipeline
- DefaultRenderingPipeline
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional name: string
The rendering pipeline name (default: "")
Optional hdr: boolean
If high dynamic range textures should be used (default: true)
Optional scene: Scene
The scene linked to this pipeline (default: the last created scene)
Optional cameras: Camera[]
The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
Optional automaticBuild: boolean
if false, you will have to manually call prepare() to update the pipeline (default: true)
Returns DefaultRenderingPipeline
Properties
animationsSearch playground for animations
Animations which can be used to tweak settings over a period of time
chromatic AberrationSearch playground for chromaticAberration
Chromatic aberration post process which will shift rgb colors in the image
depth Of FieldSearch playground for depthOfField
Depth of field effect, applies a blur based on how far away objects are from the focus distance.
fxaaSearch playground for fxaa
The Fast Approximate Anti-Aliasing post process which attempts to remove aliasing from an image.
grainSearch playground for grain
Grain post process which add noise to the image
image ProcessingSearch playground for imageProcessing
Image post processing pass used to perform operations such as tone mapping or color grading.
inspectable Custom PropertiesSearch playground for inspectableCustomProperties
List of inspectable custom properties (used by the Inspector)
on Build ObservableSearch playground for onBuildObservable
This is triggered each time the pipeline has been built.
sharpenSearch playground for sharpen
Sharpen post process which will apply a sharpen convolution to enhance edges
Accessors
bloom Enabled
Enable or disable the bloom from the pipeline
Returns boolean
Enable or disable the bloom from the pipeline
Parameters
enabled: boolean
Returns void
bloom Kernel
Specifies the size of the bloom blur kernel, relative to the final output size
Returns number
Specifies the size of the bloom blur kernel, relative to the final output size
Parameters
value: number
Returns void
bloom Scale
The scale of the bloom, lower value will provide better performance.
Returns number
The scale of the bloom, lower value will provide better performance.
Parameters
value: number
Returns void
bloom Threshold
The luminance threshold to find bright areas of the image to bloom.
Returns number
The luminance threshold to find bright areas of the image to bloom.
Parameters
value: number
Returns void
bloom Weight
The strength of the bloom.
Returns number
The strength of the bloom.
Parameters
value: number
Returns void
cameras
Gets the list of attached cameras
Returns Camera[]
chromatic Aberration Enabled
Enable or disable the chromaticAberration process from the pipeline
Returns boolean
Enable or disable the chromaticAberration process from the pipeline
Parameters
enabled: boolean
Returns void
depth Of Field Blur Level
Blur level of the depth of field effect. (Higher blur will effect performance)
Returns DepthOfFieldEffectBlurLevel
Blur level of the depth of field effect. (Higher blur will effect performance)
Parameters
value: DepthOfFieldEffectBlurLevel
Returns void
depth Of Field Enabled
If the depth of field is enabled.
Returns boolean
If the depth of field is enabled.
Parameters
enabled: boolean
Returns void
fxaa Enabled
If the anti aliasing is enabled.
Returns boolean
If the anti aliasing is enabled.
Parameters
enabled: boolean
Returns void
glow Layer
glow Layer Enabled
If glow layer is enabled. (Adds a glow effect to emmissive materials)
Returns boolean
If glow layer is enabled. (Adds a glow effect to emmissive materials)
Parameters
enabled: boolean
Returns void
grain Enabled
Enable or disable the grain process from the pipeline
Returns boolean
Enable or disable the grain process from the pipeline
Parameters
enabled: boolean
Returns void
image Processing Enabled
If image processing is enabled.
Returns boolean
If image processing is enabled.
Parameters
enabled: boolean
Returns void
is Supported
If all the render effects in the pipeline are supported
Returns boolean
name
Gets pipeline name
Returns string
samples
MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
Returns number
MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
Parameters
sampleCount: number
Returns void
scene
Gets active scene
Returns Scene
sharpen Enabled
Enable or disable the sharpen process from the pipeline
Returns boolean
Enable or disable the sharpen process from the pipeline
Parameters
enabled: boolean
Returns void
Methods
add CameraSearch playground for addCamera
Adds a camera to the pipeline
Parameters
camera: Camera
the camera to be added
Returns void
add EffectSearch playground for addEffect
Adds an effect to the pipeline
Parameters
renderEffect: PostProcessRenderEffect
the effect to add
Returns void
disposeSearch playground for dispose
Dispose of the pipeline and stop all post processes
Returns void
get Class NameSearch playground for getClassName
Get the class name
Returns string
"DefaultRenderingPipeline"
prepareSearch playground for prepare
Force the compilation of the entire pipeline.
Returns void
remove CameraSearch playground for removeCamera
Removes a camera from the pipeline
Parameters
camera: Camera
the camera to remove
Returns void
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 DefaultRenderingPipeline
An instantiated pipeline from the serialized object.
The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field. See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline