Class UpscalerOptions
Base ScriptableObject for holding configuration data for a specific upscaler. Concrete implementations (e.g., DLSSOptions, FSR2Options) should inherit from this.
Inherited Members
Namespace: UnityEngine.Rendering
Assembly: Unity.RenderPipelines.Core.Runtime.dll
Syntax
[Serializable]
public class UpscalerOptions : ScriptableObjectProperties
applyReactiveMaskThreshold
Set reactive mask value to zero or Reactive Mask Binary Value given the threshold.
Declaration
public bool applyReactiveMaskThreshold { get; }Property Value
| Type | Description |
|---|---|
| bool |
enableReactiveMaskPass
Reactive mask generation pass is executed only if current upscaler supports reactive mask and this option is true.
Declaration
public bool enableReactiveMaskPass { get; }Property Value
| Type | Description |
|---|---|
| bool |
injectionPoint
Determines at which stage in the render pipeline the upscaling pass is injected.
Declaration
public DynamicResolutionHandler.UpsamplerScheduleType injectionPoint { get; set; }Property Value
| Type | Description |
|---|---|
| DynamicResolutionHandler.UpsamplerScheduleType |
reactiveMaskBinaryValue
The value that reactive mask will have if it passes the threshold.
Declaration
public float reactiveMaskBinaryValue { get; }Property Value
| Type | Description |
|---|---|
| float |
reactiveMaskScale
Scale factor for reactive mask values. It is applied before thresholding.
Declaration
public float reactiveMaskScale { get; }Property Value
| Type | Description |
|---|---|
| float |
reactiveMaskThreshold
Determines the threshold value for reactive mask values.
Declaration
public float reactiveMaskThreshold { get; }Property Value
| Type | Description |
|---|---|
| float |
reactiveMaskUseComponentMax
Use max difference among R, G, B channels instead of length of delta of (R, G, B) when calculating reactivity.
Declaration
public bool reactiveMaskUseComponentMax { get; }Property Value
| Type | Description |
|---|---|
| bool |
resolutionMode
Selects how the render resolution is determined for this upscaler. Only meaningful for upscalers that expose a quality mode (hasQualityMode); for the others it is dormant and the upscaler always behaves as CustomScaling.
Declaration
public UpscalerResolutionMode resolutionMode { get; set; }Property Value
| Type | Description |
|---|---|
| UpscalerResolutionMode |
upscalerId
The ID of the upscaler associated with these options.
Declaration
public string upscalerId { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Methods
ValidateSerializedUpscalerOptionReferencesWithinRPAsset(ScriptableObject, SerializedProperty, IReadOnlyList<string>?)
Validates and auto-populates the upscaler options list within a Render Pipeline Asset. It ensures that the selected upscalers, and only those, have a corresponding Options sub-asset.
Declaration
public static bool ValidateSerializedUpscalerOptionReferencesWithinRPAsset(ScriptableObject parentRPAsset, SerializedProperty optionsListProp, IReadOnlyList<string>? upscalerIds)Parameters
| Type | Name | Description |
|---|---|---|
| ScriptableObject | parentRPAsset | The Render Pipeline Asset that will contain these options as sub-assets. |
| SerializedProperty | optionsListProp | The SerializedProperty representing the list/array of UpscalerOptions. |
| IReadOnlyList<string> | upscalerIds | IDs of the upscalers the asset selects. Entries that name no registered upscaler, or one without an options type, are ignored. |
Returns
| Type | Description |
|---|---|
| bool | True if the property was modified (cleaned up or populated), false otherwise. |