StandardRenderingPipeline

Standard rendering pipeline Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.

see

https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline

Hierarchy

Implements

Index

Constructors

constructor

  • Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.

    constructor

    Parameters

    • name: string

      The rendering pipeline name

    • scene: Scene

      The scene linked to this pipeline

    • ratio: number

      The size of the postprocesses (0.5 means that your postprocess will have a width = canvas.width 0.5 and a height = canvas.height 0.5)

    • Optional originalPostProcess: Nullable<PostProcess>

      the custom original color post-process. Must be "reusable". Can be null.

    • Optional cameras: Camera[]

      The array of cameras that the rendering pipeline will be attached to

    Returns StandardRenderingPipeline

Properties

BloomEnabled

BloomEnabled: boolean

Specifies if the bloom pipeline is enabled

DepthOfFieldEnabled

DepthOfFieldEnabled: boolean

Specifies if the depth of field pipeline is enabed

HDREnabled

HDREnabled: boolean

Specifies if the HDR pipeline is enabled

LensFlareEnabled

LensFlareEnabled: boolean

Specifies if the lens flare pipeline is enabed

MotionBlurEnabled

MotionBlurEnabled: boolean

Specifies if the motion blur effect is enabled

VLSEnabled

VLSEnabled: boolean

Specifies if the volumetric lights scattering effect is enabled

animations

animations: Animation[]

List of animations for the pipeline (IAnimatable implementation)

blurHPostProcesses

blurHPostProcesses: PostProcess[]

Post-process array storing all the horizontal blur post-processes used by the pipeline

blurVPostProcesses

blurVPostProcesses: PostProcess[]

Post-process array storing all the vertical blur post-processes used by the pipeline

blurWidth

blurWidth: number

Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)

brightPassPostProcess

brightPassPostProcess: Nullable<PostProcess>

Post-process used to calculate the illuminated surfaces controlled by a threshold

brightThreshold

brightThreshold: number

Represents the brightness threshold in order to configure the illuminated surfaces

depthOfFieldBlurWidth

depthOfFieldBlurWidth: number

Represents the blur intensity for the blurred part of the depth of field effect

depthOfFieldDistance

depthOfFieldDistance: number

Represents the focal length for the depth of field effect

depthOfFieldPostProcess

depthOfFieldPostProcess: Nullable<PostProcess>

Post-process used to create a depth of field effect

downSampleX4PostProcess

downSampleX4PostProcess: Nullable<PostProcess>

Post-process used to down scale an image x4

exposure

exposure: number

Sets the overall exposure used by the pipeline

fxaaEnabled

fxaaEnabled: boolean

Specifies if anti-aliasing is enabled

fxaaPostProcess

fxaaPostProcess: Nullable<FxaaPostProcess>

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

hdrDecreaseRate

hdrDecreaseRate: number

For eye adaptation, represents the decrease luminance speed

hdrFinalPostProcess

hdrFinalPostProcess: Nullable<PostProcess>

Post-process used to merge the final HDR post-process and the real scene color

hdrIncreaseRate

hdrIncreaseRate: number

For eye adaptation, represents the increase luminance speed

hdrMinimumLuminance

hdrMinimumLuminance: number

For eye adaptation, represents the minimum luminance the eye can see

hdrPostProcess

hdrPostProcess: Nullable<PostProcess>

Post-process used to create a HDR effect (light adaptation)

horizontalBlur

horizontalBlur: boolean

Sets if the blur for highlighted surfaces must be only horizontal

isSupported

isSupported: boolean

If all the render effects in the pipeline are support

lensColorTexture

lensColorTexture: Nullable<Texture>

Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled

lensFlareComposePostProcess

lensFlareComposePostProcess: Nullable<PostProcess>

Post-process that merges the result of the lens flare post-process and the real scene color

lensFlareDirtTexture

lensFlareDirtTexture: Nullable<Texture>

As the "lensTexture" (can be the same texture or different), it is used to apply the lens flare effect by taking account of the dirt texture

lensFlareDistortionStrength

lensFlareDistortionStrength: number

Based on the lens distortion effect, defines how much the lens flare result is distorted

lensFlareFinalPostProcess

lensFlareFinalPostProcess: Nullable<PostProcess>

Post-process used to store the final lens flare post-process (attach/detach for debug purpose)

lensFlareGhostDispersal

lensFlareGhostDispersal: number

Dispersion coefficient for lens flare ghosts

lensFlareHaloWidth

lensFlareHaloWidth: number

Main lens flare halo width

lensFlarePostProcess

lensFlarePostProcess: Nullable<PostProcess>

Post-process used to create a lens flare effect

lensFlareStrength

lensFlareStrength: number

The overall strengh for the lens flare effect

lensStarTexture

lensStarTexture: Nullable<Texture>

Lens star texture must be used to simulate rays on the flares and is available in the documentation

lensTexture

lensTexture: Nullable<Texture>

Texture used typically to simulate "dirty" on camera lens

luminanceDownSamplePostProcesses

luminanceDownSamplePostProcesses: PostProcess[]

Post-processes used to create down sample post-processes in order to get the average luminance of the final image for HDR Array of length "StandardRenderingPipeline.LuminanceSteps"

luminancePostProcess

luminancePostProcess: Nullable<PostProcess>

Base post-process used to calculate the average luminance of the final image for HDR

motionBlurPostProcess

motionBlurPostProcess: Nullable<PostProcess>

Post-process used to create a motion blur effect

motionBlurSamples

motionBlurSamples: number

Specifies the number of samples used for the motion blur effect Typically in interval [16, 64]

motionStrength

motionStrength: number

For motion blur, defines how much the image is blurred by the movement

originalPostProcess

originalPostProcess: Nullable<PostProcess>

Post-process which contains the original scene color before the pipeline applies all the effects

samples

samples: number

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

sourceLight

Light (spot or directional) used to generate the volumetric lights rays The source light must have a shadow generate so the pipeline can get its depth map

textureAdderFinalPostProcess

textureAdderFinalPostProcess: Nullable<PostProcess>

Post-process used to store the final texture adder post-process (attach/detach for debug purpose)

textureAdderPostProcess

textureAdderPostProcess: Nullable<PostProcess>

Post-process used to add colors of 2 textures (typically brightness + real scene color)

volumetricLightBlurScale

volumetricLightBlurScale: number

Used the set the blur intensity to smooth the volumetric lights

volumetricLightCoefficient

volumetricLightCoefficient: number

Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]

volumetricLightFinalPostProcess

volumetricLightFinalPostProcess: Nullable<PostProcess>

Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)

volumetricLightMergePostProces

volumetricLightMergePostProces: Nullable<PostProcess>

Post-process used to merge the volumetric light effect and the real scene color

volumetricLightPostProcess

volumetricLightPostProcess: Nullable<PostProcess>

Post-process used to create volumetric lighting effect

volumetricLightPower

volumetricLightPower: number

The overall power of volumetric lights, typically in interval [0, 10] maximum

volumetricLightSmoothXPostProcess

volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>

Post-process used to smooth the previous volumetric light post-process on the X axis

volumetricLightSmoothYPostProcess

volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>

Post-process used to smooth the previous volumetric light post-process on the Y axis

volumetricLightStepsCount

volumetricLightStepsCount: number

Specifies the number of steps used to calculate the volumetric lights Typically in interval [50, 200]

Static LuminanceSteps

LuminanceSteps: number

Methods

addEffect

dispose

  • dispose(): void

getClassName

  • getClassName(): string

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 StandardRenderingPipeline

    An instantiated pipeline from the serialized object.

Generated using TypeDoc