Class AdaptivePerformanceProfilerStats

Profiler Stats reporting helper class. Stores all adaptive performance counters and helper functions.

Inheritance

Object

AdaptivePerformanceProfilerStats

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Global Namespace

Syntax

public static class AdaptivePerformanceProfilerStats

Fields

AdaptivePerformanceProfilerCategory

Profiler Category is set to scripts for Adaptive Performance.

Declaration

public static readonly ProfilerCategory AdaptivePerformanceProfilerCategory

Field Value

Type	Description
ProfilerCategory

AvgCPUCounter

Profiler counter to report cpu average frametime.

Declaration

public static ProfilerCounter<float> AvgCPUCounter

Field Value

Type	Description
ProfilerCounter<Single>

AvgFrametimeCounter

Profiler counter to report average frametime.

Declaration

public static ProfilerCounter<float> AvgFrametimeCounter

Field Value

Type	Description
ProfilerCounter<Single>

AvgGPUCounter

Profiler counter to report gpu average frametime.

Declaration

public static ProfilerCounter<float> AvgGPUCounter

Field Value

Type	Description
ProfilerCounter<Single>

BottleneckCounter

Profiler counter to report the bottleneck.

Declaration

public static ProfilerCounter<int> BottleneckCounter

Field Value

Type	Description
ProfilerCounter<Int32>

CurrentCPUCounter

Profiler counter to report cpu frametime.

Declaration

public static ProfilerCounter<float> CurrentCPUCounter

Field Value

Type	Description
ProfilerCounter<Single>

CurrentCPULevelCounter

Profiler counter to report cpu performance level.

Declaration

public static ProfilerCounter<int> CurrentCPULevelCounter

Field Value

Type	Description
ProfilerCounter<Int32>

CurrentFrametimeCounter

Profiler counter to report frametime.

Declaration

public static ProfilerCounter<float> CurrentFrametimeCounter

Field Value

Type	Description
ProfilerCounter<Single>

CurrentGPUCounter

Profiler counter to report gpu frametime.

Declaration

public static ProfilerCounter<float> CurrentGPUCounter

Field Value

Type	Description
ProfilerCounter<Single>

CurrentGPULevelCounter

Profiler counter to report gpu performance level.

Declaration

public static ProfilerCounter<int> CurrentGPULevelCounter

Field Value

Type	Description
ProfilerCounter<Int32>

kAdaptivePerformanceProfilerModuleGuid

GUID for the Adaptive Performance Profile Module definition.

Declaration

public static readonly Guid kAdaptivePerformanceProfilerModuleGuid

Field Value

Type	Description
Guid

kScalerDataTag

The Scaler data tag defines a tag for the scalers to send them via the emit frame data function.

Declaration

public static readonly int kScalerDataTag

Field Value

Type	Description
Int32

PerformanceModeCounter

Profiler counter to report the performance mode.

Declaration

public static ProfilerCounter<int> PerformanceModeCounter

Field Value

Type	Description
ProfilerCounter<Int32>

TemperatureLevelCounter

Profiler counter to report the temperature level.

Declaration

public static ProfilerCounter<float> TemperatureLevelCounter

Field Value

Type	Description
ProfilerCounter<Single>

TemperatureTrendCounter

Profiler counter to report the temperature trend.

Declaration

public static ProfilerCounter<float> TemperatureTrendCounter

Field Value

Type	Description
ProfilerCounter<Single>

WarningLevelCounter

Profiler counter to report the thermal warning level.

Declaration

public static ProfilerCounter<int> WarningLevelCounter

Field Value

Type	Description
ProfilerCounter<Int32>

Methods

EmitScalerDataToProfilerStream(String, Boolean, Int32, Int32, Single, Boolean, Int32)

Adaptive Performance sends scaler data to the profiler each frame. It is collected from multiple places with this method and flushed once with AdaptivePerformanceProfilerStats.FlushScalerDataToProfilerStream.

Declaration

[Conditional("ENABLE_PROFILER")]
public static void EmitScalerDataToProfilerStream(string scalerName, bool enabled, int overrideLevel, int currentLevel, float scale, bool applied, int maxLevel)

Parameters

Type	Name	Description
String	scalerName	The name of the scaler. 320 characters max.
Boolean	enabled	If the scaler is currently enabled.
Int32	overrideLevel	The override state of the scaler.
Int32	currentLevel	The current level of the scaler.
Single	scale	The actual scale of the scaler.
Boolean	applied	If the scaler is currently applied.
Int32	maxLevel	The maximum level of the scaler.

FlushScalerDataToProfilerStream()

Flushes the Adaptive Performance scaler data for this frame. Used in conjunction with AdaptivePerformanceProfilerStats.EmitScalerDataToProfilerStream(System.String,System.Boolean,System.Int32,System.Int32,System.Single,System.Boolean,System.Int32).

Declaration

public static void FlushScalerDataToProfilerStream()