1. Epic GamesDeveloper
  3. IPerfCounters

IPerfCounters

A programming interface for setting/updating performance counters

Unreal Engine C++ API Reference > Runtime > PerfCounters

References

   
Module PerfCounters
Header /Engine/Source/Runtime/PerfCounters/Public/PerfCountersModule.h
Include #include "PerfCountersModule.h"

Syntax

class IPerfCounters

Remarks

A programming interface for setting/updating performance counters

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function uint32

Get ( const FString& Name,
uint32 Val
)

  
Public function int32

Get ( const FString& Name,
int32 Val
)

 Get overloads
Public function float

Get ( const FString& Name,
float Val
)

  
Public function double

Get ( const FString& Name,
double Val
)

  
Public function const TMap< FString, FJsonVariant > &  
Public function FString  
Public function Const const FString & Get the unique identifier for this perf counter instance
Public function double

GetNumber ( const FString& Name,
double DefaultValue
)

 Returns currently held value, or DefaultValue if none
Public function int32

Increment ( const FString& Name,
int32 Add,
int32 DefaultValue,
uint32 Flags
)

 Convenience method for incrementing a transient counter.
Public function FPerfCounterExecCommandCallback &  
Public function TPerformanceHistogramMap & Returns performance histograms for direct manipulation by the client code.
Public function bool

ReportUnplayableCondition ( const FString& ConditionDescription
)

 Reports an unplayable condition.
Public function void Clears transient perf counters, essentially marking beginning of a new stats period
Public function void

Set ( const FString& Name,
int64 Val,
uint32 Flags
)

  
Public function void

Set ( const FString& Name,
double Val,
uint32 Flags
)

  
Public function void

Set ( const FString& Name,
float Val,
uint32 Flags
)

  
Public function void

Set ( const FString& Name,
uint32 Val,
uint32 Flags
)

  
Public function void

Set ( const FString& Name,
const FString& Val,
uint32 Flags
)

  
Public function void

Set ( const FString& Name,
const FProduceJsonCounterValue& Callback,
uint32 Flags
)

  
Public function void

Set ( const FString& Name,
uint64 Val,
uint32 Flags
)

  
Public function void

Set ( const FString& Name,
int32 Val,
uint32 Flags
)

 Set overloads (use these)
Public function void

SetJson ( const FString& Name,
const FProduceJsonCounterValue& Callback,
uint32 Flags
)

 Make a callback so we can request more extensive types on demand (presumably backed by some struct locally)
Public function void

SetNumber ( const FString& Name,
double Value,
uint32 Flags
)

 Maps value to a numeric holder
Public function void

SetString ( const FString& Name,
const FString& Value,
uint32 Flags
)

 Maps value to a string holder
Public function bool

StartMachineLoadTracking ( double TickRate,
const TArray< double >& FrameTimeHistogramBucketsMs
)

 Starts tracking overall machine load (empty array will use default hitch buckets).
Public function bool Starts tracking overall machine load.
Public function bool Stops tracking overall machine load.

Classes

  Type Name Description
Public struct FJsonVariant    
Public struct Histograms Named engine-wide histograms  

Enums

  Type Name Description
Public enum Flags    

Typedefs

Name Description
TPerformanceHistogramMap Array used to store performance histograms.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page