Class FrameGraphCopyToTextureTask
Hierarchy (View Summary)
- FrameGraphTask
- FrameGraphCopyToTextureTask
Constructors
constructor
-
new FrameGraphCopyToTextureTask(
name: string,
frameGraph: FrameGraph,
): FrameGraphCopyToTextureTaskConstructs a new FrameGraphCopyToTextureTask.
Parameters
- name: string
The name of the task.
- frameGraph: FrameGraph
The frame graph the task belongs to.
Returns FrameGraphCopyToTextureTask
- name: string
Properties
Optionaldependencies
The (texture) dependencies of the task (optional).
lod
The LOD level to copy from the source texture (default: 0).
on
An observable that is triggered after the task is executed.
on
An observable that is triggered before the task is executed.
on
An observable that is triggered after the textures have been allocated.
Readonlyoutput
The output texture (same as targetTexture, but the handle may be different).
source
The source texture to copy from.
target
The target texture to copy to.
Optionalviewport
The viewport to use when doing the copy. If set to null, the currently active viewport is used. If undefined (default), the viewport is reset to a full screen viewport before performing the copy.
Accessors
disabled
-
get disabled(): boolean
Whether the task is disabled.
Returns boolean
-
set disabled(value: boolean): void
Parameters
- value: boolean
Returns void
name
-
get name(): string
The name of the task.
Returns string
-
set name(value: string): void
Parameters
- value: string
Returns void
passes
-
get passes(): IFrameGraphPass[]
Gets the passes of the task.
Returns IFrameGraphPass[]
passes
-
get passesDisabled(): IFrameGraphPass[]
Gets the disabled passes of the task.
Returns IFrameGraphPass[]
Methods
dispose
-
Disposes of the task.
Returns void
get
-
Gets the current class name
Returns string
the class name
init
-
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.
is
-
Checks if the task is ready to be executed.
Returns boolean
True if the task is ready to be executed, else false.
record
-
Records the task in the frame graph. Use this function to add content (render passes, ...) to the task.
Returns void
Task used to copy a texture to another texture.