Class TAARenderingPipeline
Hierarchy (View Summary)
- PostProcessRenderPipeline
- TAARenderingPipeline
Constructors
constructor
-
new TAARenderingPipeline(
name: string,
scene: Scene,
cameras?: Camera[],
textureType?: number,
): TAARenderingPipelineConstructor of the TAA rendering pipeline
Parameters
- name: string
The rendering pipeline name
- scene: Scene
The scene linked to this pipeline
Optionalcameras: Camera[]The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
- textureType: number = Constants.TEXTURETYPE_UNSIGNED_BYTE
The type of texture where the scene will be rendered (default: Constants.TEXTURETYPE_UNSIGNED_BYTE)
Returns TAARenderingPipeline
- name: string
Properties
inspectable
List of inspectable custom properties (used by the Inspector)
TAA
The pass PostProcess effect id in the pipeline
TAA
The TAA PostProcess effect id in the pipeline
Readonlyunique
Gets the unique id of the post process rendering pipeline
Accessors
cameras
-
Gets the list of attached cameras
Returns Camera[]
clamp
-
get clampHistory(): boolean
Clamps the history pixel to the min and max of the 3x3 pixels surrounding the target pixel. This can help further reduce ghosting and artifacts.
Returns boolean
-
set clampHistory(history: boolean): void
Parameters
- history: boolean
Returns void
disable
-
get disableOnCameraMove(): boolean
Disable TAA on camera move (default: true). You generally want to keep this enabled, otherwise you will get a ghost effect when the camera moves (but if it's what you want, go for it!)
Returns boolean
-
set disableOnCameraMove(value: boolean): void
Parameters
- value: boolean
Returns void
engine
-
Gets the active engine
Returns AbstractEngine
factor
-
get factor(): number
The factor used to blend the history frame with current frame (default: 0.05)
Returns number
-
set factor(value: number): void
Parameters
- value: number
Returns void
is
-
get isEnabled(): boolean
Gets or sets a boolean indicating if the render pipeline is enabled (default: true).
Returns boolean
-
set isEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
is
-
get isSupported(): boolean
Returns true if TAA is supported by the running hardware
Returns boolean
msaa
-
get msaaSamples(): number
Returns number
-
set msaaSamples(samples: number): void
MSAA samples (default: 1)
Parameters
- samples: number
Returns void
name
-
get name(): string
Gets pipeline name
Returns string
reproject
-
get reprojectHistory(): boolean
Enables reprojecting the history texture with a per-pixel velocity.
Returns boolean
-
set reprojectHistory(reproject: boolean): void
Parameters
- reproject: boolean
Returns void
samples
-
get samples(): number
Returns number
-
set samples(samples: number): void
Number of accumulated samples (default: 16)
Parameters
- samples: number
Returns void
scene
-
Gets active scene
Returns Scene
Methods
add
add
-
Adds an effect to the pipeline
Parameters
- renderEffect: PostProcessRenderEffect
the effect to add
Returns void
- renderEffect: PostProcessRenderEffect
dispose
-
Removes the internal pipeline assets and detaches the pipeline from the scene cameras
Returns void
get
-
Get the class name
Returns string
"TAARenderingPipeline"
remove
serialize
-
Serializes the rendering pipeline (Used when exporting)
Returns any
the serialized object
set
-
Sets the required values to the prepass renderer.
Parameters
- prePassRenderer: PrePassRenderer
defines the prepass renderer to setup.
Returns boolean
true if the pre pass is needed.
- prePassRenderer: PrePassRenderer
Simple implementation of Temporal Anti-Aliasing (TAA). This can be used to improve image quality for still pictures (screenshots for e.g.). Note that TAA post-process must be the first in the camera, so TAARenderingPipeline must be created before any other pipeline/post-processing.