Class PostProcessDebugLayer

This class centralizes rendering commands for debug modes.

Inheritance

object

PostProcessDebugLayer

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.Rendering.PostProcessing

Assembly: Unity.Postprocessing.Runtime.dll

Syntax

[Serializable]
public sealed class PostProcessDebugLayer

Fields

histogram

Histogram renderer.

Declaration

public HistogramMonitor histogram

Field Value

Type	Description
HistogramMonitor

lightMeter

Light meter renderer.

Declaration

public LightMeterMonitor lightMeter

Field Value

Type	Description
LightMeterMonitor

overlaySettings

Debug overlay settings.

Declaration

public PostProcessDebugLayer.OverlaySettings overlaySettings

Field Value

Type	Description
PostProcessDebugLayer.OverlaySettings

vectorscope

Vectorscope monitor.

Declaration

public VectorscopeMonitor vectorscope

Field Value

Type	Description
VectorscopeMonitor

waveform

Waveform renderer.

Declaration

public WaveformMonitor waveform

Field Value

Type	Description
WaveformMonitor

Properties

debugOverlay

The debug overlay requested for the current frame. It is reset to None once the frame has finished rendering.

Declaration

public DebugOverlay debugOverlay { get; }

Property Value

Type	Description
DebugOverlay

debugOverlayActive

Returns true if the frame that was just drawn had an active debug overlay.

Declaration

public bool debugOverlayActive { get; }

Property Value

Type	Description
bool

debugOverlayTarget

The render target used to render debug overlays in.

Declaration

public RenderTexture debugOverlayTarget { get; }

Property Value

Type	Description
RenderTexture

Methods

PushDebugOverlay(CommandBuffer, RenderTargetIdentifier, PropertySheet, int)

Blit a source render target to the debug overlay target.

Declaration

public void PushDebugOverlay(CommandBuffer cmd, RenderTargetIdentifier source, PropertySheet sheet, int pass)

Parameters

Type	Name	Description
CommandBuffer	cmd	The command buffer to send render commands to
RenderTargetIdentifier	source	The source target
PropertySheet	sheet	The property sheet to use for the blit
int	pass	The pass to use for the property sheet

RequestDebugOverlay(DebugOverlay)

Requests the drawing of a debug overlay for the current frame.

Declaration

public void RequestDebugOverlay(DebugOverlay mode)

Parameters

Type	Name	Description
DebugOverlay	mode	The debug overlay to request

RequestMonitorPass(MonitorType)

Requests the drawing of a monitor for the current frame.

Declaration

public void RequestMonitorPass(MonitorType monitor)

Parameters

Type	Name	Description
MonitorType	monitor	The monitor to request