IThinMeshBlendingPostProcessOptions | Babylon.js API documentation

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

    Interface IThinMeshBlendingPostProcessOptions

    Options used to create a thin mesh-blending post process.

    interface IThinMeshBlendingPostProcessOptions {
        allowEmptySourceTexture?: boolean;
        attributeNames?: string[];
        blockCompilation?: boolean;
        debugMode?: MeshBlendDebugMode;
        defines?: Nullable<string | string[]>;
        depthType?: MeshBlendDepthType;
        engine?: AbstractEngine;
        extraInitializations?: (useWebGPU: boolean, list: Promise<any>[]) => void;
        extraInitializationsAsync?: () => Promise<void>;
        fragmentShader?: string;
        indexParameters?: any;
        name?: string;
        onCompiled?: Nullable<(effect: Effect) => void>;
        onError?: (effect: Effect, errors: string) => void;
        quality?: MeshBlendQuality;
        radiusClasses?: readonly [
            IMeshBlendRadiusDefinition,
            IMeshBlendRadiusDefinition,
            IMeshBlendRadiusDefinition,
            IMeshBlendRadiusDefinition,
        ];
        samplerNames?: string[];
        samplers?: Nullable<string[]>;
        shaderLanguage?: ShaderLanguage;
        slopeFactor?: number;
        uniformBuffers?: Nullable<string[]>;
        uniformNames?: string[];
        uniforms?: Nullable<string[]>;
        useAsPostProcess?: boolean;
        useShaderStore?: boolean;
        vertexShader?: string;
        vertexUrl?: string;
    }

    Hierarchy (View Summary)

    Index
    allowEmptySourceTexture? attributeNames? blockCompilation? debugMode? defines? depthType? engine? extraInitializations? extraInitializationsAsync? fragmentShader? indexParameters? name? onCompiled? onError? quality? radiusClasses? samplerNames? samplers? shaderLanguage? slopeFactor? uniformBuffers? uniformNames? uniforms? useAsPostProcess? useShaderStore? vertexShader? vertexUrl?
    allowEmptySourceTexture?: boolean

    Sets this property to true if the fragment shader doesn't use a textureSampler texture (default: false).

    attributeNames?: string[]

    Attributes to use in the shader (default: ["position"])

    blockCompilation?: boolean

    If the shader should not be compiled immediately. (default: false)

    debugMode?: MeshBlendDebugMode

    Debug visualization to compile into the shader. Off renders the final blended result.

    defines?: Nullable<string | string[]>

    Defines to use in the shader

    depthType?: MeshBlendDepthType

    Representation stored in the depth texture.

    engine?: AbstractEngine

    Engine to use to create the effect

    extraInitializations?: (useWebGPU: boolean, list: Promise<any>[]) => void

    Defines additional code to call to prepare the shader code

    extraInitializationsAsync?: () => Promise<void>

    Additional async code to run before preparing the effect

    fragmentShader?: string

    Fragment shader for the effect

    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
    name?: string

    The friendly name of the effect (default: "effectWrapper")

    onCompiled?: Nullable<(effect: Effect) => void>

    Callback when effect is compiled

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

    Callback when there is an error compiling the effect

    quality?: MeshBlendQuality

    Compile-time quality variant.

    radiusClasses?: readonly [
        IMeshBlendRadiusDefinition,
        IMeshBlendRadiusDefinition,
        IMeshBlendRadiusDefinition,
        IMeshBlendRadiusDefinition,
    ]

    Radius definitions indexed by packed radius class. Exactly four definitions are required.

    samplerNames?: string[]

    Texture sampler names to use in the shader

    samplers?: Nullable<string[]>

    Alias for samplerNames. Note that if it is provided, it takes precedence over samplerNames.

    shaderLanguage?: ShaderLanguage

    The language the shader is written in (default: GLSL)

    slopeFactor?: number

    Contact-slope narrowing factor. A value of 1 disables narrowing.

    uniformBuffers?: Nullable<string[]>

    The list of uniform buffers used in the shader (if any)

    uniformNames?: string[]

    Uniforms to use in the shader

    uniforms?: Nullable<string[]>

    Alias for uniformNames. Note that if it is provided, it takes precedence over uniformNames.

    useAsPostProcess?: boolean

    If the effect should be used as a post process (default: false). If true, the effect will be created with a "scale" uniform and a "textureSampler" sampler

    useShaderStore?: boolean

    Use the shader store instead of direct source code

    vertexShader?: string

    Vertex shader for the effect (default: "postprocess")

    vertexUrl?: string

    Alias for vertexShader

    Settings
    Member Visibility

    On This Page
    Properties