1. Epic GamesDeveloper
  3. ProfilingDebugging

ProfilingDebugging

Unreal Engine C++ API Reference > Runtime > Core

Classes

  Type Name Description
Public class FABTest    
Public class FActiveExternalProfilerBase    
Public struct FAllocOpBase Representation of an alloc or free operation.  
Public class FAutoScopedDurationTimer Same as FScopedDurationTimer, except that it tracks the time value internally so you don't have to pass in a double to accumulate.  
Public struct FBootProfiling    
Public class FCookStats Shared code to provide some common cook telemetry functionality.  
Public class FCookStatsManager Centralizes the system to gather stats from a cook that need to be collected at the core/engine level.  
Public struct FDerivedDataUsageStats Stats for a resource class that uses the DDC to load the resource.  
Public class FDurationTimer Utility stopwatch class for tracking the duration of some action (tracks time in seconds and adds it to the specified variable on destruction).  
Public class FExternalProfiler FExternalProfiler  
Public class FExternalProfilerExcluder FExternalProfilerExcluder  
Public class FExternalProfilerIncluder FExternalProfilerIncluder  
Public class FExternalProfilerTrace    
Public struct FFormatArgsTrace    
Public struct FHistogram Fairly generic histogram for values that have natural lower bound and possibly no upper bound, e.g., frame time  
Public struct FHistogramBuilder Used to construct a histogram that runs over a custom set of ranges, while still enforcing contiguity on the bin ranges  
Public class FInstanceCountingObject A helper object for counting instances of struct or classes for debugging  
Public class FLoadTimeTracker High level load time tracker utility (such as initial engine startup or game specific timings)  
Public struct FPlatformFileTrace    
Public struct FResourceSizeEx Struct used to count up the amount of memory used by a resource.  
Public class FScopedABTimer    
Public struct FScopedCookStat    
Public class FScopedDebugInfo Debug info that is stored on the stack and handled by stack unwinding.  
Public class FScopedDurationTimeCustomLogger Utility class for logging the duration of a scoped action (the user doesn't have to call Start() and Stop() manually) using a custom output function.  
Public class FScopedDurationTimeLogger Utility class for logging the duration of a scoped action (the user doesn't have to call Start() and Stop() manually).  
Public class FScopedDurationTimer Utility class for tracking the duration of a scoped action (the user doesn't have to call Start() and Stop() manually).  
Public class FScopedExternalProfilerBase Base class for FScoped*Timer and FScoped*Excluder  
Public struct FScopedLoadTimeAccumulatorTimer Scoped helper class for tracking accumulated object times  
Public class FScopedSwitchedCountedDurationTimer Utility stopwatch class for tracking the duration of some action (tracks time in seconds and adds it to the specified variable on destruction).  
Public class FScopedSwitchedDurationTimer Utility stopwatch class for tracking the duration of some action (tracks time in seconds and adds it to the specified variable on destruction).  
Public class FTraceAuxiliary    
Public class FTraceMalloc    
Public struct FTraceUtils    
Public class TAllocPlaybackLog Define a modifier class like below and supply it to TAllocPlaybackLog to complete the template.  
Public class TAllocRecordingLog Define a modifier class like below and supply it to TAllocRecordingLog to complete the template.  
Public class TScopedDurationThreadSafeTimer Utility class for tracking the duration of a scoped action to an accumulator in a thread-safe fashion.  

Typedefs

Name Description
FScopedDurationThreadSafeTimer  
FScopedDurationThreadSafeTimer64  
HeapId  

Enums

  Type Name Description
Public enum EMemoryTraceHeapAllocationFlags These values are traced. Do not modify existing values in order to maintain compatibility.  
Public enum EMemoryTraceHeapFlags These values are traced. Do not modify existing values in order to maintain compatibility.  
Public enum EMemoryTraceInit Internal options for early initialization of memory tracing systems.  
Public enum EMemoryTraceRootHeap    
Public enum EMemoryTraceSwapOperation    
Public enum EPackageEventStatType    
Public enum EResourceSizeMode::Type Indicate what types of resources should be included for calculating used memory  
Public enum EStreamingStatus Here are a number of profiling helper functions so we do not have to duplicate a lot of the glue code everywhere.  
Public enum ETraceCounterDisplayHint    
Public enum ETraceCounterNameType    
Public enum ETraceCounterType    
Public enum ETraceFrameType    

Functions

  Type Name Description
Public function void  
Public function uint32  
Public function void *  
Public function void *  
Public function void  
Public function bool  
Public function FString

CreateProfileDirectoryAndFilename ( const FString& InSubDirectoryName,
const FString& InFileExtension
)

 This will create the directories and the file name all in one function
Public function FString

CreateProfileFilename ( const FString& InFilename,
const FString& InFileExtension,
bool bIncludeDateForDirectoryName
)

 This will generate the profiling file name that will work with limited filename sizes on consoles.
Public function FString

CreateProfileFilename ( const FString& InFileExtension,
bool bIncludeDateForDirectoryName
)

 This will generate the profiling file name that will work with limited filename sizes on consoles.
Public function FString This will return the name specified with -BuildName=SomeName (needs to be a valid c++ name a-z A-Z _ 0-9 so we don't run into issues when we pass it around) or if not specified "CL%d" where d is coming from GetChangeListNumberForPerfTesting()
Public function int32 This will get the version that should be used with the Automated Performance Testing If one is passed in we use that otherwise we use FApp::GetEngineVersion.
Public function void

MemoryTrace_Alloc ( uint64 Address,
uint64 Size,
uint32 Alignment,
HeapId RootHeap,
uint32 ExternalCallstackId
)

  
Public function int32

MemoryTrace_AnnounceCustomTag ( int32 Tag,
int32 ParentTag,
const TCHAR* Display
)

  
Public function int32

MemoryTrace_AnnounceFNameTag ( const FName& TagName
)

  
Public function void

MemoryTrace_Free ( uint64 Address,
HeapId RootHeap,
uint32 ExternalCallstackId
)

  
Public function int32  
Public function HeapId

MemoryTrace_HeapSpec ( HeapId ParentId,
const TCHAR* Name,
EMemoryTraceHeapFlags Flags
)

  
Public function void  
Public function void

MemoryTrace_ReallocAlloc ( uint64 Address,
uint64 NewSize,
uint32 Alignment,
HeapId RootHeap,
uint32 ExternalCallstackId
)

  
Public function void

MemoryTrace_ReallocFree ( uint64 Address,
HeapId RootHeap,
uint32 ExternalCallstackId
)

  
Public function HeapId  
Public function void

MemoryTrace_SwapOp ( uint64 PageAddress,
EMemoryTraceSwapOperation SwapOperation,
uint32 CompressedSize,
uint32 CallstackId
)

  
Public function void  
Public function bool

operator! ( FPlatformEventsTrace::EEventType E
)

  
Public function bool  
Public function bool  
Public function bool  
Public function FPlatformEventsTrace::EEventType

operator& ( FPlatformEventsTrace::EEventType Lhs,
FPlatformEventsTrace::EEventType Rhs
)

  
Public function EMemoryTraceHeapFlags  
Public function EMemoryTraceHeapAllocationFlags  
Public function EMemoryTraceInit  
Public function FPlatformEventsTrace::EEventType &

operator&= ( FPlatformEventsTrace::EEventType& Lhs,
FPlatformEventsTrace::EEventType Rhs
)

  
Public function EMemoryTraceInit &  
Public function EMemoryTraceHeapAllocationFlags &  
Public function EMemoryTraceHeapFlags &  
Public function EMemoryTraceInit  
Public function FPlatformEventsTrace::EEventType

operator^ ( FPlatformEventsTrace::EEventType Lhs,
FPlatformEventsTrace::EEventType Rhs
)

  
Public function EMemoryTraceHeapAllocationFlags  
Public function EMemoryTraceHeapFlags  
Public function EMemoryTraceInit &  
Public function EMemoryTraceHeapFlags &  
Public function EMemoryTraceHeapAllocationFlags &  
Public function FPlatformEventsTrace::EEventType &

operator^= ( FPlatformEventsTrace::EEventType& Lhs,
FPlatformEventsTrace::EEventType Rhs
)

  
Public function FPlatformEventsTrace::EEventType

operator| ( FPlatformEventsTrace::EEventType Lhs,
FPlatformEventsTrace::EEventType Rhs
)

  
Public function EMemoryTraceInit  
Public function EMemoryTraceHeapAllocationFlags  
Public function EMemoryTraceHeapFlags  
Public function FPlatformEventsTrace::EEventType &

operator|= ( FPlatformEventsTrace::EEventType& Lhs,
FPlatformEventsTrace::EEventType Rhs
)

  
Public function EMemoryTraceInit &  
Public function EMemoryTraceHeapAllocationFlags &  
Public function EMemoryTraceHeapFlags &  
Public function EMemoryTraceHeapAllocationFlags  
Public function FPlatformEventsTrace::EEventType

operator~ ( FPlatformEventsTrace::EEventType E
)

  
Public function EMemoryTraceHeapFlags  
Public function EMemoryTraceInit  
Public function FResourceSizeEx

operator+ ( FResourceSizeEx InLHS,
const FResourceSizeEx& InRHS
)

 Add two FResourceSizeEx instances together and return a copy.
Public function void

SendDataToPCViaUnrealConsole ( const FString& NotifyType,
const FString& FullFileName
)

 This makes it so UnrealConsole will open up the memory profiler for us
Public function bool  
Public function void

TracePackage ( uint64 InId,
const FStringView InName
)

  
Public function void

TracePackageAssetClass ( uint64 InId,
const FStringView InName
)

  
Public function void

TracePackageStat ( uint64 InId,
uint64 Duration,
EPackageEventStatType StatType
)

  
Public function void  
Public function void  
Public function  

UE_TRACE_CHANNEL_EXTERN ( CookChannel
)

  
Public function  

UE_TRACE_CHANNEL_EXTERN ( ContextSwitchChannel
)

  

Variables

  Type Name Description
Public variable double GEngineInitEndTime  
Public variable double GEnginePreInitPostStartupScreenEndTime  
Public variable double GEnginePreInitPreStartupScreenEndTime  
Public variable int32 TRACE_TAG  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page