Options
All
  • Public
  • Public/Protected
  • All
Menu

Class 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

  • 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: Animation[]

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

chromaticAberrationSearch playground for chromaticAberration

chromaticAberration: ChromaticAberrationPostProcess

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

depthOfFieldSearch playground for depthOfField

depthOfField: DepthOfFieldEffect

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 attemps to remove aliasing from an image.

grainSearch playground for grain

Grain post process which add noise to the image

imageProcessingSearch playground for imageProcessing

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

inspectableCustomPropertiesSearch playground for inspectableCustomProperties

inspectableCustomProperties: IInspectable[]

List of inspectable custom properties (used by the Inspector)

see

https://doc.babylonjs.com/how_to/debug_layer#extensibility

onBuildObservableSearch 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

bloomEnabled

  • get bloomEnabled(): boolean
  • set bloomEnabled(enabled: boolean): any
  • Enable or disable the bloom from the pipeline

    Returns boolean

  • Enable or disable the bloom from the pipeline

    Parameters

    • enabled: boolean

    Returns any

bloomKernel

  • get bloomKernel(): number
  • set bloomKernel(value: number): any
  • 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 any

bloomScale

  • get bloomScale(): number
  • set bloomScale(value: number): any
  • 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 any

bloomThreshold

  • get bloomThreshold(): number
  • set bloomThreshold(value: number): any
  • The strength of the bloom.

    Returns number

  • The strength of the bloom.

    Parameters

    • value: number

    Returns any

bloomWeight

  • get bloomWeight(): number
  • set bloomWeight(value: number): any
  • The strength of the bloom.

    Returns number

  • The strength of the bloom.

    Parameters

    • value: number

    Returns any

cameras

chromaticAberrationEnabled

  • get chromaticAberrationEnabled(): boolean
  • set chromaticAberrationEnabled(enabled: boolean): any
  • Enable or disable the chromaticAberration process from the pipeline

    Returns boolean

  • Enable or disable the chromaticAberration process from the pipeline

    Parameters

    • enabled: boolean

    Returns any

depthOfFieldBlurLevel

  • 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

    Returns any

depthOfFieldEnabled

  • get depthOfFieldEnabled(): boolean
  • set depthOfFieldEnabled(enabled: boolean): any
  • If the depth of field is enabled.

    Returns boolean

  • If the depth of field is enabled.

    Parameters

    • enabled: boolean

    Returns any

fxaaEnabled

  • get fxaaEnabled(): boolean
  • set fxaaEnabled(enabled: boolean): any
  • If the anti aliasing is enabled.

    Returns boolean

  • If the anti aliasing is enabled.

    Parameters

    • enabled: boolean

    Returns any

glowLayer

  • Gets the glow layer (or null if not defined)

    Returns Nullable<GlowLayer>

glowLayerEnabled

  • get glowLayerEnabled(): boolean
  • set glowLayerEnabled(enabled: boolean): any
  • 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 any

grainEnabled

  • get grainEnabled(): boolean
  • set grainEnabled(enabled: boolean): any
  • Enable or disable the grain process from the pipeline

    Returns boolean

  • Enable or disable the grain process from the pipeline

    Parameters

    • enabled: boolean

    Returns any

imageProcessingEnabled

  • get imageProcessingEnabled(): boolean
  • set imageProcessingEnabled(enabled: boolean): any
  • If image processing is enabled.

    Returns boolean

  • If image processing is enabled.

    Parameters

    • enabled: boolean

    Returns any

isSupported

  • get isSupported(): boolean

name

  • get name(): string

samples

  • get samples(): number
  • set samples(sampleCount: number): any
  • 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 any

scene

  • Gets active scene

    Returns Scene

sharpenEnabled

  • get sharpenEnabled(): boolean
  • set sharpenEnabled(enabled: boolean): any
  • Enable or disable the sharpen process from the pipeline

    Returns boolean

  • Enable or disable the sharpen process from the pipeline

    Parameters

    • enabled: boolean

    Returns any

Methods

addCameraSearch playground for addCamera

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

    Parameters

    • camera: Camera

      the camera to be added

    Returns void

addEffectSearch playground for addEffect

disposeSearch playground for dispose

  • dispose(): void

getClassNameSearch playground for getClassName

  • getClassName(): string

prepareSearch playground for prepare

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

    Returns void

removeCameraSearch playground for removeCamera

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

    Parameters

    • camera: Camera

      the camera to remove

    Returns void

serializeSearch playground for serialize

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

    Returns any

    the serialized object

setPrePassRendererSearch playground for setPrePassRenderer

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.

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static method