ThinImageProcessingPostProcess | Babylon.js API documentation

API
API|
@babylonjs/core|
ThinImageProcessingPostProcess
Babylon.js API documentation
    Preparing search index...

    Class ThinImageProcessingPostProcess

    Post process used to apply image processing to a scene

    Hierarchy (View Summary)

    Index
    constructor
    alphaMode onApplyObservable onEffectCreatedObservable options overrideAspectRatio? ForceGLSL FragmentUrl
    colorCurves colorCurvesEnabled colorGradingEnabled colorGradingTexture contrast ditheringEnabled ditheringIntensity drawWrapper effect exposure fromLinearSpace imageProcessingConfiguration name outputTextureHeight outputTextureWidth temperature tint toneMappingEnabled toneMappingType vignetteBlendMode vignetteCameraFov vignetteCenterX vignetteCenterY vignetteCentreX vignetteCentreY vignetteColor vignetteEnabled vignetteStretch vignetteWeight whiteBalanceEnabled
    bind dispose isReady updateEffect RegisterShaderCodeProcessing
    alphaMode: number = Constants.ALPHA_DISABLE

    Type of alpha mode to use when applying the effect (default: Engine.ALPHA_DISABLE). Used only if useAsPostProcess is true.

    onApplyObservable: Observable<{}> = ...

    Event that is fired (only when the EffectWrapper is used with an EffectRenderer) right before the effect is drawn (should be used to update uniforms)

    onEffectCreatedObservable: Observable<Effect> = ...

    Executed when the effect is created

    effect that was created for this effect wrapper

    options: NonNullableFields<ThinImageProcessingPostProcessOptions>

    Options used to create the effect wrapper

    overrideAspectRatio?: number

    Gets/sets the aspect ratio used to override the default one.

    ForceGLSL: boolean = false

    Force code to compile to glsl even on WebGPU engines. False by default. This is mostly meant for backward compatibility.

    FragmentUrl: "imageProcessing"

    The fragment shader url

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

    Parameters

  • defines: Nullable<string> = null

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

  • uniforms: Nullable<string[]> = null

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

  • samplers: Nullable<string[]> = null

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

    • OptionalindexParameters: 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
  • 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

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods