ImageProcessingConfiguration

This groups together the common properties used for image processing either in direct forward pass or through post processing effect depending on the use of the image processing pipeline in your scene or not.

Hierarchy

  • ImageProcessingConfiguration

Index

Properties

applyByPostProcess

Find examples in Playground
applyByPostProcess: boolean

Sets wether the image processing is applied through a post process or not.

colorCurves

Find examples in Playground
colorCurves: Nullable<ColorCurves>

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

colorCurvesEnabled

Find examples in Playground
colorCurvesEnabled: boolean

Sets wether the color curves effect is enabled.

colorGradingBGR

Find examples in Playground
colorGradingBGR: boolean

Sets wether the color grading texture contains BGR values.

colorGradingEnabled

Find examples in Playground
colorGradingEnabled: boolean

Sets wether the color grading effect is enabled.

colorGradingTexture

Find examples in Playground
colorGradingTexture: Nullable<BaseTexture>

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

colorGradingWithGreenDepth

Find examples in Playground
colorGradingWithGreenDepth: boolean

Sets wether the color grading effect is using a green depth for the 3d Texture.

contrast

Find examples in Playground
contrast: number

Sets the contrast used in the effect.

exposure

Find examples in Playground
exposure: number

Sets the Exposure used in the effect.

isEnabled

Find examples in Playground
isEnabled: boolean

Sets wether the image processing is enabled or not.

onUpdateParameters

Find examples in Playground

An event triggered when the configuration changes and requires Shader to Update some parameters.

toneMappingEnabled

Find examples in Playground
toneMappingEnabled: boolean

Sets wether the tone mapping effect is enabled.

toneMappingType

Find examples in Playground
toneMappingType: number

Sets the type of tone mapping effect used in BabylonJS.

vignetteBlendMode

Find examples in Playground
vignetteBlendMode: number

Sets the vignette blend mode allowing different kind of effect.

vignetteCameraFov

Find examples in Playground
vignetteCameraFov: number

Camera field of view used by the Vignette effect.

vignetteCentreX

Find examples in Playground
vignetteCentreX: number

Vignette centre X Offset.

vignetteCentreY

Find examples in Playground
vignetteCentreY: number

Vignette centre Y Offset.

vignetteColor

Find examples in Playground
vignetteColor: Color4

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

vignetteEnabled

Find examples in Playground
vignetteEnabled: boolean

Sets wether the vignette effect is enabled.

vignetteStretch

Find examples in Playground
vignetteStretch: number

Vignette stretch size.

vignetteWeight

Find examples in Playground
vignetteWeight: number

Vignette weight or intensity of the vignette effect.

Static TONEMAPPING_ACES

Find examples in Playground
TONEMAPPING_ACES: number

ACES Tone mapping (used by default in unreal and unity). This can help getting closer to other engines rendering to increase portability.

Static TONEMAPPING_STANDARD

Find examples in Playground
TONEMAPPING_STANDARD: number

Default tone mapping applied in BabylonJS.

Static VIGNETTEMODE_MULTIPLY

Find examples in Playground
VIGNETTEMODE_MULTIPLY: number

Used to apply the vignette as a mix with the pixel color.

Static VIGNETTEMODE_OPAQUE

Find examples in Playground
VIGNETTEMODE_OPAQUE: number

Used to apply the vignette as a replacement of the pixel color.

Methods

bind

Find examples in Playground
  • bind(effect: Effect, aspectRatio?: number): void
  • Binds the image processing to the shader.

    Parameters

    • effect: Effect

      The effect to bind to

    • Optional aspectRatio: number

      Define the current aspect ratio of the effect

    Returns void

clone

Find examples in Playground

getClassName

Find examples in Playground
  • getClassName(): string
  • Gets the current class name.

    Returns string

    "ImageProcessingConfiguration"

isReady

Find examples in Playground
  • isReady(): boolean
  • Returns true if all the image processing information are ready.

    Returns boolean

    True if ready, otherwise, false

prepareDefines

Find examples in Playground
  • prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void
  • Prepare the list of defines associated to the shader.

    Parameters

    • defines: IImageProcessingConfigurationDefines

      the list of defines to complete

    • Optional forPostProcess: boolean

      Define if we are currently in post process mode or not

    Returns void

serialize

Find examples in Playground
  • serialize(): any
  • Serializes the current image processing instance to a json representation.

    Returns any

    a JSON representation

Static Parse

Find examples in Playground
  • Parses the image processing from a json representation.

    Parameters

    • source: any

      the JSON source to parse

    Returns ImageProcessingConfiguration

    The parsed image processing

Static PrepareSamplers

Find examples in Playground
  • PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void
  • Prepare the list of samplers associated with the Image Processing effects.

    Parameters

    • samplersList: string[]

      The list of uniforms used in the effect

    • defines: IImageProcessingConfigurationDefines

      the list of defines currently in use

    Returns void

Static PrepareUniforms

Find examples in Playground
  • PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void
  • Prepare the list of uniforms associated with the Image Processing effects.

    Parameters

    • uniforms: string[]

      The list of uniforms used in the effect

    • defines: IImageProcessingConfigurationDefines

      the list of defines currently in use

    Returns void

Generated using TypeDoc