PostProcessRenderEffect

Class PostProcessRenderEffect

This represents a set of one or more post processes in Babylon. A post process can be used to apply a shader to a texture after it is rendered.

example: https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline

Hierarchy

PostProcessRenderEffect
- BloomEffect
- DepthOfFieldEffect

Index

Constructors

constructor

Accessors

isSupported

Methods

getPostProcesses

Constructors

constructor

new PostProcessRenderEffect(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean): PostProcessRenderEffect

- Defined in .temp/docdirectory/doc.d.ts:82926
Instantiates a post process render effect. A post process can be used to apply a shader to a texture after it is rendered.

Parameters
- engine: Engine
  
  The engine the effect is tied to
- name: string
  
  The name of the effect
- getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>
  
  A function that returns a set of post processes which the effect will run in order to be run.
  - - (): Nullable<PostProcess | Array<PostProcess>>
    - Returns Nullable<PostProcess | Array<PostProcess>>
- Optional singleInstance: boolean
  
  False if this post process can be run on multiple cameras. (default: true)
Returns PostProcessRenderEffect

Accessors

isSupported

get isSupported(): boolean

- Defined in .temp/docdirectory/doc.d.ts:82939
Checks if all the post processes in the effect are supported.

Returns boolean

Methods

getPostProcessesSearch playground for getPostProcesses

getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>

- Defined in .temp/docdirectory/doc.d.ts:82998
Gets a list of the post processes contained in the effect.

Parameters
- Optional camera: Camera
  
  The camera to get the post processes on.
Returns Nullable<Array<PostProcess>>

The list of the post processes in the effect.