FStackTracker

Stack tracker. Used to identify callstacks at any point in the codebase.

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Containers/StackTracker.h

Include

#include "Containers/StackTracker.h"

Syntax

struct FStackTracker

Remarks

Stack tracker. Used to identify callstacks at any point in the codebase.

Constructors

Name Description

Public function

FStackTracker

(
    StackTrackerUpdateFn InUpdateFn,
    StackTrackerReportFn InReportFn,
    bool bInIsEnabled
)

Constructor, initializing all member variables

Functions

Name Description

Public function

void

 

CaptureStackTrace

(
    int32 EntriesToIgnore,
    void* UserData,
    int32 StackLen,
    bool bLookupStringsForAliasRemoval
)

Captures the current stack and updates stack tracking information.

Public function

void

 

DumpStackTraces

(
    int32 StackThreshold,
    FOutputDevice& Ar,
    float SampleCountCorrectionFactor
)

Dumps capture stack trace summary to the passed in log.

Public function

void

 

ResetTracking()

Resets stack tracking.

Public function

void

 

ToggleTracking()

Toggles tracking.

Public function

void

 

ToggleTracking

(
    bool bEnable,
    bool bSilent
)

Toggles tracking.

Classes

Name

Description

Public struct

FCallStack

Helper structure to capture callstack addresses and stack count.

Typedefs

Name

Description

StackTrackerReportFn

Used to optionally report information based on the current stack

StackTrackerUpdateFn

Used to optionally update the information currently stored with the callstack

Constants

Name

Description

MAX_BACKTRACE_DEPTH

Maximum number of backtrace depth.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss