1. Epic GamesDeveloper
  3. IPerfCounters

IPerfCounters

A programming interface for setting/updating performance counters

API > API/Runtime > API/Runtime/PerfCounters

A programming interface for setting/updating performance counters

   
Name IPerfCounters
Type class
Header File /Engine/Source/Runtime/PerfCounters/Public/PerfCountersModule.h
Include Path #include "PerfCountersModule.h"

Syntax

class IPerfCounters

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IPerfCounters()

   PerfCountersModule.h  

Structs

Name Remarks
FJsonVariant  
Histograms Named engine-wide histograms

Enums

Public

Name Remarks
Flags  

Typedefs

Name Type Remarks Include Path
TPerformanceHistogramMap TMap< FName, FHistogram > Array used to store performance histograms. PerfCountersModule.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

uint32 Get ( const FString& Name,
uint32 Val
)

   PerfCountersModule.h  

int32 Get ( const FString& Name,
int32 Val
)

 Get overloads PerfCountersModule.h  

float Get ( const FString& Name,
float Val
)

   PerfCountersModule.h  

double Get ( const FString& Name,
double Val
)

   PerfCountersModule.h  

const TMap< FString, FJsonVariant > & GetAllCounters()

   PerfCountersModule.h  

FString GetAllCountersAsJson()

   PerfCountersModule.h  

const FString & GetInstanceName()

 Get the unique identifier for this perf counter instance PerfCountersModule.h  

double GetNumber ( const FString& Name,
double DefaultValue
)

 Returns currently held value, or DefaultValue if none PerfCountersModule.h  

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

 Convenience method for incrementing a transient counter. PerfCountersModule.h  

FPerfCounterExecCommandCallback & OnPerfCounterExecCommand()

   PerfCountersModule.h  

TPerformanceHistogramMap & PerformanceHistograms()

 Returns performance histograms for direct manipulation by the client code. PerfCountersModule.h  

bool ReportUnplayableCondition ( const FString& ConditionDescription
)

 Reports an unplayable condition. PerfCountersModule.h  

void ResetStatsForNextPeriod()

 Clears transient perf counters, essentially marking beginning of a new stats period PerfCountersModule.h  

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

   PerfCountersModule.h  

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

   PerfCountersModule.h  

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

   PerfCountersModule.h  

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

   PerfCountersModule.h  

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

   PerfCountersModule.h  

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

   PerfCountersModule.h  

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

   PerfCountersModule.h  

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

 Set overloads (use these) PerfCountersModule.h  

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) PerfCountersModule.h  

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

 Maps value to a numeric holder PerfCountersModule.h  

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

 Maps value to a string holder PerfCountersModule.h  

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

 Starts tracking overall machine load (empty array will use default hitch buckets). PerfCountersModule.h  
Starts tracking overall machine load. PerfCountersModule.h  

bool StopMachineLoadTracking()

 Stops tracking overall machine load. PerfCountersModule.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page