Class DebugOverlay
Utility class for debug overlay coordinates.
Inherited Members
Namespace: UnityEngine.Rendering.HighDefinition
Syntax
[Obsolete("Please use UnityEngine.Rendering.DebugOverlay")]
public class DebugOverlayProperties
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(Single)
Increment coordinates to the next overlay and return the current overlay rect.
Declaration
public Rect Next(float aspect = 1F)Parameters
| Type | Name | Description |
|---|---|---|
| Single | 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(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. |