docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    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[]

    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 DebugLightLayersMask GetDebugLightLayersMask()
    Returns
    Type Description
    DebugLightLayersMask

    Current Light Layers Debug Mask.

    GetDebugLightingMode()

    Returns the current Lighting Debug Mode.

    Declaration
    public DebugLightingMode GetDebugLightingMode()
    Returns
    Type Description
    DebugLightingMode

    Current Lighting Debug Mode.

    GetDebugMipMapMode()

    Returns the current Mip Map Debug Mode.

    Declaration
    public DebugMipMapMode GetDebugMipMapMode()
    Returns
    Type Description
    DebugMipMapMode

    Current Mip Map Debug Mode.

    GetDebugMipMapModeTerrainTexture()

    Returns the current Terrain Texture Mip Map Debug Mode.

    Declaration
    public DebugMipMapModeTerrainTexture GetDebugMipMapModeTerrainTexture()
    Returns
    Type Description
    DebugMipMapModeTerrainTexture

    Current Terrain Texture Mip Map Debug Mode.

    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.

    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)

    Set the current Light layers Debug Mode

    Declaration
    public void SetDebugLightLayersMode(bool value)
    Parameters
    Type Name Description
    bool value

    Desired Light 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.

    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.

    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.

    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.

    Implements

    IDebugData
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)