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

Class 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

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

colorCurvesSearch playground for colorCurves

colorCurves: Nullable<ColorCurves>

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

onUpdateParametersSearch playground for onUpdateParameters

onUpdateParameters: Observable<ImageProcessingConfiguration>

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

vignetteCameraFovSearch playground for vignetteCameraFov

vignetteCameraFov: number

Camera field of view used by the Vignette effect.

vignetteCenterXSearch playground for vignetteCenterX

vignetteCenterX: number

Vignette center X Offset.

vignetteCenterYSearch playground for vignetteCenterY

vignetteCenterY: number

Vignette center Y Offset.

vignetteColorSearch playground for vignetteColor

vignetteColor: Color4

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

vignetteStretchSearch playground for vignetteStretch

vignetteStretch: number

Vignette stretch size.

vignetteWeightSearch playground for vignetteWeight

vignetteWeight: number

Vignette weight or intensity of the vignette effect.

Static Readonly TONEMAPPING_ACESSearch playground for TONEMAPPING_ACES

TONEMAPPING_ACES: 1 = 1

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

Static Readonly TONEMAPPING_STANDARDSearch playground for TONEMAPPING_STANDARD

TONEMAPPING_STANDARD: 0 = 0

Default tone mapping applied in BabylonJS.

Accessors

applyByPostProcess

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

  • Gets whether the image processing is applied through a post process or not.

    Returns boolean

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

    Parameters

    • value: boolean

    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

colorGradingBGR

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

  • Gets whether the color grading texture contains BGR values.

    Returns boolean

  • Sets whether the color grading texture contains BGR values.

    Parameters

    • value: boolean

    Returns void

colorGradingEnabled

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

  • Gets whether the color grading effect is enabled.

    Returns boolean

  • Sets whether the color grading effect is enabled.

    Parameters

    • value: boolean

    Returns void

colorGradingTexture

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

    Returns Nullable<BaseTexture>

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

    Parameters

    Returns void

colorGradingWithGreenDepth

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

  • Gets whether the color grading effect is using a green depth for the 3d Texture.

    Returns boolean

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

    Parameters

    • value: boolean

    Returns void

contrast

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

  • Gets the contrast used in the effect.

    Returns number

  • Sets the 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. The dithering effect can be used to reduce banding.

    Returns boolean

  • Sets whether the dithering effect is enabled. The dithering effect can be used to reduce banding.

    Parameters

    • value: boolean

    Returns void

ditheringIntensity

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

  • Gets the dithering intensity. 0 is no dithering. Default is 1.0 / 255.0.

    Returns number

  • Sets the dithering intensity. 0 is no dithering. Default is 1.0 / 255.0.

    Parameters

    • value: number

    Returns void

exposure

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

  • Gets the Exposure used in the effect.

    Returns number

  • Sets the Exposure used in the effect.

    Parameters

    • value: number

    Returns void

isEnabled

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

  • Gets whether the image processing is enabled or not.

    Returns boolean

  • Sets whether the image processing is enabled or not.

    Parameters

    • value: boolean

    Returns void

skipFinalColorClamp

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

  • If apply by post process is set to true, setting this to true will skip the the final color clamp step in the fragment shader Applies to PBR materials.

    Returns boolean

  • If apply by post process is set to true, setting this to true will skip the the final color clamp step in the fragment shader Applies to PBR materials.

    Parameters

    • value: boolean

    Returns void

toneMappingEnabled

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

  • Gets whether the tone mapping effect is enabled.

    Returns boolean

  • Sets whether the tone mapping effect is enabled.

    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 used in BabylonJS.

    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

vignetteCentreX

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

  • Back Compat: Vignette center X Offset.

    deprecated

    use vignetteCenterX instead

    Returns number

  • Back Compat: Vignette center X Offset.

    deprecated

    use vignetteCenterX instead

    Parameters

    • value: number

    Returns void

vignetteCentreY

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

  • Back Compat: Vignette center Y Offset.

    deprecated

    use vignetteCenterY instead

    Returns number

  • Back Compat: Vignette center Y Offset.

    deprecated

    use vignetteCenterY instead

    Parameters

    • value: number

    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

Static VIGNETTEMODE_MULTIPLY

  • get VIGNETTEMODE_MULTIPLY(): number

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

    Returns number

Static VIGNETTEMODE_OPAQUE

  • get VIGNETTEMODE_OPAQUE(): number

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

    Returns number

Methods

bindSearch playground for bind

  • bind(effect: Effect, overrideAspectRatio?: number): void

  • Binds the image processing to the shader.

    Parameters

    • effect: Effect

      The effect to bind to

    • Optional overrideAspectRatio: number

      Override the aspect ratio of the effect

    Returns void

cloneSearch playground for clone

  • Clones the current image processing instance.

    Returns ImageProcessingConfiguration

    The cloned image processing

getClassNameSearch playground for getClassName

  • getClassName(): string

  • Gets the current class name.

    Returns string

    "ImageProcessingConfiguration"

isReadySearch playground for isReady

  • isReady(): boolean

  • Returns true if all the image processing information are ready.

    Returns boolean

    True if ready, otherwise, false

prepareDefinesSearch playground for prepareDefines

  • 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

serializeSearch playground for serialize

  • serialize(): any

  • Serializes the current image processing instance to a json representation.

    Returns any

    a JSON representation

Static ParseSearch playground for Parse

  • Parses the image processing from a json representation.

    Parameters

    • source: any

      the JSON source to parse

    Returns ImageProcessingConfiguration

    The parsed image processing

Static PrepareSamplersSearch playground for PrepareSamplers

  • 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 PrepareUniformsSearch playground for PrepareUniforms

  • 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

Legend

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

Settings

Theme