docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class DebugOverlay

    Utility class for debug overlay coordinates.

    Inheritance
    object
    DebugOverlay
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEngine.Rendering
    Assembly: Unity.RenderPipelines.Core.Runtime.dll
    Syntax
    public class DebugOverlay

    Properties

    overlaySize

    Current overlay size.

    Declaration
    public int overlaySize { get; }
    Property Value
    Type Description
    int

    x

    Current x coordinate.

    Declaration
    public int x { get; }
    Property Value
    Type Description
    int

    y

    Current y coordinate.

    Declaration
    public int y { get; }
    Property Value
    Type Description
    int

    Methods

    Next(float)

    Increment coordinates to the next overlay and return the current overlay rect.

    Declaration
    public Rect Next(float aspect = 1)
    Parameters
    Type Name Description
    float aspect

    Aspect of the current overlay.

    Returns
    Type Description
    Rect

    Returns a rect of the current overlay.

    SetViewport(CommandBuffer)

    Setup the viewport for the current overlay.

    Declaration
    public void SetViewport(CommandBuffer cmd)
    Parameters
    Type Name Description
    CommandBuffer cmd

    Command buffer used to setup viewport.

    StartOverlay(int, int, int, int)

    Start rendering overlay.

    Declaration
    public void StartOverlay(int initialX, int initialY, int overlaySize, int screenWidth)
    Parameters
    Type Name Description
    int initialX

    Initial x position.

    int initialY

    Initial y position.

    int overlaySize

    Size of overlays between 0 and 1.

    int screenWidth

    Width of the screen.

    Extension Methods

    ReflectionUtils.GetField(object, string)
    ReflectionUtils.GetFields(object)
    ReflectionUtils.Invoke(object, string, params object[])
    ReflectionUtils.SetField(object, string, object)
    AnalyticsUtils.ToNestedColumnWithDefault<T>(T, T, bool)
    AnalyticsUtils.ToNestedColumn<T>(T, bool)
    AnalyticsUtils.ToNestedColumn<T>(T, T)

    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    In This Article
    • Properties
      • overlaySize
      • x
      • y
    • Methods
      • Next(float)
      • SetViewport(CommandBuffer)
      • StartOverlay(int, int, int, int)
    • Extension Methods
    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)