Class DebugDisplaySettings<T>

Templated class for IDebugDisplaySettings

Inheritance
object
DebugDisplaySettings<T>
Implements
Inherited Members
Namespace: UnityEngine.Rendering
Assembly: Unity.RenderPipelines.Core.Runtime.dll
Syntax
public abstract class DebugDisplaySettings<T> : IDebugDisplaySettings where T : IDebugDisplaySettings, new()
Type Parameters
Name Description
T

The specific type of Debug Display Settings that is inheriting from the IDebugDisplaySettings interface.

Fields

m_Settings

The set of IDebugDisplaySettingsData containing the settings for this debug display

Declaration
protected readonly HashSet<IDebugDisplaySettingsData> m_Settings
Field Value
Type Description
HashSet<IDebugDisplaySettingsData>

Properties

AreAnySettingsActive

Returns true if any of the debug settings are currently active.

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

Instance

The singleton instance that contains the current settings of Rendering Debugger.

Declaration
public static T Instance { get; }
Property Value
Type Description
T

IsLightingActive

Returns true if lighting is active for current state of debug settings.

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

IsPostProcessingAllowed

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

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

Methods

Add<TData>(TData)

Adds a new TData to this settings

Declaration
protected TData Add<TData>(TData newData) where TData : IDebugDisplaySettingsData
Parameters
Type Name Description
TData newData

The TData to be added
Returns
Type Description
TData

The type of TData that has been added
Type Parameters
Name Description
TData

The type of TData to be added

ForEach(Action<IDebugDisplaySettingsData>)

Executes an action for each element

Declaration
public void ForEach(Action<IDebugDisplaySettingsData> onExecute)
Parameters
Type Name Description
Action<IDebugDisplaySettingsData> onExecute

The action to be executed on each element in the Debug Display Settings data.

Reset()

Reset the stored debug settings

Declaration
public virtual void Reset()

TryGetScreenClearColor(ref Color)

Attempts to get the color that should be used to clear the screen according to current debug settings.

Declaration
public virtual 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 the color reference was updated, and false otherwise.

Implements

Extension Methods