Class FrameGraphUtilityLayerRendererTask
Hierarchy (View Summary)
- FrameGraphTask
- FrameGraphUtilityLayerRendererTask
Constructors
constructor
-
new FrameGraphUtilityLayerRendererTask(
name: string,
frameGraph: FrameGraph,
scene: Scene,
handleEvents?: boolean,
): FrameGraphUtilityLayerRendererTaskCreates a new utility layer renderer task.
Parameters
- name: string
The name of the task.
- frameGraph: FrameGraph
The frame graph the task belongs to.
- scene: Scene
The scene the task belongs to.
- handleEvents: boolean = true
If the utility layer should handle events.
Returns FrameGraphUtilityLayerRendererTask
- name: string
Properties
Optionaldependencies
The (texture) dependencies of the task (optional).
Readonlylayer
The utility layer renderer.
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 of the task. This is the same texture as the target texture, but the handles are different!
target
The target texture of the task.
Accessors
camera
-
get camera(): Camera
The camera used to render the utility layer.
Returns Camera
-
set camera(value: Camera): void
Parameters
- value: Camera
Returns void
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 render an utility layer.