Class PostProcessRenderPipelineManager
Constructors
constructor
-
Initializes a PostProcessRenderPipelineManager
Returns PostProcessRenderPipelineManager
Accessors
on
-
get onNewPipelineAddedObservable(): IReadonlyObservable<
PostProcessRenderPipeline,
>An event triggered when a pipeline is added to the manager
Returns IReadonlyObservable<PostProcessRenderPipeline>
on
-
get onPipelineRemovedObservable(): IReadonlyObservable<
PostProcessRenderPipeline,
>An event triggered when a pipeline is removed from the manager
Returns IReadonlyObservable<PostProcessRenderPipeline>
supported
-
get supportedPipelines(): PostProcessRenderPipeline[]
Gets the list of supported render pipelines
Returns PostProcessRenderPipeline[]
Methods
add
-
Adds a pipeline to the manager
Parameters
- renderPipeline: PostProcessRenderPipeline
The pipeline to add
Returns void
- renderPipeline: PostProcessRenderPipeline
attach
-
Attaches a camera to the pipeline
Parameters
- renderPipelineName: string
The name of the pipeline to attach to
- cameras: any
the camera to attach
- unique: boolean = false
if the camera can be attached multiple times to the pipeline
Returns void
- renderPipelineName: string
detach
-
Detaches a camera from the pipeline
Parameters
- renderPipelineName: string
The name of the pipeline to detach from
- cameras: any
the camera to detach
Returns void
- renderPipelineName: string
disable
-
Disables an effect by name on a pipeline
Parameters
- renderPipelineName: string
the name of the pipeline to disable the effect in
- renderEffectName: string
the name of the effect to disable
- cameras: any
the cameras that the effect should be disabled on
Returns void
- renderPipelineName: string
dispose
-
Disposes of the manager and pipelines
Returns void
enable
-
Enables an effect by name on a pipeline
Parameters
- renderPipelineName: string
the name of the pipeline to enable the effect in
- renderEffectName: string
the name of the effect to enable
- cameras: any
the cameras that the effect should be enabled on
Returns void
- renderPipelineName: string
remove
-
Remove the pipeline from the manager
Parameters
- renderPipelineName: string
the name of the pipeline to remove
Returns void
- renderPipelineName: string
update
-
Updates the state of all contained render pipelines and disposes of any non supported pipelines
Returns void
PostProcessRenderPipelineManager class
See
https://doc.babylonjs.com/features/featuresDeepDive/postProcesses/postProcessRenderPipeline