CLASSES
TagsA - Z

PostProcessRenderPipelineManager

PostProcess

Description

class PostProcessRenderPipelineManager

Managing all pipelines, allow you to enable or disable an effect, displaying a pass of post process for debugging.

A tutorial about the render pipeline can be found here : https://doc.babylonjs.com/tutorials/using_standard_rendering_pipeline

Constructor

new PostProcessRenderPipelineManager()

Builds a PostProcessRenderPipelineManager object

Methods

addPipeline(renderPipeline) → void

Adds a pipeline to the pool

Parameters

Name Type Description
renderPipeline PostProcessRenderPipeline The given pipeline

attachCamerasToRenderPipeline(renderPipelineName, cameras, unique) → any

Attach a render pipeline to a list(or unique) of cameras

Parameters

Name Type Description
renderPipelineName string The render pipeline name
cameras Camera The given camera or an array of cameras
optional unique boolean @param unique

attachCamerasToRenderPipeline(renderPipelineName, cameras, unique) → any

Attach a render pipeline to a list(or unique) of cameras

Parameters

Name Type Description
renderPipelineName string The render pipeline name
cameras Camera[] The given camera or an array of cameras
optional unique boolean @param unique

detachCamerasFromRenderPipeline(renderPipelineName, cameras) → any

Detach a render pipeline to a list(or unique) of cameras

Parameters

Name Type Description
renderPipelineName string The render pipeline name
cameras Camera The given camera or an array of cameras

detachCamerasFromRenderPipeline(renderPipelineName, cameras) → any

Detach a render pipeline to a list(or unique) of cameras

Parameters

Name Type Description
renderPipelineName string The render pipeline name
cameras Camera[] The given camera or an array of cameras

enableEffectInPipeline(renderPipelineName, renderEffectName, cameras) → any

Enable an effect in a pipeline for a list(or unique) of cameras

Parameters

Name Type Description
renderPipelineName string The render pipeline name
renderEffectName string The render effect name
cameras Camera The given camera or an array of cameras

enableEffectInPipeline(renderPipelineName, renderEffectName, cameras) → any

Enable an effect in a pipeline for a list(or unique) of cameras

Parameters

Name Type Description
renderPipelineName string The render pipeline name
renderEffectName string The render effect name
cameras Camera[] The given camera or an array of cameras

disableEffectInPipeline(renderPipelineName, renderEffectName, cameras) → any

Disable an effect in a pipeline for a list(or unique) of cameras

Parameters

Name Type Description
renderPipelineName string The render pipeline name
renderEffectName string The render effect name
cameras Camera The given camera or an array of cameras

disableEffectInPipeline(renderPipelineName, renderEffectName, cameras) → any

Disable an effect in a pipeline for a list(or unique) of cameras

Parameters

Name Type Description
renderPipelineName string The render pipeline name
renderEffectName string The render effect name
cameras Camera[] The given camera or an array of cameras

enableDisplayOnlyPassInPipeline(renderPipelineName, passName, cameras) → any

Enable displaying of a specific pass used in a specific render pipeline, for a list(or unique) of cameras

Parameters

Name Type Description
renderPipelineName string The render pipeline name
passName string The pass name
cameras Camera The given camera or an array of cameras

enableDisplayOnlyPassInPipeline(renderPipelineName, passName, cameras) → any

Enable displaying of a specific pass used in a specific render pipeline, for a list(or unique) of cameras

Parameters

Name Type Description
renderPipelineName string The render pipeline name
passName string The pass name
cameras Camera[] The given camera or an array of cameras

disableDisplayOnlyPassInPipeline(renderPipelineName, cameras) → any

Disable displaying of a specific pass used in a specific render pipeline, for a list(or unique) of cameras

Parameters

Name Type Description
renderPipelineName string The render pipeline name
cameras Camera The given camera or an array of cameras

disableDisplayOnlyPassInPipeline(renderPipelineName, cameras) → any

Disable displaying of a specific pass used in a specific render pipeline, for a list(or unique) of cameras

Parameters

Name Type Description
renderPipelineName string The render pipeline name
cameras Camera[] The given camera or an array of cameras

update() → void