@babylonjs/core
Version:
Getting started? Play directly with the Babylon.js API using our [playground](https://playground.babylonjs.com/). It also contains a lot of samples to learn how to use it.
52 lines (51 loc) • 1.55 kB
TypeScript
import type { FrameGraph, FrameGraphTextureHandle, FrameGraphRenderPass } from "../../../index.js";
import { Color4 } from "../../../Maths/math.color.js";
import { FrameGraphTask } from "../../frameGraphTask.js";
/**
* Task used to clear a texture.
*/
export declare class FrameGraphClearTextureTask extends FrameGraphTask {
/**
* The color to clear the texture with.
*/
color: Color4;
/**
* If the color should be cleared.
*/
clearColor: boolean;
/**
* If the color should be converted to linear space (default: false).
*/
convertColorToLinearSpace: boolean;
/**
* If the depth should be cleared.
*/
clearDepth: boolean;
/**
* If the stencil should be cleared.
*/
clearStencil: boolean;
/**
* The color texture to clear.
*/
targetTexture?: FrameGraphTextureHandle;
/**
* The depth attachment texture to clear.
*/
depthTexture?: FrameGraphTextureHandle;
/**
* The output texture (same as targetTexture, but the handle will be different).
*/
readonly outputTexture: FrameGraphTextureHandle;
/**
* The output depth texture (same as depthTexture, but the handle will be different).
*/
readonly outputDepthTexture: FrameGraphTextureHandle;
/**
* Constructs a new clear task.
* @param name The name of the task.
* @param frameGraph The frame graph the task belongs to.
*/
constructor(name: string, frameGraph: FrameGraph);
record(): FrameGraphRenderPass;
}