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.HighDefinition

Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll

Syntax

[Obsolete("Please use UnityEngine.Rendering.DebugOverlay")]
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.