Class LightingDebugSettings

Lighting Debug Settings.

Inheritance
object
LightingDebugSettings
Inherited Members
Namespace: UnityEngine.Rendering.HighDefinition
Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
Syntax
[Serializable]
public class LightingDebugSettings

Constructors

LightingDebugSettings()

Declaration
public LightingDebugSettings()

Fields

centerHistogramAroundMiddleGrey

Whether to center the histogram debug view around the middle-grey point or not.

Declaration
public bool centerHistogramAroundMiddleGrey
Field Value
Type Description
bool

clearCookieAtlas

Clear cookie atlas each frame.

Declaration
public bool clearCookieAtlas
Field Value
Type Description
bool

clearReflectionProbeAtlas

Clear reflection probe atlas each frame.

Declaration
public bool clearReflectionProbeAtlas
Field Value
Type Description
bool

clearShadowAtlas

Clear shadow atlases each frame.

Declaration
public bool clearShadowAtlas
Field Value
Type Description
bool

clusterDebugDistance

Distance at which clusters will be visualized.

Declaration
public float clusterDebugDistance
Field Value
Type Description
float

clusterDebugMode

Cluster Debug mode.

Declaration
public ClusterDebugMode clusterDebugMode
Field Value
Type Description
ClusterDebugMode

clusterLightCategory

Light category for cluster debug view.

Declaration
public ClusterLightCategoryDebug clusterLightCategory
Field Value
Type Description
ClusterLightCategoryDebug

cookieAtlasMipLevel

Mip level of the cookie cubemap display.

Declaration
public uint cookieAtlasMipLevel
Field Value
Type Description
uint

cubeArraySliceIndex

Index of the light cubemap to display.

Declaration
public uint cubeArraySliceIndex
Field Value
Type Description
uint

debugExposure

Exposure compensation to apply on current scene exposure.

Declaration
public float debugExposure
Field Value
Type Description
float

debugLensAttenuation

Obsolete, please use the lens attenuation mode in HDRP Global Settings.

Declaration
[Obsolete("Please use the lens attenuation mode in HDRP Global Settings. #from(2021.1) #breakingFrom(2021.1)", true)]
public float debugLensAttenuation
Field Value
Type Description
float

debugLightFilterMode

Current Light Filtering.

Declaration
public DebugLightFilterMode debugLightFilterMode
Field Value
Type Description
DebugLightFilterMode

debugLightLayersFilterMask

Current filtered Rendering Layer Mask.

Declaration
public RenderingLayerMask debugLightLayersFilterMask
Field Value
Type Description
RenderingLayerMask

debugLightingMode

Current Full Screen Lighting debug mode.

Declaration
public DebugLightingMode debugLightingMode
Field Value
Type Description
DebugLightingMode

debugRenderingLayersColors

Rendering Layers Debug Colors.

Declaration
public Vector4[] debugRenderingLayersColors
Field Value
Type Description
Vector4[]

debugSelectionLightLayers

True if filter should match Light Layer mask of the selected light.

Declaration
public bool debugSelectionLightLayers
Field Value
Type Description
bool

debugSelectionShadowLayers

True if filter should match Custom Shadow Layer mask of the selected light.

Declaration
public bool debugSelectionShadowLayers
Field Value
Type Description
bool

displayCookieAtlas

Display the light cookies atlas.

Declaration
public bool displayCookieAtlas
Field Value
Type Description
bool

displayCookieCubeArray

Display the light cookies cubemap array.

Declaration
public bool displayCookieCubeArray
Field Value
Type Description
bool

displayFinalImageHistogramAsRGB

Whether to show tonemap curve in the histogram debug view or not.

Declaration
public bool displayFinalImageHistogramAsRGB
Field Value
Type Description
bool

displayLightVolumes

Display lights bounding volumes as a transparent overlay in the scene.

Declaration
public bool displayLightVolumes
Field Value
Type Description
bool

displayLocalVolumetricFogAtlas

Display the Local Volumetric Fog atlas.

Declaration
[Obsolete("The local volumetric fog atlas was removed. This field is unused. #from(2023.1)")]
public bool displayLocalVolumetricFogAtlas
Field Value
Type Description
bool

displayMaskOnly

Whether to show the only the mask in the picture in picture. If unchecked, the mask view is weighted by the scene color.

Declaration
public bool displayMaskOnly
Field Value
Type Description
bool

displayOnSceneOverlay

Whether to show the on scene overlay displaying pixels excluded by the exposure computation via histogram.

Declaration
public bool displayOnSceneOverlay
Field Value
Type Description
bool

displayReflectionProbeAtlas

Display the reflection probe atlas.

Declaration
public bool displayReflectionProbeAtlas
Field Value
Type Description
bool

displaySkyReflection

Display sky reflection cubemap as an overlay.

Declaration
public bool displaySkyReflection
Field Value
Type Description
bool

exposureDebugMode

Exposure debug mode.

Declaration
public ExposureDebugMode exposureDebugMode
Field Value
Type Description
ExposureDebugMode

hdrDebugMode

HDR debug mode.

Declaration
public HDRDebugMode hdrDebugMode
Field Value
Type Description
HDRDebugMode

lightVolumeDebugByCategory

Type of light bounding volumes to display.

Declaration
public LightVolumeDebug lightVolumeDebugByCategory
Field Value
Type Description
LightVolumeDebug

localVolumetricFogAtlasSlice

Local Volumetric Fog atlas slice.

Declaration
public uint localVolumetricFogAtlasSlice
Field Value
Type Description
uint

localVolumetricFogUseSelection

True if Local Volumetric Fog Atlas debug mode should be displayed for the currently selected Local Volumetric Fog.

Declaration
public bool localVolumetricFogUseSelection
Field Value
Type Description
bool

matCapMixAlbedo

Enable to make HDRP mix the albedo of the Material with its material capture.

Declaration
public bool matCapMixAlbedo
Field Value
Type Description
bool

matCapMixScale

Set the intensity of the material capture. This increases the brightness of the Scene. This is useful if the albedo darkens the Scene considerably.

Declaration
public float matCapMixScale
Field Value
Type Description
float

maxDebugLightCount

Maximum number of lights against which the light overdraw gradient is displayed.

Declaration
public uint maxDebugLightCount
Field Value
Type Description
uint

overrideAlbedo

Override albedo of the whole scene for lighting debug.

Declaration
public bool overrideAlbedo
Field Value
Type Description
bool

overrideAlbedoValue

Color used when overriding albedo.

Declaration
public Color overrideAlbedoValue
Field Value
Type Description
Color

overrideAmbientOcclusion

Override ambient occlusion of the whole scene for lighting debug.

Declaration
public bool overrideAmbientOcclusion
Field Value
Type Description
bool

overrideAmbientOcclusionValue

Value used when overriding ambient occlusion.

Declaration
public float overrideAmbientOcclusionValue
Field Value
Type Description
float

overrideEmissiveColor

Override emissive color of the whole scene for lighting debug.

Declaration
public bool overrideEmissiveColor
Field Value
Type Description
bool

overrideEmissiveColorValue

Color used when overriding emissive color.

Declaration
public Color overrideEmissiveColorValue
Field Value
Type Description
Color

overrideNormal

Override normal of the whole scene with object normals for lighting debug.

Declaration
public bool overrideNormal
Field Value
Type Description
bool

overrideSmoothness

Override smoothness of the whole scene for lighting debug.

Declaration
public bool overrideSmoothness
Field Value
Type Description
bool

overrideSmoothnessValue

Value used when overriding smoothness.

Declaration
public float overrideSmoothnessValue
Field Value
Type Description
float

overrideSpecularColor

Override specular color of the whole scene for lighting debug.

Declaration
public bool overrideSpecularColor
Field Value
Type Description
bool

overrideSpecularColorValue

Color used when overriding specular color.

Declaration
public Color overrideSpecularColorValue
Field Value
Type Description
Color

reflectionProbeApplyExposure

Apply exposure to displayed atlas.

Declaration
public bool reflectionProbeApplyExposure
Field Value
Type Description
bool

reflectionProbeMipLevel

Mip level of the reflection probe atlas display.

Declaration
public uint reflectionProbeMipLevel
Field Value
Type Description
uint

reflectionProbeSlice

Slice of the reflection probe atlas display.

Declaration
public uint reflectionProbeSlice
Field Value
Type Description
uint

shadowDebugMode

Current Shadow Maps debug mode.

Declaration
public ShadowMapDebugMode shadowDebugMode
Field Value
Type Description
ShadowMapDebugMode

shadowDebugUseSelection

True if Shadow Map debug mode should be displayed for the currently selected light.

Declaration
public bool shadowDebugUseSelection
Field Value
Type Description
bool

shadowMapIndex

Index in the list of currently visible lights of the shadow map to display.

Declaration
public uint shadowMapIndex
Field Value
Type Description
uint

shadowMaxValue

Shadow Map debug display visual remapping maximum value.

Declaration
public float shadowMaxValue
Field Value
Type Description
float

shadowMinValue

Shadow Map debug display visual remapping minimum value.

Declaration
public float shadowMinValue
Field Value
Type Description
float

shadowResolutionScaleFactor

Use this value to force a rescale of all shadow atlases.

Declaration
public float shadowResolutionScaleFactor
Field Value
Type Description
float

showAreaLight

True if area lights should be displayed in the scene.

Declaration
public bool showAreaLight
Field Value
Type Description
bool

showDirectionalLight

True if directional lights should be displayed in the scene.

Declaration
public bool showDirectionalLight
Field Value
Type Description
bool

showPunctualLight

True if punctual lights should be displayed in the scene.

Declaration
public bool showPunctualLight
Field Value
Type Description
bool

showReflectionProbe

True if reflection probes lights should be displayed in the scene.

Declaration
public bool showReflectionProbe
Field Value
Type Description
bool

showTonemapCurveAlongHistogramView

Whether to show tonemap curve in the histogram debug view or not.

Declaration
public bool showTonemapCurveAlongHistogramView
Field Value
Type Description
bool

skyReflectionMipmap

Mip map of the displayed sky reflection.

Declaration
public float skyReflectionMipmap
Field Value
Type Description
float

tileClusterDebug

Tile and Cluster debug mode.

Declaration
public TileClusterDebug tileClusterDebug
Field Value
Type Description
TileClusterDebug

tileClusterDebugByCategory

Category for tile and cluster debug mode.

Declaration
public TileClusterCategoryDebug tileClusterDebugByCategory
Field Value
Type Description
TileClusterCategoryDebug

Methods

IsDebugDisplayEnabled()

Returns true if any lighting debug mode is enabled.

Declaration
public bool IsDebugDisplayEnabled()
Returns
Type Description
bool

True if any lighting debug mode is enabled