Class DebugDisplaySettingsRendering

Rendering-related Rendering Debugger settings.

Inheritance
object
DebugDisplaySettingsRendering
Implements
IDebugDisplaySettingsData
IDebugDisplaySettingsQuery
Inherited Members
Namespace: UnityEngine.Rendering.Universal
Assembly: Unity.RenderPipelines.Universal.Runtime.dll
Syntax
public class DebugDisplaySettingsRendering : IDebugDisplaySettingsData, IDebugDisplaySettingsQuery

Properties

AreAnySettingsActive

Checks whether ANY of the debug settings are currently active.

Declaration
public bool AreAnySettingsActive { get; }
Property Value
Type Description
bool

IsLightingActive

Checks whether lighting is active for these settings.

Declaration
public bool IsLightingActive { get; }
Property Value
Type Description
bool

IsPostProcessingAllowed

Checks whether the current state of these settings allows post-processing.

Declaration
public bool IsPostProcessingAllowed { get; }
Property Value
Type Description
bool

enableHDR

Whether HDR is enabled.

Declaration
public bool enableHDR { get; set; }
Property Value
Type Description
bool

enableMsaa

Whether MSAA is enabled.

Declaration
public bool enableMsaa { get; set; }
Property Value
Type Description
bool

fullScreenDebugMode

Current debug fullscreen overlay mode.

Declaration
public DebugFullScreenMode fullScreenDebugMode { get; set; }
Property Value
Type Description
DebugFullScreenMode

fullScreenDebugModeOutputSizeScreenPercent

Size of the debug fullscreen overlay, as percentage of the screen size.

Declaration
public int fullScreenDebugModeOutputSizeScreenPercent { get; set; }
Property Value
Type Description
int

maxOverdrawCount

Maximum overdraw count for a single pixel.

This is used to setup the feedback range in when overdrawMode is active.

Declaration
public int maxOverdrawCount { get; set; }
Property Value
Type Description
int

mipDebugMaterialTextureSlot

The material texture slot for which texture mipmap streaming debug information is shown.

Declaration
public int mipDebugMaterialTextureSlot { get; set; }
Property Value
Type Description
int

mipDebugOpacity

Opacity of texture mipmap streaming debug colors.

Declaration
public float mipDebugOpacity { get; set; }
Property Value
Type Description
float

mipDebugRecentUpdateCooldown

Timespan during which a texture upload should be visualized as recently updated.

Declaration
public float mipDebugRecentUpdateCooldown { get; set; }
Property Value
Type Description
float

mipDebugStatusMode

Aggregation mode for showing debug information per texture or aggregated for each material.

Declaration
public DebugMipMapStatusMode mipDebugStatusMode { get; set; }
Property Value
Type Description
DebugMipMapStatusMode

mipDebugStatusShowCode

Show detailed status codes for the Mipmap Streaming Status debug view.

Declaration
public bool mipDebugStatusShowCode { get; set; }
Property Value
Type Description
bool

mipDebugTerrainTexture

The terrain layer for which texture mipmap streaming debug information is shown.

Declaration
public DebugMipMapModeTerrainTexture mipDebugTerrainTexture { get; set; }
Property Value
Type Description
DebugMipMapModeTerrainTexture

mipInfoMode

Texture mipmap streaming debug mode.

Declaration
public DebugMipInfoMode mipInfoMode { get; set; }
Property Value
Type Description
DebugMipInfoMode

overdrawMode

Which overdraw debug mode is active.

Declaration
public DebugOverdrawMode overdrawMode { get; set; }
Property Value
Type Description
DebugOverdrawMode

postProcessingDebugMode

Current debug post processing mode.

Declaration
public DebugPostProcessingMode postProcessingDebugMode { get; set; }
Property Value
Type Description
DebugPostProcessingMode

showInfoForAllSlots

Whether to debug a specific texture slot in the material, or to show the debug data for the entire material.

By default we will show information for the entire material (and not a specific texture slot) where it makes sense.

Declaration
public bool showInfoForAllSlots { get; set; }
Property Value
Type Description
bool

taaDebugMode

Current TAA debug mode.

Declaration
public DebugDisplaySettingsRendering.TaaDebugMode taaDebugMode { get; set; }
Property Value
Type Description
DebugDisplaySettingsRendering.TaaDebugMode

validationChannels

Current validation channels for DebugValidationMode.HighlightOutsideOfRange.

Declaration
public PixelValidationChannels validationChannels { get; set; }
Property Value
Type Description
PixelValidationChannels

validationMode

Current debug pixel validation mode.

Declaration
public DebugValidationMode validationMode { get; set; }
Property Value
Type Description
DebugValidationMode

validationRangeMax

Current maximum threshold value for pixel validation. Any values above this value will be considered invalid and will appear blue on screen.

Declaration
public float validationRangeMax { get; set; }
Property Value
Type Description
float

validationRangeMin

Current minimum threshold value for pixel validation. Any values below this value will be considered invalid and will appear red on screen.

Declaration
public float validationRangeMin { get; set; }
Property Value
Type Description
float

wireframeMode

Current debug wireframe mode.

Declaration
public DebugWireframeMode wireframeMode { get; set; }
Property Value
Type Description
DebugWireframeMode

Methods

TryGetScreenClearColor(ref Color)

Attempts to get the color used to clear the screen for this debug setting.

Declaration
public bool TryGetScreenClearColor(ref Color color)
Parameters
Type Name Description
Color color

A reference to the screen clear color to use.
Returns
Type Description
bool

"true" if we updated the color, "false" if we didn't change anything.

Implements

UnityEngine.Rendering.IDebugDisplaySettingsData
UnityEngine.Rendering.IDebugDisplaySettingsQuery