Class DebugDisplaySettingsVolume

Debug Dispaly Settings Volume

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

Constructors

DebugDisplaySettingsVolume(IVolumeDebugSettings2)

Constructor with the settings

Declaration
public DebugDisplaySettingsVolume(IVolumeDebugSettings2 volumeDebugSettings)
Parameters
Type Name Description
IVolumeDebugSettings2 volumeDebugSettings

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

volumeDebugSettings

Current volume debug settings.

Declaration
public IVolumeDebugSettings2 volumeDebugSettings { get; }
Property Value
Type Description
IVolumeDebugSettings2

Methods

CreatePanel()

Creates the panel

Declaration
public IDebugDisplaySettingsPanelDisposable CreatePanel()
Returns
Type Description
IDebugDisplaySettingsPanelDisposable

The panel

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

Extension Methods