docs.unity3d.com
    Show / Hide Table of Contents

    Class DebugOverlay

    Utility class for debug overlay coordinates.

    Inheritance
    Object
    DebugOverlay
    Namespace: UnityEngine.Rendering.HighDefinition
    Syntax
    public class DebugOverlay

    Properties

    overlaySize

    Current overlay size.

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

    x

    Current x coordinate.

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

    y

    Current y coordinate.

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

    Methods

    Next()

    Increment coordinates to the next overlay.

    Declaration
    public void Next()

    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(Int32, Int32, Int32, Int32)

    Start rendering overlay.

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

    Initial x position.

    Int32 initialY

    Initial y position.

    Int32 overlaySize

    Size of overlays between 0 and 1.

    Int32 screenWidth

    Width of the screen.

    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