API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ImageProcessingPostProcess

ImageProcessingPostProcess

see

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

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

adaptScaleToCurrentViewportSearch playground for adaptScaleToCurrentViewport

adaptScaleToCurrentViewport: boolean

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

alphaConstantsSearch playground for alphaConstants

alphaConstants: Color4

Sets the setAlphaBlendConstants of the babylon engine

alphaModeSearch playground for alphaMode

alphaMode: number

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

alwaysForcePOTSearch playground for alwaysForcePOT

alwaysForcePOT: boolean

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

animationsSearch playground for animations

animations: Animation[]

Animations to be used for the post processing

autoClearSearch playground for 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.

clearColorSearch playground for clearColor

clearColor: Color4

Clear color to use when screen clearing

enablePixelPerfectModeSearch playground for 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)

externalTextureSamplerBindingSearch playground for 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

forceAutoClearInAlphaModeSearch playground for 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).

forceFullscreenViewportSearch playground for forceFullscreenViewport

forceFullscreenViewport: boolean

Force the postprocess to be applied without taking in account viewport

heightSearch playground for height

height: number

Height of the texture to apply the post process on

inspectableCustomPropertiesSearch playground for inspectableCustomProperties

inspectableCustomProperties: IInspectable[]

List of inspectable custom properties (used by the Inspector)

see

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

nameSearch playground for name

name: string

Name of the PostProcess.

nodeMaterialSourceSearch playground for nodeMaterialSource

nodeMaterialSource: Nullable<NodeMaterial>

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

onActivateObservableSearch playground for onActivateObservable

onActivateObservable: Observable<Camera>

An event triggered when the postprocess is activated.

onAfterRenderObservableSearch playground for onAfterRenderObservable

onAfterRenderObservable: Observable<Effect>

An event triggered after rendering the postprocess

onApplyObservableSearch playground for onApplyObservable

onApplyObservable: Observable<Effect>

An event triggered when the postprocess applies its effect.

onBeforeRenderObservableSearch playground for onBeforeRenderObservable

onBeforeRenderObservable: Observable<Effect>

An event triggered before rendering the postprocess

onSizeChangedObservableSearch playground for onSizeChangedObservable

onSizeChangedObservable: Observable<PostProcess>

An event triggered when the postprocess changes its size.

renderTargetSamplingModeSearch playground for renderTargetSamplingMode

renderTargetSamplingMode: number

Sampling mode used by the shader See https://doc.babylonjs.com/classes/3.1/texture

scaleModeSearch playground for scaleMode

scaleMode: number

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

ValueTypeDescription
1SCALEMODE_FLOORengine.scalemode_floor
2SCALEMODE_NEARESTengine.scalemode_nearest
3SCALEMODE_CEILINGengine.scalemode_ceiling

uniqueIdSearch playground for uniqueId

uniqueId: number

Gets or sets the unique id of the post process

widthSearch playground for width

width: number

Width of the texture to apply the post process on

Accessors

aspectRatio

  • get aspectRatio(): number

  • The aspect ratio of the output texture.

    Returns number

colorCurves

  • Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .

    Returns Nullable<ColorCurves>

  • Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .

    Parameters

    Returns void

colorCurvesEnabled

  • get colorCurvesEnabled(): boolean
  • set colorCurvesEnabled(value: boolean): void

  • Gets whether the color curves effect is enabled.

    Returns boolean

  • Sets whether the color curves effect is enabled.

    Parameters

    • value: boolean

    Returns void

colorGradingEnabled

  • get colorGradingEnabled(): boolean
  • set colorGradingEnabled(value: boolean): void

  • Gets whether the color grading effect is enabled.

    Returns boolean

  • Gets whether the color grading effect is enabled.

    Parameters

    • value: boolean

    Returns void

colorGradingTexture

  • Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.

    Returns Nullable<BaseTexture>

  • Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.

    Parameters

    Returns void

contrast

  • get contrast(): number
  • set contrast(value: number): void

  • Gets contrast used in the effect.

    Returns number

  • Sets contrast used in the effect.

    Parameters

    • value: number

    Returns void

ditheringEnabled

  • get ditheringEnabled(): boolean
  • set ditheringEnabled(value: boolean): void

  • Gets whether the dithering effect is enabled.

    Returns boolean

  • Sets whether the dithering effect is enabled.

    Parameters

    • value: boolean

    Returns void

ditheringIntensity

  • get ditheringIntensity(): number
  • set ditheringIntensity(value: number): void

  • Gets intensity of the dithering effect.

    Returns number

  • Sets intensity of the dithering effect.

    Parameters

    • value: number

    Returns void

exposure

  • get exposure(): number
  • set exposure(value: number): void

  • Gets exposure used in the effect.

    Returns number

  • Sets exposure used in the effect.

    Parameters

    • value: number

    Returns void

fromLinearSpace

  • get fromLinearSpace(): boolean
  • set fromLinearSpace(value: boolean): void

  • Gets whether the input of the processing is in Gamma or Linear Space.

    Returns boolean

  • Sets whether the input of the processing is in Gamma or Linear Space.

    Parameters

    • value: boolean

    Returns void

imageProcessingConfiguration

  • Gets the image processing configuration used either in this material.

    Returns ImageProcessingConfiguration

  • Sets the Default image processing configuration used either in the this material.

    If sets to null, the scene one is in use.

    Parameters

    Returns void

inputTexture

  • 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

  • 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.

    Parameters

    Returns void

isSupported

  • get isSupported(): boolean

  • If the post process is supported.

    Returns boolean

onActivate

  • A function that is added to the onActivateObservable

    Parameters

    Returns void

onAfterRender

  • set onAfterRender(callback: ((efect: Effect) => void)): void

  • A function that is added to the onAfterRenderObservable

    Parameters

    • callback: ((efect: Effect) => void)

    Returns void

onApply

  • set onApply(callback: ((effect: Effect) => void)): void

  • A function that is added to the onApplyObservable

    Parameters

    • callback: ((effect: Effect) => void)

    Returns void

onBeforeRender

  • set onBeforeRender(callback: ((effect: Effect) => void)): void

  • A function that is added to the onBeforeRenderObservable

    Parameters

    • callback: ((effect: Effect) => void)

    Returns void

onSizeChanged

  • set onSizeChanged(callback: ((postProcess: PostProcess) => void)): void

  • A function that is added to the onSizeChangedObservable

    Parameters

    Returns void

samples

  • get samples(): number
  • set samples(n: number): void

  • Number of sample textures (default: 1)

    Returns number

  • Number of sample textures (default: 1)

    Parameters

    • n: number

    Returns void

texelSize

toneMappingEnabled

  • get toneMappingEnabled(): boolean
  • set toneMappingEnabled(value: boolean): void

  • Gets whether tonemapping is enabled or not.

    Returns boolean

  • Sets whether tonemapping is enabled or not

    Parameters

    • value: boolean

    Returns void

toneMappingType

  • get toneMappingType(): number
  • set toneMappingType(value: number): void

  • Gets the type of tone mapping effect.

    Returns number

  • Sets the type of tone mapping effect.

    Parameters

    • value: number

    Returns void

vignetteBlendMode

  • get vignetteBlendMode(): number
  • set vignetteBlendMode(value: number): void

  • Gets the vignette blend mode allowing different kind of effect.

    Returns number

  • Sets the vignette blend mode allowing different kind of effect.

    Parameters

    • value: number

    Returns void

vignetteCameraFov

  • get vignetteCameraFov(): number
  • set vignetteCameraFov(value: number): void

  • Gets Camera field of view used by the Vignette effect.

    Returns number

  • Sets Camera field of view used by the Vignette effect.

    Parameters

    • value: number

    Returns void

vignetteCenterX

  • get vignetteCenterX(): number
  • set vignetteCenterX(value: number): void

  • Vignette center X Offset.

    Returns number

  • Vignette center X Offset.

    Parameters

    • value: number

    Returns void

vignetteCenterY

  • get vignetteCenterY(): number
  • set vignetteCenterY(value: number): void

  • Vignette center Y Offset.

    Returns number

  • Vignette center Y Offset.

    Parameters

    • value: number

    Returns void

vignetteCentreX

  • get vignetteCentreX(): number
  • set vignetteCentreX(value: number): void

  • Gets Vignette center X Offset.

    deprecated

    use vignetteCenterX instead

    Returns number

  • Sets Vignette center X Offset.

    deprecated

    use vignetteCenterX instead

    Parameters

    • value: number

    Returns void

vignetteCentreY

  • get vignetteCentreY(): number
  • set vignetteCentreY(value: number): void

  • Gets Vignette center Y Offset.

    deprecated

    use vignetteCenterY instead

    Returns number

  • Sets Vignette center Y Offset.

    deprecated

    use vignetteCenterY instead

    Parameters

    • value: number

    Returns void

vignetteColor

  • get vignetteColor(): Color4
  • set vignetteColor(value: Color4): void

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

    Returns Color4

  • Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode) if vignetteEnabled is set to true.

    Parameters

    Returns void

vignetteEnabled

  • get vignetteEnabled(): boolean
  • set vignetteEnabled(value: boolean): void

  • Gets whether the vignette effect is enabled.

    Returns boolean

  • Sets whether the vignette effect is enabled.

    Parameters

    • value: boolean

    Returns void

vignetteStretch

  • get vignetteStretch(): number
  • set vignetteStretch(value: number): void

  • Gets Vignette stretch size.

    Returns number

  • Sets Vignette stretch size.

    Parameters

    • value: number

    Returns void

vignetteWeight

  • get vignetteWeight(): number
  • set vignetteWeight(value: number): void

  • Gets Vignette weight or intensity of the vignette effect.

    Returns number

  • Sets Vignette weight or intensity of the vignette effect.

    Parameters

    • value: number

    Returns void

Methods

activateSearch playground for activate

  • 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

    • camera: Nullable<Camera>

      The camera that will be used in the post process. This camera will be used when calling onActivateObservable.

    • Optional sourceTexture: Nullable<InternalTexture>

      The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)

    • Optional forceDepthStencil: 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.

applySearch playground for apply

  • 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.

cloneSearch playground for clone

disposeSearch playground for dispose

  • dispose(camera?: Camera): void

  • Disposes the post process.

    Parameters

    Returns void

getCameraSearch playground for getCamera

  • Gets the camera which post process is applied to.

    Returns Camera

    The camera the post process is applied to.

getClassNameSearch playground for getClassName

  • getClassName(): string

  • "ImageProcessingPostProcess"

    Returns string

    "ImageProcessingPostProcess"

getEffectSearch playground for getEffect

  • The effect that is created when initializing the post process.

    Returns Effect

    The created effect corresponding the postprocess.

getEffectNameSearch playground for 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.

getEngineSearch playground for getEngine

  • Gets the engine which this post process belongs to.

    Returns Engine

    The engine the post process was enabled with.

isReadySearch playground for 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)

isReusableSearch playground for 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

markTextureDirtySearch playground for markTextureDirty

  • markTextureDirty(): void

  • invalidate frameBuffer to hint the postprocess to create a depth buffer

    Returns void

resizeSearch playground for 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

    • Optional camera: 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)

    • Optional needMipMaps: boolean

      True if mip maps need to be generated after render (default: false)

    • Optional forceDepthStencil: boolean

      True to force post-process texture creation with stencil depth and buffer (default: false)

    Returns void

restoreDefaultInputTextureSearch playground for 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

serializeSearch playground for serialize

  • serialize(): any

  • Serializes the post process to a JSON object

    Returns any

    the JSON object

setPrePassRendererSearch playground for setPrePassRenderer

  • Sets the required values to the prepass renderer.

    Parameters

    Returns boolean

    true if the pre pass is needed.

shareOutputWithSearch playground for shareOutputWith

  • 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.

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

  • Optional defines: Nullable<string>

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

  • Optional uniforms: Nullable<string[]>

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

  • Optional samplers: Nullable<string[]>

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

    • Optional indexParameters: any
    The index parameters to be used for babylons include syntax "#include[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  • Optional onCompiled: ((effect: Effect) => void)

    Called when the shader has been compiled.

  • Optional onError: ((effect: Effect, errors: string) => void)

    Called if there is an error when compiling a shader.

      • (effect: Effect, errors: string): void

      • Parameters

        Returns void

  • Optional vertexUrl: string

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

  • Optional fragmentUrl: string

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

    • Returns void

    useOwnOutputSearch playground for 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

    Static ParseSearch playground for Parse

    • 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

    Static RegisterShaderCodeProcessingSearch playground for RegisterShaderCodeProcessing

    • 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

      • Optional customShaderCodeProcessing: PostProcessCustomShaderCodeProcessing

        shader code processing to associate to the post process name

      Returns void

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Inherited accessor
    • Property
    • Method
    • Static method

    Settings

    Theme