ImageProcessingPostProcess | Babylon.js API documentation

Class ImageProcessingPostProcess

ImageProcessingPostProcess

See

https://doc.babylonjs.com/features/featuresDeepDive/postProcesses/usePostProcesses#imageprocessing

Hierarchy (View Summary)

PostProcess
- ImageProcessingPostProcess

Index

Constructors

constructor

Constructors

constructor

new ImageProcessingPostProcess(
    name: string,
    options: number | PostProcessOptions,
    camera?: Nullable<Camera>,
    samplingMode?: number,
    engine?: AbstractEngine,
    reusable?: boolean,
    textureType?: number,
    imageProcessingConfiguration?: ImageProcessingConfiguration,
): ImageProcessingPostProcess
Parameters
- name: string
- options: number | PostProcessOptions
- Optionalcamera: Nullable<Camera>
- OptionalsamplingMode: number
- Optionalengine: AbstractEngine
- Optionalreusable: boolean
- OptionaltextureType: number
- OptionalimageProcessingConfiguration: ImageProcessingConfiguration
Returns ImageProcessingPostProcess
Overrides PostProcess.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23113

Properties

adaptScaleToCurrentViewport

adaptScaleToCurrentViewport: boolean

Modify the scale of the post process to be the same as the viewport (default: false)

alphaConstants

alphaConstants: Color4

Sets the setAlphaBlendConstants of the babylon engine

alwaysForcePOT

alwaysForcePOT: boolean

Force textures to be a power of two (default: false)

animations

animations: Animation[]

Animations to be used for the post processing

autoClear

autoClear: boolean

If the buffer needs to be cleared before applying the post process. (default: true) Should be set to false if shader will overwrite all previous pixels.

clearColor

clearColor: Color4

Clear color to use when screen clearing

enablePixelPerfectMode

enablePixelPerfectMode: boolean

Enable Pixel Perfect mode where texture is not scaled to be power of 2. Can only be used on a single postprocess or on the last one of a chain. (default: false)

externalTextureSamplerBinding

externalTextureSamplerBinding: boolean

if externalTextureSamplerBinding is true, the "apply" method won't bind the textureSampler texture, it is expected to be done by the "outside" (by the onApplyObservable observer most probably). counter-productive in some cases because if the texture bound by "apply" is different from the currently texture bound, (the one set by the onApplyObservable observer, for eg) some internal structures (materialContext) will be dirtified, which may impact performances

forceAutoClearInAlphaMode

forceAutoClearInAlphaMode: boolean

If clearing the buffer should be forced in autoClear mode, even when alpha mode is enabled (default: false). By default, the buffer will only be cleared if alpha mode is disabled (and autoClear is true).

forceFullscreenViewport

forceFullscreenViewport: boolean

Force the postprocess to be applied without taking in account viewport

height

height: number

Height of the texture to apply the post process on

inspectableCustomProperties

inspectableCustomProperties: IInspectable[]

List of inspectable custom properties (used by the Inspector)

See

https://doc.babylonjs.com/toolsAndResources/inspector#extensibility

nodeMaterialSource

nodeMaterialSource: Nullable<NodeMaterial>

Gets the node material used to create this postprocess (null if the postprocess was manually created)

onActivateObservable

onActivateObservable: Observable<Camera>

An event triggered when the postprocess is activated.

onAfterRenderObservable

onAfterRenderObservable: Observable<Effect>

An event triggered after rendering the postprocess

onApplyObservable

onApplyObservable: Observable<Effect>

An event triggered when the postprocess applies its effect.

onBeforeRenderObservable

onBeforeRenderObservable: Observable<Effect>

An event triggered before rendering the postprocess

`Readonly`onDisposeObservable

onDisposeObservable: Observable<void>

An event triggered when the post-process is disposed

onEffectCreatedObservable

onEffectCreatedObservable: Observable<Effect>

Executed when the effect was created

Returns

effect that was created for this post process

onSizeChangedObservable

onSizeChangedObservable: Observable<PostProcess>

An event triggered when the postprocess changes its size.

renderTargetSamplingMode

renderTargetSamplingMode: number

Sampling mode used by the shader

scaleMode

scaleMode: number

Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)

Value	Type	Description
1	SCALEMODE_FLOOR	engine.scalemode_floor
2	SCALEMODE_NEAREST	engine.scalemode_nearest
3	SCALEMODE_CEILING	engine.scalemode_ceiling

uniqueId

uniqueId: number

Gets or sets the unique id of the post process

width

width: number

Width of the texture to apply the post process on

Accessors

alphaMode

get alphaMode(): number
Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)

Returns number
Inherited from PostProcess.alphaMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22426
set alphaMode(value: number): void
Parameters
- value: number
Returns void
Inherited from PostProcess.alphaMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22427

aspectRatio

get aspectRatio(): number
The aspect ratio of the output texture.

Returns number
Inherited from PostProcess.aspectRatio
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22712

colorCurves

get colorCurves(): Nullable<ColorCurves>
Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .

Returns Nullable<ColorCurves>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22947
set colorCurves(value: Nullable<ColorCurves>): void
Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
Parameters
- value: Nullable<ColorCurves>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22951

colorCurvesEnabled

get colorCurvesEnabled(): boolean
Gets whether the color curves effect is enabled.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22955
set colorCurvesEnabled(value: boolean): void
Sets whether the color curves effect is enabled.
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22959

colorGradingEnabled

get colorGradingEnabled(): boolean
Gets whether the color grading effect is enabled.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22971
set colorGradingEnabled(value: boolean): void
Gets whether the color grading effect is enabled.
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22975

colorGradingTexture

get colorGradingTexture(): Nullable<BaseTexture>
Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.

Returns Nullable<BaseTexture>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22963
set colorGradingTexture(value: Nullable<BaseTexture>): void
Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
Parameters
- value: Nullable<BaseTexture>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22967

contrast

get contrast(): number
Gets contrast used in the effect.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23003
set contrast(value: number): void
Sets contrast used in the effect.
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23007

ditheringEnabled

get ditheringEnabled(): boolean
Gets whether the dithering effect is enabled.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23099
set ditheringEnabled(value: boolean): void
Sets whether the dithering effect is enabled.
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23103

ditheringIntensity

get ditheringIntensity(): number
Gets intensity of the dithering effect.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23091
set ditheringIntensity(value: number): void
Sets intensity of the dithering effect.
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23095

exposure

get exposure(): number
Gets exposure used in the effect.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22979
set exposure(value: number): void
Sets exposure used in the effect.
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22983

fromLinearSpace

get fromLinearSpace(): boolean
Gets whether the input of the processing is in Gamma or Linear Space.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23107
set fromLinearSpace(value: boolean): void
Sets whether the input of the processing is in Gamma or Linear Space.
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23111

imageProcessingConfiguration

get imageProcessingConfiguration(): ImageProcessingConfiguration
Gets the image processing configuration used either in this material.

Returns ImageProcessingConfiguration
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22933
set imageProcessingConfiguration(value: ImageProcessingConfiguration): void
Sets the Default image processing configuration used either in the this material.

If sets to null, the scene one is in use.
Parameters
- value: ImageProcessingConfiguration
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22939

inputTexture

get inputTexture(): RenderTargetWrapper
The input texture for this post process and the output texture of the previous post process. When added to a pipeline the previous post process will render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.

Returns RenderTargetWrapper
Inherited from PostProcess.inputTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22591
set inputTexture(value: RenderTargetWrapper): void
Parameters
- value: RenderTargetWrapper
Returns void
Inherited from PostProcess.inputTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22592

isSupported

get isSupported(): boolean
If the post process is supported.

Returns boolean
Overrides PostProcess.isSupported
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22943

name

get name(): string
Name of the PostProcess.

Returns string
Inherited from PostProcess.name
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22386
set name(value: string): void
Parameters
- value: string
Returns void
Inherited from PostProcess.name
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22387

onActivate

set onActivate(callback: Nullable<(camera: Camera) => void>): void
A function that is added to the onActivateObservable
Parameters
- callback: Nullable<(camera: Camera) => void>
Returns void
Inherited from PostProcess.onActivate
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22546

onAfterRender

set onAfterRender(callback: (efect: Effect) => void): void
A function that is added to the onAfterRenderObservable
Parameters
- callback: (efect: Effect) => void
Returns void
Inherited from PostProcess.onAfterRender
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22582

onApply

set onApply(callback: (effect: Effect) => void): void
A function that is added to the onApplyObservable
Parameters
- callback: (effect: Effect) => void
Returns void
Inherited from PostProcess.onApply
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22564

onBeforeRender

set onBeforeRender(callback: (effect: Effect) => void): void
A function that is added to the onBeforeRenderObservable
Parameters
- callback: (effect: Effect) => void
Returns void
Inherited from PostProcess.onBeforeRender
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22573

onSizeChanged

set onSizeChanged(callback: (postProcess: PostProcess) => void): void
A function that is added to the onSizeChangedObservable
Parameters
- callback: (postProcess: PostProcess) => void
Returns void
Inherited from PostProcess.onSizeChanged
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22555

samples

get samples(): number
Number of sample textures (default: 1)

Returns number
Inherited from PostProcess.samples
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22469
set samples(n: number): void
Parameters
- n: number
Returns void
Inherited from PostProcess.samples
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22470

shaderLanguage

get shaderLanguage(): ShaderLanguage
Gets the shader language type used to generate vertex and fragment source code.

Returns ShaderLanguage
Inherited from PostProcess.shaderLanguage
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22489

texelSize

get texelSize(): Vector2
Gets the texel size of the postprocess. See https://en.wikipedia.org/wiki/Texel_(graphics)

Returns Vector2
Inherited from PostProcess.texelSize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22607

toneMappingEnabled

get toneMappingEnabled(): boolean
Gets whether tonemapping is enabled or not.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22987
set toneMappingEnabled(value: boolean): void
Sets whether tonemapping is enabled or not
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22991

toneMappingType

get toneMappingType(): number
Gets the type of tone mapping effect.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22995
set toneMappingType(value: number): void
Sets the type of tone mapping effect.
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22999

vignetteBlendMode

get vignetteBlendMode(): number
Gets the vignette blend mode allowing different kind of effect.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23075
set vignetteBlendMode(value: number): void
Sets the vignette blend mode allowing different kind of effect.
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23079

vignetteCameraFov

get vignetteCameraFov(): number
Gets Camera field of view used by the Vignette effect.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23067
set vignetteCameraFov(value: number): void
Sets Camera field of view used by the Vignette effect.
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23071

vignetteCenterX

get vignetteCenterX(): number
Vignette center X Offset.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23044
set vignetteCenterX(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23045

vignetteCenterY

get vignetteCenterY(): number
Vignette center Y Offset.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23039
set vignetteCenterY(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23040

vignetteCentreX

get vignetteCentreX(): number
Gets Vignette center X Offset.

Returns number
Deprecated
use vignetteCenterX instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23020
set vignetteCentreX(value: number): void
Sets Vignette center X Offset.
Parameters
- value: number
Returns void
Deprecated
use vignetteCenterX instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23025

vignetteCentreY

get vignetteCentreY(): number
Gets Vignette center Y Offset.

Returns number
Deprecated
use vignetteCenterY instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23030
set vignetteCentreY(value: number): void
Sets Vignette center Y Offset.
Parameters
- value: number
Returns void
Deprecated
use vignetteCenterY instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23035

vignetteColor

get vignetteColor(): Color4
Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode) if vignetteEnabled is set to true.

Returns Color4
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23058
set vignetteColor(value: Color4): void
Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode) if vignetteEnabled is set to true.
Parameters
- value: Color4
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23063

vignetteEnabled

get vignetteEnabled(): boolean
Gets whether the vignette effect is enabled.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23083
set vignetteEnabled(value: boolean): void
Sets whether the vignette effect is enabled.
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23087

vignetteStretch

get vignetteStretch(): number
Gets Vignette stretch size.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23011
set vignetteStretch(value: number): void
Sets Vignette stretch size.
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23015

vignetteWeight

get vignetteWeight(): number
Gets Vignette weight or intensity of the vignette effect.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23049
set vignetteWeight(value: number): void
Sets Vignette weight or intensity of the vignette effect.
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23053

`Static`ForceGLSL

get ForceGLSL(): boolean
Force all the postprocesses to compile to glsl even on WebGPU engines. False by default. This is mostly meant for backward compatibility.

Returns boolean
Inherited from PostProcess.ForceGLSL
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22371
set ForceGLSL(force: boolean): void
Parameters
- force: boolean
Returns void
Inherited from PostProcess.ForceGLSL
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22372

Methods

activate

activate(
    cameraOrScene: Scene | Nullable<Camera>,
    sourceTexture?: Nullable<InternalTexture>,
    forceDepthStencil?: boolean,
): RenderTargetWrapper
Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable. When this post process is used in a pipeline, this is call will bind the input texture of this post process to the output of the previous.
Parameters
- cameraOrScene: Scene | Nullable<Camera>
  The camera that will be used in the post process. This camera will be used when calling onActivateObservable. You can also pass the scene if no camera is available.
- OptionalsourceTexture: Nullable<InternalTexture>
  The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
- OptionalforceDepthStencil: boolean
  If true, a depth and stencil buffer will be generated. (default: false)
Returns RenderTargetWrapper
The render target wrapper that was bound to be written to.
Inherited from PostProcess.activate
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22704

apply

apply(): Nullable<Effect>
Binds all textures and uniforms to the shader, this will be run on every pass.

Returns Nullable<Effect>
the effect corresponding to this post process. Null if not compiled or not ready.
Inherited from PostProcess.apply
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22722

clone

clone(): Nullable<PostProcess>
Clones this post process

Returns Nullable<PostProcess>
a new post process similar to this one
Inherited from PostProcess.clone
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22745

dispose

dispose(camera?: Camera): void
Disposes the post process.
Parameters
- Optionalcamera: Camera
  The camera to dispose the post process on.
Returns void
Overrides PostProcess.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23123

getCamera

getCamera(): Camera
Gets the camera which post process is applied to.

Returns Camera
The camera the post process is applied to.
Inherited from PostProcess.getCamera
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22602

getClassName

getClassName(): string
"ImageProcessingPostProcess"

Returns string
"ImageProcessingPostProcess"
Overrides PostProcess.getClassName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:23118

getEffect

getEffect(): Effect
The effect that is created when initializing the post process.

Returns Effect
The created effect corresponding to the postprocess.
Inherited from PostProcess.getEffect
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22653

getEffectName

getEffectName(): string
Returns the fragment url or shader name used in the post process.

Returns string
the fragment url or name in the shader store.
Inherited from PostProcess.getEffectName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22532

getEngine

getEngine(): AbstractEngine
Gets the engine which this post process belongs to.

Returns AbstractEngine
The engine the post process was enabled with.
Inherited from PostProcess.getEngine
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22648

isReady

isReady(): boolean
Get a value indicating if the post-process is ready to be used

Returns boolean
true if the post-process is ready (shader is compiled)
Inherited from PostProcess.isReady
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22717

isReusable

isReusable(): boolean
The post process is reusable if it can be used multiple times within one frame.

Returns boolean
If the post process is reusable
Inherited from PostProcess.isReusable
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22681

markTextureDirty

markTextureDirty(): void
invalidate frameBuffer to hint the postprocess to create a depth buffer

Returns void
Inherited from PostProcess.markTextureDirty
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22683

resize

resize(
    width: number,
    height: number,
    camera?: Nullable<Camera>,
    needMipMaps?: boolean,
    forceDepthStencil?: boolean,
): void
Resizes the post-process texture
Parameters
- width: number
  Width of the texture
- height: number
  Height of the texture
- Optionalcamera: Nullable<Camera>
  The camera this post-process is applied to. Pass null if the post-process is used outside the context of a camera post-process chain (default: null)
- OptionalneedMipMaps: boolean
  True if mip maps need to be generated after render (default: false)
- OptionalforceDepthStencil: boolean
  True to force post-process texture creation with stencil depth and buffer (default: false)
Returns void
Inherited from PostProcess.resize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22694

restoreDefaultInputTexture

restoreDefaultInputTexture(): void
Since inputTexture should always be defined, if we previously manually set inputTexture, the only way to unset it is to use this function to restore its internal state

Returns void
Inherited from PostProcess.restoreDefaultInputTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22597

serialize

serialize(): any
Serializes the post process to a JSON object

Returns any
the JSON object
Inherited from PostProcess.serialize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22740

setPrePassRenderer

setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean
Sets the required values to the prepass renderer.
Parameters
- prePassRenderer: PrePassRenderer
  defines the prepass renderer to setup.
Returns boolean
true if the pre pass is needed.
Inherited from PostProcess.setPrePassRenderer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22730

shareOutputWith

shareOutputWith(postProcess: PostProcess): PostProcess
To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
Parameters
- postProcess: PostProcess
  The post process to share the output with.
Returns PostProcess
This post process.
Inherited from PostProcess.shareOutputWith
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22659

updateEffect

updateEffect(
    defines?: Nullable<string>,
    uniforms?: Nullable<string[]>,
    samplers?: Nullable<string[]>,
    indexParameters?: any,
    onCompiled?: (effect: Effect) => void,
    onError?: (effect: Effect, errors: string) => void,
    vertexUrl?: string,
    fragmentUrl?: string,
): void

Updates the effect with the current post process compile time values and recompiles the shader.

Parameters

Optionaldefines: Nullable<string>

Define statements that should be added at the beginning of the shader. (default: null)

Optionaluniforms: Nullable<string[]>

Set of uniform variables that will be passed to the shader. (default: null)

Optionalsamplers: Nullable<string[]>

Set of Texture2D variables that will be passed to the shader. (default: null)

OptionalindexParameters: anyThe index parameters to be used for babylons include syntax "#include[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx

OptionalonCompiled: (effect: Effect) => void

Called when the shader has been compiled.

OptionalonError: (effect: Effect, errors: string) => void

Called if there is an error when compiling a shader.

OptionalvertexUrl: string

The url of the vertex shader to be used (default: the one given at construction time)

OptionalfragmentUrl: string

The url of the fragment shader to be used (default: the one given at construction time)

Returns void

useOwnOutput

useOwnOutput(): void
Reverses the effect of calling shareOutputWith and returns the post process back to its original state. This should be called if the post process that shares output with this post process is disabled/disposed.

Returns void
Inherited from PostProcess.useOwnOutput
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22664

`Static`Parse

Parse(
    parsedPostProcess: any,
    scene: Scene,
    rootUrl: string,
): Nullable<PostProcess>
Creates a material from parsed material data
Parameters
- parsedPostProcess: any
  defines parsed post process data
- scene: Scene
  defines the hosting scene
- rootUrl: string
  defines the root URL to use to load textures
Returns Nullable<PostProcess>
a new post process
Inherited from PostProcess.Parse
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22753

`Static`RegisterShaderCodeProcessing

RegisterShaderCodeProcessing(
postProcessName: Nullable<string>,
customShaderCodeProcessing?: EffectWrapperCustomShaderCodeProcessing,
): void
Registers a shader code processing with a post process name.
Parameters
- postProcessName: Nullable<string>
  name of the post process. Use null for the fallback shader code processing. This is the shader code processing that will be used in case no specific shader code processing has been associated to a post process name
- OptionalcustomShaderCodeProcessing: EffectWrapperCustomShaderCodeProcessing
  shader code processing to associate to the post process name
Returns void
Inherited from PostProcess.RegisterShaderCodeProcessing
- Defined in .temp/typedoc/docdirectory/doc.d.ts:22380

Class ImageProcessingPostProcess

See

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ImageProcessingPostProcess

Properties

adaptScaleToCurrentViewport

alphaConstants

alwaysForcePOT

animations

autoClear

clearColor

enablePixelPerfectMode

externalTextureSamplerBinding

forceAutoClearInAlphaMode

forceFullscreenViewport

height

inspectableCustomProperties

See

nodeMaterialSource

onActivateObservable

onAfterRenderObservable

onApplyObservable

onBeforeRenderObservable

ReadonlyonDisposeObservable

onEffectCreatedObservable

Returns

onSizeChangedObservable

renderTargetSamplingMode

scaleMode

uniqueId

width

Accessors

alphaMode

Returns number

Parameters

Returns void

aspectRatio

Returns number

colorCurves

Returns Nullable<ColorCurves>

Parameters

Returns void

colorCurvesEnabled

Returns boolean

Parameters

Returns void

colorGradingEnabled

Returns boolean

Parameters

Returns void

colorGradingTexture

Returns Nullable<BaseTexture>

Parameters

Returns void

contrast

Returns number

Parameters

Returns void

ditheringEnabled

Returns boolean

Parameters

Returns void

ditheringIntensity

Returns number

Parameters

Returns void

exposure

Returns number

Parameters

Returns void

fromLinearSpace

Returns boolean

`Readonly`onDisposeObservable