Struct GlobalDynamicResolutionSettings

User-facing settings for dynamic resolution.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.Rendering

Assembly: Unity.RenderPipelines.Core.Runtime.dll

Syntax

[Serializable]
public struct GlobalDynamicResolutionSettings

Fields

DLSSInjectionPoint

The injection point at which to apply DLSS upscaling.

Declaration

public DynamicResolutionHandler.UpsamplerScheduleType DLSSInjectionPoint

Field Value

Type	Description
DynamicResolutionHandler.UpsamplerScheduleType

DLSSPerfQualitySetting

Opaque quality setting of NVIDIA Deep Learning Super Sampling (DLSS). Use the system enum UnityEngine.NVIDIA.DLSSQuality to set the quality.

Declaration

public uint DLSSPerfQualitySetting

Field Value

Type	Description
uint

DLSSRenderPresetForBalanced

Specifies the DLSS Render Preset to use for the Balanced performance quality setting.

Declaration

public uint DLSSRenderPresetForBalanced

Field Value

Type	Description
uint

DLSSRenderPresetForDLAA

Specifies the DLSS Render Preset to use for the DLAA performance quality setting.

Declaration

public uint DLSSRenderPresetForDLAA

Field Value

Type	Description
uint

DLSSRenderPresetForPerformance

Specifies the DLSS Render Preset to use for the Performance performance quality setting.

Declaration

public uint DLSSRenderPresetForPerformance

Field Value

Type	Description
uint

DLSSRenderPresetForQuality

Specifies the DLSS Render Preset to use for the Quality performance quality setting.

Declaration

public uint DLSSRenderPresetForQuality

Field Value

Type	Description
uint

DLSSRenderPresetForUltraPerformance

Specifies the DLSS Render Preset to use for the UltraPerformance performance quality setting.

Declaration

public uint DLSSRenderPresetForUltraPerformance

Field Value

Type	Description
uint

DLSSSharpness

Pixel sharpness of NVIDIA Deep Learning Super Sampling (DLSS). Unused since DLSS3 as NVIDIA deprecated the sharpness input to DLSS.

Declaration

[Range(0, 1)]
public float DLSSSharpness

Field Value

Type	Description
float

DLSSUseOptimalSettings

Toggle NVIDIA Deep Learning Super Sampling (DLSS) automatic recommendation system for scaling and sharpness. If this is on, the manually established scale callback for Dynamic Resolution Scaling is ignored.

Declaration

public bool DLSSUseOptimalSettings

Field Value

Type	Description
bool

FSR2EnableSharpness

Enable sharpness control for FidelityFX 2.0 Super Resolution (FSR2).

Declaration

public bool FSR2EnableSharpness

Field Value

Type	Description
bool

FSR2InjectionPoint

The injection point at which to apply FSR2 upscaling.

Declaration

public DynamicResolutionHandler.UpsamplerScheduleType FSR2InjectionPoint

Field Value

Type	Description
DynamicResolutionHandler.UpsamplerScheduleType

FSR2QualitySetting

Opaque quality setting of AMD FidelityFX 2.0 Super Resolution (FSR2). Use the system enum UnityEngine.AMD.FSR2Quality to set the quality.

Declaration

public uint FSR2QualitySetting

Field Value

Type	Description
uint

FSR2Sharpness

Pixel sharpness of AMD FidelityFX 2.0 Super Resolution (FSR2).

Declaration

[Range(0, 1)]
public float FSR2Sharpness

Field Value

Type	Description
float

FSR2UseOptimalSettings

Toggle AMD FidelityFX 2.0 Super Resolution (FSR2) automatic recommendation system for scaling. If this is on, the manually established scale callback for Dynamic Resolution Scaling is ignored.

Declaration

public bool FSR2UseOptimalSettings

Field Value

Type	Description
bool

STPInjectionPoint

The injection point at which to apply STP upsampling.

Declaration

public DynamicResolutionHandler.UpsamplerScheduleType STPInjectionPoint

Field Value

Type	Description
DynamicResolutionHandler.UpsamplerScheduleType

TAAUInjectionPoint

The injection point at which to apply TAAU upsampling.

Declaration

public DynamicResolutionHandler.UpsamplerScheduleType TAAUInjectionPoint

Field Value

Type	Description
DynamicResolutionHandler.UpsamplerScheduleType

advancedUpscalerNames

List of upsamplers available for certain platforms by priority.

Declaration

public List<string> advancedUpscalerNames

Field Value

Type	Description
List<string>

advancedUpscalersByPriority

Enables upsamplers available for certain platforms by priority.

Declaration

[Obsolete("Obsolete, use advancedUpscalerNames list instead.")]
public List<AdvancedUpscalers> advancedUpscalersByPriority

Field Value

Type	Description
List<AdvancedUpscalers>

defaultInjectionPoint

The injection point at which to apply the fallback upsampling.

Declaration

public DynamicResolutionHandler.UpsamplerScheduleType defaultInjectionPoint

Field Value

Type	Description
DynamicResolutionHandler.UpsamplerScheduleType

dynResType

The type of dynamic resolution method.

Declaration

public DynamicResolutionType dynResType

Field Value

Type	Description
DynamicResolutionType

enableDLSS

Obsolete, used only for data migration. Use the advancedUpscalersByPriority list instead to add the proper supported advanced upscaler by priority.

Declaration

[Obsolete("Obsolete, used only for data migration. Use the advancedUpscalersByPriority list instead to add the proper supported advanced upscaler by priority. #from(2023.3)", true)]
public bool enableDLSS

Field Value

Type	Description
bool

enabled

Select whether the dynamic resolution is enabled or not.

Declaration

public bool enabled

Field Value

Type	Description
bool

forceResolution

Select whether dynamic resolution system will force a specific resolution percentage.

Declaration

public bool forceResolution

Field Value

Type	Description
bool

forcedPercentage

The resolution percentage forced in case forceResolution is set to true.

Declaration

public float forcedPercentage

Field Value

Type	Description
float

fsrOverrideSharpness

Toggle sharpness override for AMD FidelityFX Super Resolution (FSR). If this is on, a sharpness value specified by the user will be used instead of the default.

Declaration

public bool fsrOverrideSharpness

Field Value

Type	Description
bool

fsrSharpness

Pixel sharpness of AMD FidelityFX Super Resolution (FSR).

Declaration

[Range(0, 1)]
public float fsrSharpness

Field Value

Type	Description
float

lowResSSGIMinimumThreshold

The minimum percentage threshold allowed to clamp low resolution for SSGI (Screen Space Global Illumination). When the resolution percentage falls below this threshold, HDRP will clamp the low resolution to this percentage.

Declaration

public float lowResSSGIMinimumThreshold

Field Value

Type	Description
float

lowResTransparencyMinimumThreshold

The minimum percentage threshold allowed to clamp low resolution transparency. When the resolution percentage falls below this threshold, HDRP will clamp the low resolution to this percentage.

Declaration

public float lowResTransparencyMinimumThreshold

Field Value

Type	Description
float

lowResVolumetricCloudsMinimumThreshold

The minimum percentage threshold allowed to clamp tracing resolution for Volumetric Clouds. When the resolution percentage falls below this threshold, HDRP will trace the Volumetric Clouds in half res.

Declaration

public float lowResVolumetricCloudsMinimumThreshold

Field Value

Type	Description
float

maxPercentage

The maximum resolution percentage that dynamic resolution can reach.

Declaration

public float maxPercentage

Field Value

Type	Description
float

minPercentage

The minimum resolution percentage that dynamic resolution can reach.

Declaration

public float minPercentage

Field Value

Type	Description
float

rayTracingHalfResThreshold

The minimum percentage threshold allowed to render ray tracing effects at half resolution. When the resolution percentage falls below this threshold, HDRP will render ray tracing effects at full resolution.

Declaration

public float rayTracingHalfResThreshold

Field Value

Type	Description
float

upsampleFilter

The default of upscaling filter used. It can be overridden via the API DynamicResolutionHandler.SetUpscaleFilter

Declaration

public DynamicResUpscaleFilter upsampleFilter

Field Value

Type	Description
DynamicResUpscaleFilter

useMipBias

Offsets the mip bias to recover mode detail. This only works if the camera is utilizing TAA.

Declaration

public bool useMipBias

Field Value

Type	Description
bool

Methods

NewDefault()

Default GlobalDynamicResolutionSettings

Declaration

public static GlobalDynamicResolutionSettings NewDefault()

Returns

Type	Description
GlobalDynamicResolutionSettings	A GlobalDynamicResolutionSettings instance initialized with default values.

Extension Methods

AnalyticsUtils.ToNestedColumnWithDefault<T>(T, T, bool)

AnalyticsUtils.ToNestedColumn<T>(T, bool)

AnalyticsUtils.ToNestedColumn<T>(T, T)