Class LightingDebugSettings

Lighting Debug Settings.

Inheritance

LightingDebugSettings

Namespace: UnityEngine.Rendering.HighDefinition

Syntax

[Serializable]
public class 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
Boolean

clearCookieAtlas

Clear cookie atlas each frame.

Declaration

public bool clearCookieAtlas

Field Value

Type	Description
Boolean

clearPlanarReflectionProbeAtlas

Clear planar reflection atlas each frame.

Declaration

public bool clearPlanarReflectionProbeAtlas

Field Value

Type	Description
Boolean

clearShadowAtlas

Clear shadow atlases each frame.

Declaration

public bool clearShadowAtlas

Field Value

Type	Description
Boolean

clusterDebugDistance

Distance at which clusters will be visualized.

Declaration

public float clusterDebugDistance

Field Value

Type	Description
Single

clusterDebugMode

Cluster Debug mode.

Declaration

public ClusterDebugMode clusterDebugMode

Field Value

Type	Description
ClusterDebugMode

cookieAtlasMipLevel

Mip level of the cookie cubemap display.

Declaration

public uint cookieAtlasMipLevel

Field Value

Type	Description
UInt32

cubeArraySliceIndex

Index of the light cubemap to display.

Declaration

public uint cubeArraySliceIndex

Field Value

Type	Description
UInt32

debugExposure

Exposure compensation to apply on current scene exposure.

Declaration

public float debugExposure

Field Value

Type	Description
Single

debugLensAttenuation

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

Declaration

[Obsolete("Please use the lens attenuation mode in HDRP Default Settings", true)]
public float debugLensAttenuation

Field Value

Type	Description
Single

debugLightFilterMode

Current Light Filtering.

Declaration

public DebugLightFilterMode debugLightFilterMode

Field Value

Type	Description
DebugLightFilterMode

debugLightingMode

Current Full Screen Lighting debug mode.

Declaration

public DebugLightingMode debugLightingMode

Field Value

Type	Description
DebugLightingMode

debugLightLayers

True if light layers visualization is enabled.

Declaration

public bool debugLightLayers

Field Value

Type	Description
Boolean

debugLightLayersFilterMask

Current Light Layers Filtering mode.

Declaration

public DebugLightLayersMask debugLightLayersFilterMask

Field Value

Type	Description
DebugLightLayersMask

debugRenderingLayersColors

Rendering Layers Debug Colors.

Declaration

public Vector4[] debugRenderingLayersColors

Field Value

Type	Description
Vector4[]

debugSelectionLightLayers

True if light layers visualization uses light layers of the selected light.

Declaration

public bool debugSelectionLightLayers

Field Value

Type	Description
Boolean

debugSelectionShadowLayers

True if light layers visualization uses shadow layers of the selected light.

Declaration

public bool debugSelectionShadowLayers

Field Value

Type	Description
Boolean

displayCookieAtlas

Display the light cookies atlas.

Declaration

public bool displayCookieAtlas

Field Value

Type	Description
Boolean

displayCookieCubeArray

Display the light cookies cubemap array.

Declaration

public bool displayCookieCubeArray

Field Value

Type	Description
Boolean

displayFinalImageHistogramAsRGB

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

Declaration

public bool displayFinalImageHistogramAsRGB

Field Value

Type	Description
Boolean

displayLightVolumes

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

Declaration

public bool displayLightVolumes

Field Value

Type	Description
Boolean

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
Boolean

displayPlanarReflectionProbeAtlas

Display the planar reflection atlas.

Declaration

public bool displayPlanarReflectionProbeAtlas

Field Value

Type	Description
Boolean

displaySkyReflection

Display sky reflection cubemap as an overlay.

Declaration

public bool displaySkyReflection

Field Value

Type	Description
Boolean

exposureDebugMode

Exposure debug mode.

Declaration

public ExposureDebugMode exposureDebugMode

Field Value

Type	Description
ExposureDebugMode

lightVolumeDebugByCategory

Type of light bounding volumes to display.

Declaration

public LightVolumeDebug lightVolumeDebugByCategory

Field Value

Type	Description
LightVolumeDebug

maxDebugLightCount

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

Declaration

public uint maxDebugLightCount

Field Value

Type	Description
UInt32

overrideAlbedo

Override albedo of the whole scene for lighting debug.

Declaration

public bool overrideAlbedo

Field Value

Type	Description
Boolean

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
Boolean

overrideAmbientOcclusionValue

Value used when overriding ambient occlusion.

Declaration

public float overrideAmbientOcclusionValue

Field Value

Type	Description
Single

overrideEmissiveColor

Override emissive color of the whole scene for lighting debug.

Declaration

public bool overrideEmissiveColor

Field Value

Type	Description
Boolean

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
Boolean

overrideSmoothness

Override smoothness of the whole scene for lighting debug.

Declaration

public bool overrideSmoothness

Field Value

Type	Description
Boolean

overrideSmoothnessValue

Value used when overriding smoothness.

Declaration

public float overrideSmoothnessValue

Field Value

Type	Description
Single

overrideSpecularColor

Override specular color of the whole scene for lighting debug.

Declaration

public bool overrideSpecularColor

Field Value

Type	Description
Boolean

overrideSpecularColorValue

Color used when overriding specular color.

Declaration

public Color overrideSpecularColorValue

Field Value

Type	Description
Color

planarReflectionProbeMipLevel

Mip level of the planar reflection atlas display.

Declaration

public uint planarReflectionProbeMipLevel

Field Value

Type	Description
UInt32

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
Boolean

shadowMapIndex

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

Declaration

public uint shadowMapIndex

Field Value

Type	Description
UInt32

shadowMaxValue

Shadow Map debug display visual remapping maximum value.

Declaration

public float shadowMaxValue

Field Value

Type	Description
Single

shadowMinValue

Shadow Map debug display visual remapping minimum value.

Declaration

public float shadowMinValue

Field Value

Type	Description
Single

shadowResolutionScaleFactor

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

Declaration

public float shadowResolutionScaleFactor

Field Value

Type	Description
Single

showAreaLight

True if area lights should be displayed in the scene.

Declaration

public bool showAreaLight

Field Value

Type	Description
Boolean

showDirectionalLight

True if directional lights should be displayed in the scene.

Declaration

public bool showDirectionalLight

Field Value

Type	Description
Boolean

showPunctualLight

True if punctual lights should be displayed in the scene.

Declaration

public bool showPunctualLight

Field Value

Type	Description
Boolean

showReflectionProbe

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

Declaration

public bool showReflectionProbe

Field Value

Type	Description
Boolean

showTonemapCurveAlongHistogramView

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

Declaration

public bool showTonemapCurveAlongHistogramView

Field Value

Type	Description
Boolean

skyReflectionMipmap

Mip map of the displayed sky reflection.

Declaration

public float skyReflectionMipmap

Field Value

Type	Description
Single

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
Boolean	True if any lighting debug mode is enabled