@babylonjs/gui
Version:
For usage documentation please visit the [GUI documentation](https://doc.babylonjs.com/features/featuresDeepDive/gui/).
36 lines (35 loc) • 1.28 kB
TypeScript
import { type FrameGraphTextureHandle, type FrameGraph } from "@babylonjs/core/index.js";
import { AdvancedDynamicTexture } from "../advancedDynamicTexture.js";
import { FrameGraphTask } from "@babylonjs/core/FrameGraph/frameGraphTask.js";
/**
* Task that renders a GUI texture.
*/
export declare class FrameGraphGUITask extends FrameGraphTask {
/**
* The target texture to render the GUI to.
*/
targetTexture: FrameGraphTextureHandle;
/**
* The output texture of the task.
* This is the same texture as the target texture, but the handles are different!
*/
readonly outputTexture: FrameGraphTextureHandle;
get disabled(): boolean;
set disabled(value: boolean);
/**
* Gets the underlying advanced dynamic texture.
*/
get gui(): AdvancedDynamicTexture;
protected _adt: AdvancedDynamicTexture;
/**
* Constructs a new GUI task.
* @param name Name of the task
* @param frameGraph Frame graph the task belongs to
* @param adt The GUI texture. If not provided, a new fullscreen GUI will be created.
*/
constructor(name: string, frameGraph: FrameGraph, adt?: AdvancedDynamicTexture);
isReady(): boolean;
getClassName(): string;
record(): void;
dispose(): void;
}