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

  • 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

FxaaPostProcessId

FxaaPostProcessId: string

ID of the Fast Approximate Anti-Aliasing post process;

ImageProcessingPostProcessId

ImageProcessingPostProcessId: string

ID of the image processing post process;

animations

animations: Animation[]

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

bloomEnabled

bloomEnabled: boolean

Enable or disable the bloom from the pipeline

bloomKernel

bloomKernel: number

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

bloomScale

bloomScale: number

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

bloomThreshold

bloomThreshold: number

The strength of the bloom.

bloomWeight

bloomWeight: number

The strength of the bloom.

chromaticAberration

chromaticAberration: ChromaticAberrationPostProcess

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

chromaticAberrationEnabled

chromaticAberrationEnabled: boolean

Enable or disable the chromaticAberration process from the pipeline

depthOfField

depthOfField: DepthOfFieldEffect

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

depthOfFieldBlurLevel

depthOfFieldBlurLevel: DepthOfFieldEffectBlurLevel

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

depthOfFieldEnabled

depthOfFieldEnabled: boolean

If the depth of field is enabled.

fxaa

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

fxaaEnabled

fxaaEnabled: boolean

If the anti aliasing is enabled.

glowLayerEnabled

glowLayerEnabled: boolean

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

grain

Grain post process which add noise to the image

grainEnabled

grainEnabled: boolean

Enable or disable the grain process from the pipeline

imageProcessing

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

imageProcessingEnabled

imageProcessingEnabled: boolean

If image processing is enabled.

isSupported

isSupported: boolean

samples

samples: number

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

sharpen

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

sharpenEnabled

sharpenEnabled: boolean

Enable or disable the sharpen process from the pipeline

Methods

addCamera

  • addCamera(camera: Camera): void
  • Adds a camera to the pipeline

    Parameters

    • camera: Camera

      the camera to be added

    Returns void

addEffect

dispose

  • dispose(): void

getClassName

  • getClassName(): string

prepare

  • prepare(): void
  • Force the compilation of the entire pipeline.

    Returns void

removeCamera

  • removeCamera(camera: Camera): void
  • Removes a camera from the pipeline

    Parameters

    • camera: Camera

      the camera to remove

    Returns void

serialize

  • serialize(): any
  • Serialize the rendering pipeline (Used when exporting)

    Returns any

    the serialized object

Static 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.

Generated using TypeDoc