Class FSR1RenderingPipeline
Hierarchy (View Summary)
- PostProcessRenderPipeline
- FSR1RenderingPipeline
Constructors
constructor
-
Creates a new FSR 1 rendering pipeline
Parameters
- name: string
The rendering pipeline name
- scene: Scene
The scene linked to this pipeline
- cameras: any = scene.cameras
The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
Returns FSR1RenderingPipeline
- name: string
Properties
FSR1
The FSR sharpen PostProcess ID in the pipeline
FSR1
The FSR upscale PostProcess ID in the pipeline
inspectable
List of inspectable custom properties (used by the Inspector)
Readonlyunique
Gets the unique id of the post process rendering pipeline
Static ReadonlySCALE_
AMD's recommended scaleFactor for a "Balanced" preset (equal to 1.7)
Static ReadonlySCALE_
AMD's recommended scaleFactor for a "Performance" preset (equal to 2)
Static ReadonlySCALE_
AMD's recommended scaleFactor for a "Quality" preset (equal to 1.5)
Static ReadonlySCALE_
AMD's recommended scaleFactor for an "Ultra Quality" preset (equal to 1.3)
Accessors
cameras
-
Gets the list of attached cameras
Returns Camera[]
engine
-
Gets the active engine
Returns AbstractEngine
is
-
get isSupported(): boolean
Returns true if FSR is supported by the running hardware
Returns boolean
name
-
get name(): string
Gets pipeline name
Returns string
samples
-
get samples(): number
MSAA sample count (default: 4). Disabling MSAA is not recommended since aliased edges will be exaggerated by the FSR pass. Always have at least one AA solution enabled, whether that be MSAA with this setting or a post-process effect like FXAA or TAA.
Returns number
-
set samples(samples: number): void
Parameters
- samples: number
Returns void
scale
-
get scaleFactor(): number
How much smaller to render the scene at (default: 1.5). For example, a value of 2 will render the scene at half resolution.
Returns number
-
set scaleFactor(factor: number): void
Parameters
- factor: number
Returns void
sharpness
-
get sharpnessStops(): number
The number of stops (halving) of the reduction of sharpness (default: 0.2). A value of 0 indicates a maximum sharpness.
Returns number
-
set sharpnessStops(stops: number): void
Parameters
- stops: number
Returns void
Methods
add
-
Adds an effect to the pipeline
Parameters
- renderEffect: PostProcessRenderEffect
the effect to add
Returns void
- renderEffect: PostProcessRenderEffect
dispose
-
Disposes of the pipeline
Returns void
get
-
Gets the class name
Returns string
"PostProcessRenderPipeline"
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
FidelityFX Super Resolution (FSR) 1 render pipeline. This can be used to render the scene at a lower resolution and upscale it.