Class FrameGraphHighlightLayerTask
Hierarchy
- FrameGraphBaseLayerTask
- FrameGraphHighlightLayerTask
Constructors
constructor
-
new FrameGraphHighlightLayerTask(
name: string,
frameGraph: FrameGraph,
scene: Scene,
options?: any,
): FrameGraphHighlightLayerTaskConstructs a new highlight layer task.
Parameters
- name: string
Name of the task.
- frameGraph: FrameGraph
The frame graph this task is associated with.
- scene: Scene
The scene to render the highlight layer in.
Optionaloptions: anyOptions for the highlight layer.
Returns FrameGraphHighlightLayerTask
- name: string
Properties
Optionaldependencies
The (texture) dependencies of the task (optional).
Readonlylayer
The highlight layer object. Use this object to update the highlight layer properties.
Optionallayer
The layer texture to render the effect into. If not provided, a default texture will be created.
object
The object renderer task used to render the objects in the texture to which the layer will be applied. This is needed because the layer may have to inject code in the rendering manager used by object renderer task.
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 (same as targetTexture, but the handle will be different).
target
The target texture to apply the effect layer to. The effect will be blended with the contents of this texture.
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(name: string): void
The name of the task.
Parameters
- name: string
Returns void
object
-
Gets the object renderer used to render the layer.
Returns FrameGraphObjectRendererTask
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 the layer task and its dependent tasks.
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 whether the layer task is ready.
Returns any
true if the layer task is ready
record
-
Records the layer task into the frame graph.
Returns void
Task which applies a highlight effect to a texture.