API
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/features/featuresDeepDive/postProcesses/defaultRenderingPipeline

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Instantiates a DefaultRenderingPipeline.

    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

fxaa: FxaaPostProcess

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

grainSearch playground for grain

grain: GrainPostProcess

Grain post process which add noise to the image

imageProcessingSearch playground for imageProcessing

imageProcessing: ImageProcessingPostProcess

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/toolsAndResources/inspector#extensibility

onBuildObservableSearch playground for onBuildObservable

onBuildObservable: Observable<DefaultRenderingPipeline>

This is triggered each time the pipeline has been built.

sharpenSearch playground for sharpen

sharpen: SharpenPostProcess

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

Accessors

automaticBuild

  • get automaticBuild(): boolean
  • set automaticBuild(value: boolean): void

  • Enable or disable automatic building of the pipeline when effects are enabled and disabled. If false, you will have to manually call prepare() to update the pipeline.

    Returns boolean

  • Enable or disable automatic building of the pipeline when effects are enabled and disabled. If false, you will have to manually call prepare() to update the pipeline.

    Parameters

    • value: boolean

    Returns void

bloomEnabled

  • get bloomEnabled(): boolean
  • set bloomEnabled(enabled: boolean): void

  • Enable or disable the bloom from the pipeline

    Returns boolean

  • Enable or disable the bloom from the pipeline

    Parameters

    • enabled: boolean

    Returns void

bloomKernel

  • get bloomKernel(): number
  • set bloomKernel(value: number): void

  • 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

bloomScale

  • get bloomScale(): number
  • set bloomScale(value: number): void

  • 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

bloomThreshold

  • get bloomThreshold(): number
  • set bloomThreshold(value: number): void

  • 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

bloomWeight

  • get bloomWeight(): number
  • set bloomWeight(value: number): void

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

chromaticAberrationEnabled

  • get chromaticAberrationEnabled(): boolean
  • set chromaticAberrationEnabled(enabled: boolean): void

  • 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

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 void

depthOfFieldEnabled

  • get depthOfFieldEnabled(): boolean
  • set depthOfFieldEnabled(enabled: boolean): void

  • If the depth of field is enabled.

    Returns boolean

  • If the depth of field is enabled.

    Parameters

    • enabled: boolean

    Returns void

fxaaEnabled

  • get fxaaEnabled(): boolean
  • set fxaaEnabled(enabled: boolean): void

  • If the anti aliasing is enabled.

    Returns boolean

  • If the anti aliasing is enabled.

    Parameters

    • enabled: boolean

    Returns void

glowLayer

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

    Returns Nullable<GlowLayer>

glowLayerEnabled

  • get glowLayerEnabled(): boolean
  • set glowLayerEnabled(enabled: boolean): void

  • 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

grainEnabled

  • get grainEnabled(): boolean
  • set grainEnabled(enabled: boolean): void

  • 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

imageProcessingEnabled

  • get imageProcessingEnabled(): boolean
  • set imageProcessingEnabled(enabled: boolean): void

  • If image processing is enabled.

    Returns boolean

  • If image processing is enabled.

    Parameters

    • enabled: boolean

    Returns void

isSupported

  • get isSupported(): boolean

  • If all the render effects in the pipeline are supported

    Returns boolean

name

  • get name(): string

  • Gets pipeline name

    Returns string

samples

  • get samples(): number
  • set samples(sampleCount: number): void

  • 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

sharpenEnabled

  • get sharpenEnabled(): boolean
  • set sharpenEnabled(enabled: boolean): void

  • 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

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
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Property
  • Method
  • Static method

Settings

Theme