Class DebugDisplayStats<TProfileId>

Base class for Rendering Debugger Display Stats.

Inheritance
object
DebugDisplayStats<TProfileId>
Inherited Members
Namespace: UnityEngine.Rendering
Assembly: Unity.RenderPipelines.Core.Runtime.dll
Syntax
public abstract class DebugDisplayStats<TProfileId> where TProfileId : Enum
Type Parameters
Name Description
TProfileId

Type of ProfileId the pipeline uses

Fields

averageProfilerTimingsOverASecond

Whether to display timings averaged over a second instead of updating every frame.

Declaration
protected bool averageProfilerTimingsOverASecond
Field Value
Type Description
bool

hideEmptyScopes

Whether to hide empty scopes from UI.

Declaration
protected bool hideEmptyScopes
Field Value
Type Description
bool

Methods

BuildDetailedStatsList(string, List<TProfileId>)

Helper function to build a list of sampler widgets for display stats

Declaration
protected DebugUI.Widget BuildDetailedStatsList(string title, List<TProfileId> samplers)
Parameters
Type Name Description
string title

Title for the stats list foldout
List<TProfileId> samplers

List of samplers to display
Returns
Type Description
DebugUI.Widget

Foldout containing the list of sampler widgets

DisableProfilingRecorders()

Disable all active profiling recorders.

Declaration
public abstract void DisableProfilingRecorders()

EnableProfilingRecorders()

Enable profiling recorders.

Declaration
public abstract void EnableProfilingRecorders()

GetProfilerIdsToDisplay()

Helper function to get all TProfilerId values of a given type to show in Detailed Stats section.

Declaration
protected List<TProfileId> GetProfilerIdsToDisplay()
Returns
Type Description
List<TProfileId>

List of TProfileId values excluding ones marked with [HideInDebugUI]

RegisterDebugUI(List<Widget>)

Add display stats widgets to the list provided.

Declaration
public abstract void RegisterDebugUI(List<DebugUI.Widget> list)
Parameters
Type Name Description
List<DebugUI.Widget> list

List to add the widgets to.

Update()

Update the timing data displayed in Display Stats panel.

Declaration
public abstract void Update()

UpdateDetailedStats(List<TProfileId>)

Update the detailed stats

Declaration
protected void UpdateDetailedStats(List<TProfileId> samplers)
Parameters
Type Name Description
List<TProfileId> samplers

List of samplers to update

Extension Methods