Language:
Discover
By Skill Level
By Category

ProfilingDebugging

Choose your OS:

Classes

Name

Description

Public class

FABTest

Public class

FActiveExternalProfilerBase

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 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 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 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 purposes, e.g. to get an absolute count of the number of "Foo"'s in existence

Public class

FLoadTimeTracker

High level load time tracker utility (such as initial engine startup or game specific timings)

Public struct

FResourceSizeEx

Struct used to count up the amount of memory used by a resource.

Public class

FScopedABTimer

Public class

FScopedDebugInfo

============================================================================= ScopedDebugInfo.h: Scoped debug info definitions.

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 struct

TDecay

Returns the decayed type of T, meaning it removes all references, qualifiers and applies array-to-pointer and function-to-pointer conversions.

Public class

TScopedDurationThreadSafeTimer

Utility class for tracking the duration of a scoped action to an accumulator in a thread-safe fashion.

Typedefs

Enums

Name

Description

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.

Functions

Name Description

Public function

[CORE_API](API\Runtime\Core\Misc\CORE_API_1)FStr ...

 

CreateProfileDirectoryAndFilename

(
    const FString & InSubDirectoryName,
    const FString & InFileExtension
)

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

Public function

[CORE_API](API\Runtime\Core\Misc\CORE_API_1)FStr ...

 

CreateProfileFilename

(
    const FString & InFileExtension,
    bool bIncludeDateForDirectoryName
)

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

Public function

[CORE_API](API\Runtime\Core\Misc\CORE_API_1)FStr ...

 

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

[CORE_API](API\Runtime\Core\Misc\CORE_API_1)FStr ...

 

GetBuildNameForPerfTesting()

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

[CORE_API](API\Runtime\Core\Misc\CORE_API_1)int3 ...

 

GetChangeListNumberForPerfTesting()

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

[CORE_API](API\Runtime\Core\Misc\CORE_API_1)void

 

SendDataToPCViaUnrealConsole

(
    const FString & NotifyType,
    const FString & FullFileName
)

This makes it so UnrealConsole will open up the memory profiler for us