DefaultRenderingPipeline

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

Hierarchy

Implements

Index

Constructors

constructor

Find examples in Playground
  • 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

animations

Find examples in Playground
animations: Animation[]

Animations which can be used to tweak settings over a period of time

bloomEnabled

Find examples in Playground
bloomEnabled: boolean

Enable or disable the bloom from the pipeline

bloomKernel

Find examples in Playground
bloomKernel: number

Specifies the size of the bloom blur kernel, relative to the final output size

bloomScale

Find examples in Playground
bloomScale: number

The scale of the bloom, lower value will provide better performance.

bloomThreshold

Find examples in Playground
bloomThreshold: number

The strength of the bloom.

bloomWeight

Find examples in Playground
bloomWeight: number

The strength of the bloom.

chromaticAberration

Find examples in Playground
chromaticAberration: ChromaticAberrationPostProcess

Chromatic aberration post process which will shift rgb colors in the image

chromaticAberrationEnabled

Find examples in Playground
chromaticAberrationEnabled: boolean

Enable or disable the chromaticAberration process from the pipeline

depthOfField

Find examples in Playground
depthOfField: DepthOfFieldEffect

Depth of field effect, applies a blur based on how far away objects are from the focus distance.

depthOfFieldBlurLevel

Find examples in Playground
depthOfFieldBlurLevel: DepthOfFieldEffectBlurLevel

Blur level of the depth of field effect. (Higher blur will effect performance)

depthOfFieldEnabled

Find examples in Playground
depthOfFieldEnabled: boolean

If the depth of field is enabled.

fxaa

Find examples in Playground

The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.

fxaaEnabled

Find examples in Playground
fxaaEnabled: boolean

If the anti aliasing is enabled.

glowLayerEnabled

Find examples in Playground
glowLayerEnabled: boolean

If glow layer is enabled. (Adds a glow effect to emmissive materials)

grain

Find examples in Playground

Grain post process which add noise to the image

grainEnabled

Find examples in Playground
grainEnabled: boolean

Enable or disable the grain process from the pipeline

imageProcessing

Find examples in Playground

Image post processing pass used to perform operations such as tone mapping or color grading.

imageProcessingEnabled

Find examples in Playground
imageProcessingEnabled: boolean

If image processing is enabled.

isSupported

Find examples in Playground
isSupported: boolean

If all the render effects in the pipeline are support

samples

Find examples in Playground
samples: number

MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)

sharpen

Find examples in Playground

Sharpen post process which will apply a sharpen convolution to enhance edges

sharpenEnabled

Find examples in Playground
sharpenEnabled: boolean

Enable or disable the sharpen process from the pipeline

Methods

addCamera

Find examples in Playground
  • addCamera(camera: Camera): void
  • Adds a camera to the pipeline

    Parameters

    • camera: Camera

      the camera to be added

    Returns void

addEffect

Find examples in Playground

dispose

Find examples in Playground
  • dispose(): void

getClassName

Find examples in Playground
  • getClassName(): string

prepare

Find examples in Playground
  • prepare(): void
  • Force the compilation of the entire pipeline.

    Returns void

removeCamera

Find examples in Playground
  • removeCamera(camera: Camera): void
  • Removes a camera from the pipeline

    Parameters

    • camera: Camera

      the camera to remove

    Returns void

serialize

Find examples in Playground
  • serialize(): any
  • Serialize the rendering pipeline (Used when exporting)

    Returns any

    the serialized object

Static Parse

Find examples in Playground
  • 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.

Generated using TypeDoc