API
API|
@babylonjs/core|
FrameGraphMeshBlendingTask

Class FrameGraphMeshBlendingTask

Frame-graph task which visually blends SceneColor across validated contacts between opaque or alpha-tested meshes.

This WebGL2 and WebGPU task uses the same effect and configuration as MeshBlendingPostProcess. It does not modify geometry, collision queries, depth, normals, or shadows. All source and geometry textures must have matching physical dimensions and sample counts. Transparent rendering is caller-controlled; overlapping transparent surfaces can make SceneColor inconsistent with the single-layer geometry inputs. On WebGL2, rendering transparent meshes into the integer tag attachment requires per-target blend parameters.

https://playground.babylonjs.com/?version=preview#O05LI8#6

Hierarchy (View Summary)

Index
constructor
baseColorTexture? camera dependencies? depthAttachmentTexture? depthReadOnly depthTest depthTexture disableColorWrite drawBackFace meshBlendTagTexture onAfterTaskExecute onBeforeTaskExecute onTexturesAllocatedObservable outputDepthAttachmentTexture outputTexture postProcess sourceSamplingMode sourceTexture? stencilReadOnly stencilState? targetTexture? viewport?
alphaMode debugMode depthType disabled drawWrapper name passes passesDisabled quality radiusClasses slopeFactor
configure dispose getClassName initAsync isReady record
baseColorTexture?: number

Optional linear base-color/albedo geometry texture aligned with SceneColor.

When omitted, shadow estimation is compiled out.

camera: Camera

Camera used to project radii and reconstruct view-space positions.

dependencies?: Set<FrameGraphTextureHandle>

The (texture) dependencies of the task (optional).

depthAttachmentTexture?: any

The depth attachment texture to use for the post process (optional). Note that a post-process task never writes to the depth buffer: attaching a depth texture is only useful if you want to test against the depth/stencil aspect or write to the stencil buffer.

depthReadOnly: boolean = false

If true, the depth attachment will be read-only. This means that the post process will not write to the depth buffer. Setting depthReadOnly and stencilReadOnly to true is useful when you want to also be able to bind this same depth/stencil attachment to a shader. Note that it will only work in WebGPU, as WebGL does not support read-only depth/stencil attachments.

depthTest: boolean = true

If depth testing should be enabled (default is true).

depthTexture: number

The view-depth or screen-depth texture aligned with the packed tag texture.

disableColorWrite: boolean = false

If true, color write will be disabled when applying the post process. This means that the post process will not write to the color buffer.

drawBackFace: boolean = false

If true, the post process will be generated by a back face full-screen quad (CW order).

meshBlendTagTexture: number

The packed R8UI mesh-blending tag texture used to locate seams.

onAfterTaskExecute: Observable<FrameGraphTask> = ...

An observable that is triggered after the task is executed.

onBeforeTaskExecute: Observable<FrameGraphTask> = ...

An observable that is triggered before the task is executed.

onTexturesAllocatedObservable: Observable<FrameGraphRenderContext> = ...

An observable that is triggered after the textures have been allocated.

outputDepthAttachmentTexture: FrameGraphTextureHandle

The output depth attachment texture. This texture will point to the same texture than the depthAttachmentTexture property if it is set. Note, however, that the handle itself will be different!

outputTexture: FrameGraphTextureHandle

The output texture of the post process.

postProcess: ThinMeshBlendingPostProcess

The thin post process containing the shared quality variant and blend configuration.

sourceSamplingMode: any = Constants.TEXTURE_BILINEAR_SAMPLINGMODE

The sampling mode to use for the source texture.

sourceTexture?: any

The source texture to apply the post process on. It's allowed to be undefined if the post process does not require a source texture. In that case, targetTexture must be provided.

stencilReadOnly: boolean = false

If true, the stencil attachment will be read-only. This means that the post process will not write to the stencil buffer. Setting depthReadOnly and stencilReadOnly to true is useful when you want to also be able to bind this same depth/stencil attachment to a shader. Note that it will only work in WebGPU, as WebGL does not support read-only depth/stencil attachments.

stencilState?: any

The stencil state to use for the post process (optional).

targetTexture?: any

The target texture to render the post process to. If not supplied, a texture with the same configuration as the source texture will be created.

viewport?: any

The viewport to use when applying the post process. If set to null, the currently active viewport is used. If undefined (default), the viewport is reset to a full screen viewport before applying the post process.

  • This function is called once after the task has been added to the frame graph and before the frame graph is built for the first time. This allows you to initialize asynchronous resources, which is not possible in the constructor.

    Returns Promise<unknown>

    A promise that resolves when the initialization is complete.