Class FrameGraphLightingVolumeTask
Hierarchy (View Summary)
- FrameGraphTask
- FrameGraphLightingVolumeTask
Constructors
constructor
-
new FrameGraphLightingVolumeTask(
name: string,
frameGraph: FrameGraph,
): FrameGraphLightingVolumeTaskCreates a new FrameGraphLightingVolumeTask.
Parameters
- name: string
Name of the task.
- frameGraph: FrameGraph
The frame graph instance.
Returns FrameGraphLightingVolumeTask
- name: string
Properties
Optionaldependencies
The (texture) dependencies of the task (optional).
Readonlylighting
The lighting volume created by this 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 object list containing the lighting volume mesh. You can get the mesh by doing outputMeshLightingVolume.meshes[0]
shadow
The shadow generator used to create the lighting volume.
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
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 any
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 create a lighting volume from a directional light's shadow generator.