Class DebugDisplaySettings

Class managing debug display in HDRP.

Inheritance

object

DebugDisplaySettings

Implements

IDebugData

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.Rendering.HighDefinition

Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll

Syntax

public class DebugDisplaySettings : IDebugData

Properties

data

Debug data.

Declaration

public DebugDisplaySettings.DebugData data { get; }

Property Value

Type	Description
DebugDisplaySettings.DebugData

lightingFullScreenDebugStrings

List of Full Screen Lighting Debug mode names.

Declaration

public static GUIContent[] lightingFullScreenDebugStrings { get; }

Property Value

Type	Description
GUIContent[]

lightingFullScreenDebugValues

List of Full Screen Lighting Debug mode values.

Declaration

public static int[] lightingFullScreenDebugValues { get; }

Property Value

Type	Description
int[]

lightingFullScreenRTASDebugModeStrings

List of Full Screen Lighting RTAS Debug mode names.

Declaration

[Obsolete("Use autoenum instead @from(2022.2)")]
public static GUIContent[] lightingFullScreenRTASDebugModeStrings { get; }

Property Value

Type	Description
GUIContent[]

lightingFullScreenRTASDebugModeValues

List of Full Screen Lighting RTAS Debug mode values.

Declaration

[Obsolete("Use autoenum instead @from(2022.2)")]
public static int[] lightingFullScreenRTASDebugModeValues { get; }

Property Value

Type	Description
int[]

lightingFullScreenRTASDebugViewStrings

List of Full Screen Lighting RTAS Debug view names.

Declaration

[Obsolete("Use autoenum instead @from(2022.2)")]
public static GUIContent[] lightingFullScreenRTASDebugViewStrings { get; }

Property Value

Type	Description
GUIContent[]

lightingFullScreenRTASDebugViewValues

List of Full Screen Lighting RTAS Debug view values.

Declaration

[Obsolete("Use autoenum instead @from(2022.2)")]
public static int[] lightingFullScreenRTASDebugViewValues { get; }

Property Value

Type	Description
int[]

renderingFullScreenDebugStrings

List of Full Screen Rendering Debug mode names.

Declaration

public static GUIContent[] renderingFullScreenDebugStrings { get; }

Property Value

Type	Description
GUIContent[]

renderingFullScreenDebugValues

List of Full Screen Rendering Debug mode values.

Declaration

public static int[] renderingFullScreenDebugValues { get; }

Property Value

Type	Description
int[]

Methods

GetDebugColorPickerMode()

Returns the current Color Picker Mode.

Declaration

public ColorPickerDebugMode GetDebugColorPickerMode()

Returns

Type	Description
ColorPickerDebugMode	Current Color Picker Mode.

GetDebugLightFilterMode()

Returns the current Light filtering mode.

Declaration

public DebugLightFilterMode GetDebugLightFilterMode()

Returns

Type	Description
DebugLightFilterMode	Current Light filtering mode.

GetDebugLightLayersMask()

Returns the current Light Layers Debug Mask.

Declaration

public RenderingLayerMask GetDebugLightLayersMask()

Returns

Type	Description
RenderingLayerMask	Current Light Layers Debug Mask.

GetDebugLightingMode()

Returns the current Lighting Debug Mode.

Declaration

public DebugLightingMode GetDebugLightingMode()

Returns

Type	Description
DebugLightingMode	Current Lighting Debug Mode.

GetDebugMipMapMaterialTextureSlot()

Returns the current Material Texture Slot for texture mipmap streaming.

Declaration

public int GetDebugMipMapMaterialTextureSlot()

Returns

Type	Description
int	Current Material Texture Slot for texture mipmap streaming.

GetDebugMipMapMode()

Returns the current Debug Mode for texture mipmap streaming.

Declaration

public DebugMipMapMode GetDebugMipMapMode()

Returns

Type	Description
DebugMipMapMode	Current Debug Mode for texture mipmap streaming.

GetDebugMipMapModeTerrainTexture()

Returns the current Terrain Layer for texture mipmap streaming.

Declaration

public DebugMipMapModeTerrainTexture GetDebugMipMapModeTerrainTexture()

Returns

Type	Description
DebugMipMapModeTerrainTexture	Current Terrain Layer for texture mipmap streaming.

GetDebugMipMapOpacity()

Returns the opacity for texture mipmap streaming debugging colors.

Declaration

public float GetDebugMipMapOpacity()

Returns

Type	Description
float	Opacity for texture mipmap streaming debugging colors.

GetDebugMipMapRecentlyUpdatedCooldown()

Returns the amount of time (in seconds) that a texture should be considered recently updated.

Declaration

public float GetDebugMipMapRecentlyUpdatedCooldown()

Returns

Type	Description
float	The amount of time (in seconds) that a texture should be considered recently updated.

GetDebugMipMapShowStatusCode()

Returns whether the status codes are rendered when the Texture Streaming Status debug mode is enabled.

Declaration

public bool GetDebugMipMapShowStatusCode()

Returns

Type	Description
bool	True if the status codes are rendered when the Texture Streaming Status debug mode is enabled.

GetDebugMipMapStatusMode()

Returns the current aggregation mode when debug information can be aggregated per material.

Declaration

public DebugMipMapStatusMode GetDebugMipMapStatusMode()

Returns

Type	Description
DebugMipMapStatusMode	Current aggregation mode when debug information can be aggregated per material

GetDebugShadowMapMode()

Returns the current Shadow Map Debug Mode.

Declaration

public ShadowMapDebugMode GetDebugShadowMapMode()

Returns

Type	Description
ShadowMapDebugMode	Current Shadow Map Debug Mode.

IsCameraFreezeEnabled()

Returns true if camera visibility is frozen.

Declaration

public bool IsCameraFreezeEnabled()

Returns

Type	Description
bool	True if camera visibility is frozen

IsCameraFrozen(Camera)

Returns true if a specific camera is frozen for visibility.

Declaration

public bool IsCameraFrozen(Camera camera)

Parameters

Type	Name	Description
Camera	camera	Camera to be tested.

Returns

Type	Description
bool	True if a specific camera is frozen for visibility.

IsDebugDisplayEnabled()

Returns true if any debug display is enabled.

Declaration

public bool IsDebugDisplayEnabled()

Returns

Type	Description
bool	True if any debug display is enabled.

IsDebugExposureModeEnabled()

Returns true if any full screen exposure debug display is enabled.

Declaration

public bool IsDebugExposureModeEnabled()

Returns

Type	Description
bool	True if any full screen exposure debug display is enabled.

IsDebugFullScreenEnabled()

Returns true if any full screen debug display is enabled.

Declaration

public bool IsDebugFullScreenEnabled()

Returns

Type	Description
bool	True if any full screen debug display is enabled.

IsDebugMaterialDisplayEnabled()

Returns true if any material debug display is enabled.

Declaration

public bool IsDebugMaterialDisplayEnabled()

Returns

Type	Description
bool	True if any material debug display is enabled.

IsDebugMipMapDisplayEnabled()

Returns true if mip map debug display is enabled.

Declaration

public bool IsDebugMipMapDisplayEnabled()

Returns

Type	Description
bool	True if any mip mapdebug display is enabled.

IsHDRDebugModeEnabled()

Returns true if any full screen HDR debug display is enabled.

Declaration

public bool IsHDRDebugModeEnabled()

Returns

Type	Description
bool	True if any full screen exposure debug display is enabled.

IsMatcapViewEnabled(HDCamera)

Returns true if matcap view is enabled for a particular camera.

Declaration

public bool IsMatcapViewEnabled(HDCamera camera)

Parameters

Type	Name	Description
HDCamera	camera	Input camera.

Returns

Type	Description
bool	True if matcap view is enabled for a particular camera.

IsMaterialValidationEnabled()

Returns true if material validation is enabled.

Declaration

public bool IsMaterialValidationEnabled()

Returns

Type	Description
bool	True if any material validation is enabled.

SetDebugLightFilterMode(DebugLightFilterMode)

Set the current Light Filtering.

Declaration

public void SetDebugLightFilterMode(DebugLightFilterMode value)

Parameters

Type	Name	Description
DebugLightFilterMode	value	Desired Light Filtering.

SetDebugLightLayersMode(bool)

Enable or disable Rendering layers Debug

Declaration

public void SetDebugLightLayersMode(bool value)

Parameters

Type	Name	Description
bool	value	Desired Rendering Layers Debug Mode.

SetDebugLightingMode(DebugLightingMode)

Set the current Lighting Debug Mode.

Declaration

public void SetDebugLightingMode(DebugLightingMode value)

Parameters

Type	Name	Description
DebugLightingMode	value	Desired Lighting Debug Mode.

SetDebugMipMapMaterialTextureSlot(int)

Set the current Mip Map Debug Material Texture Slot.

Declaration

public void SetDebugMipMapMaterialTextureSlot(int value)

Parameters

Type	Name	Description
int	value	Desired Mip Map debug Material Texture Slot.

SetDebugMipMapModeTerrainTexture(DebugMipMapModeTerrainTexture)

Set the current Terrain Texture Mip Map Debug Mode.

Declaration

public void SetDebugMipMapModeTerrainTexture(DebugMipMapModeTerrainTexture value)

Parameters

Type	Name	Description
DebugMipMapModeTerrainTexture	value	Desired Terrain Texture Mip Map Debug Mode.

SetDebugMipMapOpacity(float)

Set the current opacity for Mip Map debugging.

Declaration

public void SetDebugMipMapOpacity(float value)

Parameters

Type	Name	Description
float	value	Desired Mip Map debug opacity.

SetDebugMipMapRecentlyUpdatedCooldown(float)

Set the amount of time that a texture should be considered "recently updated".

Declaration

public void SetDebugMipMapRecentlyUpdatedCooldown(float value)

Parameters

Type	Name	Description
float	value	Desired amount of time to consider a texture to be "recently updated".

SetDebugMipMapShowStatusCode(bool)

Sets whether the Status Code is rendered when the Status Debug Mode is enabled.

Declaration

public void SetDebugMipMapShowStatusCode(bool value)

Parameters

Type	Name	Description
bool	value	Desired Status Code Visibility.

SetDebugMipMapStatusMode(DebugMipMapStatusMode)

Sets the current Status Code Mode when the Status Debug Mode is enabled.

Declaration

public void SetDebugMipMapStatusMode(DebugMipMapStatusMode value)

Parameters

Type	Name	Description
DebugMipMapStatusMode	value	Desired Mip Map Status Code Mode.

SetDebugViewCommonMaterialProperty(MaterialSharedProperty)

Set the current shared material properties debug view.

Declaration

public void SetDebugViewCommonMaterialProperty(MaterialSharedProperty value)

Parameters

Type	Name	Description
MaterialSharedProperty	value	Desired shared material property to display.

SetDebugViewEngine(int)

Set the current engine debug view.

Declaration

public void SetDebugViewEngine(int value)

Parameters

Type	Name	Description
int	value	Desired engine debug view.

SetDebugViewGBuffer(int)

Set the current GBuffer debug view.

Declaration

public void SetDebugViewGBuffer(int value)

Parameters

Type	Name	Description
int	value	Desired GBuffer debug view.

SetDebugViewMaterial(int)

Set the current material debug view.

Declaration

public void SetDebugViewMaterial(int value)

Parameters

Type	Name	Description
int	value	Desired material debug view.

SetDebugViewProperties(DebugViewProperties)

Set the current Material Property debug view.

Declaration

public void SetDebugViewProperties(DebugViewProperties value)

Parameters

Type	Name	Description
DebugViewProperties	value	Desired property debug view.

SetDebugViewVarying(DebugViewVarying)

Set current varying debug view.

Declaration

public void SetDebugViewVarying(DebugViewVarying value)

Parameters

Type	Name	Description
DebugViewVarying	value	Desired varying debug view.

SetFullScreenDebugMode(FullScreenDebugMode)

Set the current Full Screen Debug Mode.

Declaration

public void SetFullScreenDebugMode(FullScreenDebugMode value)

Parameters

Type	Name	Description
FullScreenDebugMode	value	Desired Full Screen Debug mode.

SetHistoryBufferView(int)

Set the current History Buffers View.

Declaration

public void SetHistoryBufferView(int value)

Parameters

Type	Name	Description
int	value	Desired History Buffer to view.

SetMipMapMode(DebugMipMapMode)

Set the current Mip Map Debug Mode.

Declaration

public void SetMipMapMode(DebugMipMapMode value)

Parameters

Type	Name	Description
DebugMipMapMode	value	Desired Mip Map debug mode.

SetRTASDebugMode(RTASDebugMode)

Set the current RTAS Full Screen Debug mode.

Declaration

public void SetRTASDebugMode(RTASDebugMode value)

Parameters

Type	Name	Description
RTASDebugMode	value	Desired Full Screen RTAS Debug mode.

SetRTASDebugView(RTASDebugView)

Set the current RTAS Full Screen Debug view.

Declaration

public void SetRTASDebugView(RTASDebugView value)

Parameters

Type	Name	Description
RTASDebugView	value	Desired Full Screen RTAS Debug view.

SetShadowDebugMode(ShadowMapDebugMode)

Set the current Shadow Map Debug Mode.

Declaration

public void SetShadowDebugMode(ShadowMapDebugMode value)

Parameters

Type	Name	Description
ShadowMapDebugMode	value	Desired Shadow Map debug mode.

SetVolumetricCloudsDebugMode(VolumetricCloudsDebug)

Set the current Volumetric Clouds Debug mode.

Declaration

public void SetVolumetricCloudsDebugMode(VolumetricCloudsDebug value)

Parameters

Type	Name	Description
VolumetricCloudsDebug	value	Desired Full Screen Volumetric Clouds Debug mode.

Implements

UnityEngine.Rendering.IDebugData