Struct GlobalDynamicResolutionSettings

User-facing settings for dynamic resolution.

Inherited Members
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

DLSSSharpness

Pixel sharpness of NVIDIA Deep Leraning Super Sampling (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. The sharpness setting of DLSS is also ignored.

Declaration
public bool DLSSUseOptimalSettings
Field Value
Type Description
bool

dynResType

The type of dynamic resolution method.

Declaration
public DynamicResolutionType dynResType
Field Value
Type Description
DynamicResolutionType

enableDLSS

Toggle NVIDIA Deep Learning Super Sampling (DLSS).

Declaration
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

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

Extension Methods