docs.unity3d.com
    Show / Hide Table of Contents

    Class DebugDisplaySettings<T>

    Templated class for IDebugDisplaySettings

    Inheritance
    Object
    DebugDisplaySettings<T>
    Namespace: UnityEngine.Rendering
    Syntax
    public abstract class DebugDisplaySettings<T> : IDebugDisplaySettings, IDebugDisplaySettingsQuery where T : IDebugDisplaySettings, new()
    Type Parameters
    Name Description
    T

    Fields

    m_Settings

    The settings instantiated

    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
    Boolean
    Implements
    IDebugDisplaySettingsQuery.AreAnySettingsActive

    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
    Boolean
    Implements
    IDebugDisplaySettingsQuery.IsLightingActive

    IsPostProcessingAllowed

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

    Declaration
    public virtual bool IsPostProcessingAllowed { get; }
    Property Value
    Type Description
    Boolean
    Implements
    IDebugDisplaySettingsQuery.IsPostProcessingAllowed

    Methods

    Add<TData>(TData)

    Adds a new data

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

    The new data

    Returns
    Type Description
    TData

    The data that has been added

    Type Parameters
    Name Description
    TData

    a IDebugDisplaySettingsData

    ForEach(Action<IDebugDisplaySettingsData>)

    Executes an action for each element

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

    Reset()

    Reset the stored debug settings

    Declaration
    public virtual void Reset()
    Implements
    IDebugDisplaySettings.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
    Boolean

    True if the color reference was updated, and false otherwise.

    Implements
    IDebugDisplaySettingsQuery.TryGetScreenClearColor(ref Color)

    Extension Methods

    ReflectionUtils.Invoke(Object, String, Object[])
    ReflectionUtils.SetField(Object, String, Object)
    ReflectionUtils.GetField(Object, String)
    ReflectionUtils.GetFields(Object)
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023