docs.unity3d.com
    Show / Hide Table of Contents

    Rendering Debugger

    The Rendering Debugger window lets you visualize various lighting, rendering, and Material properties. The visualizations help you identify rendering issues and optimize Scenes and rendering configurations.

    This section contains the following topics:

    • How to access the Rendering Debugger window.

      Information on how to access the Rendering Debugger window in the Editor, in the Play mode, and at runtime in Development builds.

    • Rendering Debugger window sections

      Descriptions of the elements and properties in the Rendering Debugger window.

    • Navigation at runtime

      How to navigate the Rendering Debugger interface at runtime.

    How to access the Rendering Debugger window

    The Rendering Debugger window is available in the following modes:

    • The Editor.

    • The Play mode.

    • At runtime in the standalone Unity Player, on any device. The window is only available in Development builds.

    When using the Rendering Debugger window in the Development build, clear the Strip Debug Variants check box in Project Settings > Graphics > URP Global Settings.

    Use one of the following options to open the Rendering Debugger window.

    In the Editor:

    • Select Window > Analysis > Rendering Debugger.

    • Press Ctrl+Backspace (Ctrl+Delete on macOS).

    In the Play mode or at runtime in a Development build:

    • On a desktop or laptop computer, press LeftCtrl+Backspace (LeftCtrl+Delete on macOS).

    • On a console controller, press L3 and R3 (Left Stick and Right Stick).

    • On a mobile device, use a three-finger double tap.

    You can disable the runtime UI using the enableRuntimeUI property.

    Rendering Debugger window sections

    The Rendering Debugger window contains the following sections:

    • Display Stats

    • Frequently Used

    • Material

    • Lighting

    • Rendering

    The following illustration shows the Rendering Debugger window in the Scene view.

    Rendering Debugger window.

    Display Stats

    The Display Stats panel is only visible in play mode. You can use it to debug performance issues in your project.

    Debug Option Description
    Frame Rate Displays the frame rate in frames per second for the current camera view.
    Frame Time Displays the total frame time for the current camera view.
    RT Mode If you enable ray tracing, it displays the ray tracing Tier used during rendering.
    Count Rays If you enable ray tracing, enable the checkbox to count the number of traced rays per effect (in MRays / frame).
    Ambient Occlusion The number of rays that were traced for Ambient Occlusion (AO) computations, when you enable RT AO.
    Shadows Directional The number of rays that were traced for directional lights, when you enable RT shadows.
    Shadows Area The number of rays that were traced towards area lights, when you enable RT shadows.
    Shadows Point/Spot The number of rays that were traced towards punctual (point/spot) lights, when you enable RT shadows.
    Reflection Forward The number of rays that were traced for reflection computations using forward shading.
    Reflection Deferred TThe number of rays that were traced for reflection computations using deferred shading.
    Diffuse GI Forward The number of rays that were traced for diffuse Global Illumination (GI) computations using forward shading.
    Diffuse GI Deferred The number of rays that were traced for diffuse Global Illumination (GI) computations using deferred shading.
    Recursive The number of rays that were traced for diffuse Global Illumination (GI) computations when you enable recursive RT.
    Total The total number of rays that were traced.
    Debug XR Layout Enable to display XR passes debug informations.

    This mode is only available in the editor and development builds.

    Frequently Used

    This section contains a selection of properties that users use often. The properties are from the other sections in the Rendering Debugger window. For information about the properties, see the sections Material, Lighting, and Rendering.

    Material

    The properties in this section let you visualize different Material properties.

    Rendering Debugger, Material section
    Rendering Debugger, Material section

    Material Filters

    Property Description
    Material Override Select a Material property to visualize on every GameObject on screen.
    The available options are:
    • Albedo
    • Specular
    • Alpha
    • Smoothness
    • AmbientOcclusion
    • Emission
    • NormalWorldSpace
    • NormalTangentSpace
    • LightingComplexity
    • Metallic
    • SpriteMask
    With the LightingComplexity value selected, Unity shows how many Lights affect areas of the screen space.
    Vertex Attribute Select a vertex attribute of GameObjects to visualize on screen.
    The available options are:
    • Texcoord0
    • Texcoord1
    • Texcoord2
    • Texcoord3
    • Color
    • Tangent
    • Normal

    Material Validation

    Property Description
    Material Validation Mode Select which Material properties to visualize: Albedo, or Metallic. Selecting one of the properties shows the new context menu.
        Validation Mode: Albedo Selecting Albedo in the Material Validation Mode property shows the Albedo Settings section with the following properties:
    Validation Preset: Select a pre-configured material, or Default Luminance to visualize luminance ranges.
    Min Luminance: Unity draws pixels where the luminance is lower than this value with red color.
    Max Luminance: Unity draws pixels where the luminance is higher than this value with blue color.
    Hue Tolerance: available only when you select a pre-set material. Unity adds the hue tolerance to the minimum and maximum luminance values.
    Saturation Tolerance: available only when you select a pre-set material. Unity adds the saturation tolerance to the minimum and maximum luminance values.
        Validation Mode: Metallic Selecting Metallic in the Material Validation Mode property shows the Metallic Settings section with the following properties:
    Min Value: Unity draws pixels where the metallic value is lower than this value with red color.
    Max Value: Unity draws pixels where the metallic value is higher than this value with blue color.

    Lighting

    The properties in this section let you visualize different settings and elements related to the lighting system, such as shadow cascades, reflections, contributions of the Main and the Additional Lights, and so on.

    Lighting Debug Modes


    The Lighting Debug Modes subsection.

    Property Description
    Lighting Debug Mode Specifies which lighting and shadow information to overlay on-screen to debug. The options are:
    • None: Renders the scene normally without a debug overlay.
    • Shadow Cascades: Overlays shadow cascade information so you can see which shadow cascade each pixel uses. Use this to debug shadow cascade distances. For information on which color represents which shadow cascade, see the Shadows section of the URP Asset.
    • Lighting Without Normal Maps: Renders the scene to visualize lighting. This mode uses neutral materials and disables normal maps. This and the Lighting With Normal Maps mode are useful for debugging lighting issues caused by normal maps.
    • Lighting With Normal Maps: Renders the scene to visualize lighting. This mode uses neutral materials and allows normal maps.
    • Reflections: Renders the scene to visualize reflections. This mode applies perfectly smooth, reflective materials to every Mesh Renderer.
    • Reflections With Smoothness: Renders the scene to visualize reflections. This mode applies reflective materials without an overridden smoothness to every GameObject.
    Lighting Features Specifies flags for which lighting features contribute to the final lighting result. Use this to view and debug specific lighting features in your scene. The options are:
    • Nothing: Shortcut to disable all flags.
    • Everything: Shortcut to enable all flags.
    • Global Illumination: Indicates whether to render global illumination.
    • Main Light: Indicates whether the main directional Light contributes to lighting.
    • Additional Lights: Indicates whether lights other than the main directional light contribute to lighting.
    • Vertex Lighting: Indicates whether additional lights that use per-vertex lighting contribute to lighting.
    • Emission: Indicates whether emissive materials contribute to lighting.
    • Ambient Occlusion: Indicates whether ambient occlusion contributes to lighting.

    Rendering

    The properties in this section let you visualize different rendering features.

    Rendering Debug


    The Rendering Debug subsection.

    Property Description
    Map Overlays Specifies which render pipeline texture to overlay on the screen. The options are:
    • None: Renders the scene normally without a texture overlay.
    • Depth: Overlays the camera's depth texture on the screen.
    • Additional Lights Shadow Map: Overlays the shadow map that contains shadows cast by lights other than the main directional light.
    • Main Light Shadow Map: Overlays the shadow map that contains shadows cast by the main directional light.
      Map Size The width and height of the overlay texture as a percentage of the view window URP displays it in. For example, a value of 50 fills up a quarter of the screen (50% of the width and 50% of the height).
    HDR Indicates whether to use high dynamic range (HDR) to render the scene. Enabling this property only has an effect if you enable HDR in your URP Asset.
    MSAA Indicates whether to use multi-sample anti-aliasing (MSAA) to render the scene. Enabling this property only has an effect if:
    • You set Anti Aliasing (MSAA) to a value other than Disabled in your URP Asset.
    • You use the Game View. MSAA has no effect in the Scene View.
    Post-processing Specifies how URP applies post-processing. The options are:
    • Disabled: Disables post-processing.
    • Auto: Unity enables or disables post-processing depending on the currently active debug modes. If color changes from post-processing would change the meaning of a debug mode's pixel, Unity disables post-processing. If no debug modes are active, or if color changes from post-processing don't change the meaning of the active debug modes' pixels, Unity enables post-processing.
    • Enabled: Applies post-processing to the image that the camera captures.
    Additional Wireframe Modes Specifies whether and how to render wireframes for meshes in your scene. The options are:
    • None: Doesn't render wireframes.
    • Wireframe: Exclusively renders edges for meshes in your scene. In this mode, you can see the wireframe for meshes through the wireframe for closer meshes.
    • Solid Wireframe: Exclusively renders edges and faces for meshes in your scene. In this mode, the faces of each wireframe mesh hide edges behind them.
    • Shaded Wireframe: Renders edges for meshes as an overlay. In this mode, Unity renders the scene in color and overlays the wireframe over the top.
    Overdraw Indicates whether to render the overdraw debug view. This is useful to see where Unity draws pixels over one other.

    Pixel Validation


    The Pixel Validation subsection.

    Property Description
    Pixel Validation Mode Specifies which mode Unity uses to validate pixel color values. The options are:
    • None: Renders the scene normally and doesn't validate any pixels.
    • Highlight NaN, Inf and Negative Values: Highlights pixels that have color values that are NaN, Inf, or negative.
    • Highlight Values Outside Range: Highlights pixels that have color values outside a particular range. Use Value Range Min and Value Range Max.
      Channels Specifies which value to use for the pixel value range validation. The options are:
    • RGB: Validates the pixel using the luminance value calculated from the red, green, and blue color channels.
    • R: Validates the pixel using the value from the red color channel.
    • G: Validates the pixel using the value from the green color channel.
    • B: Validates the pixel using the value from the blue color channel.
    • A: Validates the pixel using the value from the alpha channel.
    This property only appears if you set Pixel Validation Mode to Highlight Values Outside Range.
       Value Range Min The minimum valid color value. Unity highlights color values that are less than this value.

    This property only appears if you set Pixel Validation Mode to Highlight Values Outside Range.
       Value Range Max The maximum valid color value. Unity highlights color values that are greater than this value.

    This property only appears if you set Pixel Validation Mode to Highlight Values Outside Range.

    Navigation at runtime

    This section describes how to navigate the Rendering Debugger interface at runtime.

    To change the current active item:

    • Keyboard: use the arrow keys.

    • Touch screen: tap the arrows next to properties.

    • Xbox controller: use the Directional pad (D-Pad).

    • PlayStation controller: use the Directional buttons.

    To change the current tab:

    • Keyboard: use the Page up and Page down keys (Fn + Up and Fn + Down keys for MacOS).

    • Touch screen: tap the arrows next to tab title.

    • Xbox controller: use the Left Bumper and Right Bumper.

    • PlayStation controller: use the L1 button and R1 button.

    To display the current active item independently of the debug window:

    • Keyboard: press the right Shift key.

    • Xbox controller: press the X button.

    • PlayStation controller: press the Square button.

    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