Class FrameGraphSSRRenderingPipelineTask
Hierarchy (View Summary)
- FrameGraphTask
- FrameGraphSSRRenderingPipelineTask
Constructors
constructor
-
new FrameGraphSSRRenderingPipelineTask(
name: string,
frameGraph: FrameGraph,
textureType?: any,
): FrameGraphSSRRenderingPipelineTaskConstructs a SSR rendering pipeline task.
Parameters
- name: string
The name of the task.
- frameGraph: FrameGraph
The frame graph this task belongs to.
- textureType: any = Constants.TEXTURETYPE_UNSIGNED_BYTE
The texture type used by the different post processes created by SSR (default: Constants.TEXTURETYPE_UNSIGNED_BYTE)
Returns FrameGraphSSRRenderingPipelineTask
- name: string
Properties
Optionalback
The back depth texture used by the SSR effect (optional). This is used when automatic thickness computation is enabled. The back depth texture is the depth texture of the scene rendered for the back side of the objects (that is, front faces are culled).
Optionaldependencies
The (texture) dependencies of the task (optional).
depth
The depth texture used by the SSR effect.
normal
The normal texture used by the SSR effect.
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 SSR effect.
reflectivity
The reflectivity texture used by the SSR effect
source
The sampling mode to use for the source texture.
source
The source texture to apply the SSR effect on.
Readonlyssr
The SSR Rendering pipeline.
Optionaltarget
The target texture to render the SSR effect to.
Readonlytexture
The texture type used by the different post processes created by SSR. It's a read-only property. If you want to change it, you must recreate the task and pass the appropriate texture type to the constructor.
Accessors
alpha
-
get alphaMode(): number
The alpha mode to use when applying the SSR effect.
Returns number
-
set alphaMode(mode: number): void
Parameters
- mode: number
Returns void
camera
-
get camera(): Camera
The camera used to render the scene.
Returns Camera
-
set camera(camera: Camera): void
Parameters
- camera: 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(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 which applies a SSR post process.