Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/ProfilingDebugging
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Public/ProfilingDebugging/MallocLeakReporter.h |
| Include | #include "ProfilingDebugging/MallocLeakReporter.h" |
Syntax
class FMallocLeakReporter
Remarks
FMallocLeakReporter is a helper class that works alongside FMallocLeakDetection to provide easy access to reports of low-level memory leaks.
The reporter can be operated from the console where it can be started/stopped and used to periodically or manually report leaks, or it can be called from game code to implemnent this funtionality at desired times.
Example Console Usage:
"mallocleak.start report=300" - start tracking leaks and generate a report every 300 secs "mallocleak report" - report allocations and leaks "mallocleak stop" - stop tracking leaks
Example Code usage
FMallocLeakReporter::Get().Start(0, 300) - start tracking allocs > 0KB and generate a report every 300 secs FMallocLeakReporter::Get().WriteReports() - Writes reports and returns the number of suspected leaks FMallocLeakReporter::Get().WriteReport(TEXT("BigAllocs"), Options); - Write custom report of allocations that matches "Options" FMallocLeakReporter::Get().Stop() - stop tracking allocations
Reports are written to the profiling dir, e,g GameName/Saved/Profiling/SessionName
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FTSTicker::FDelegateHandle | CheckpointTicker | |
 |
FMallocLeakReportOptions | DefaultAllocReportOptions | |
 |
FMallocLeakReportOptions | DefaultLeakReportOptions | Report vars. |
 |
bool | Enabled | |
 |
int32 | ReportCount | |
 |
FMallocLeakReportDelegate | ReportDelegate | |
 |
FTSTicker::FDelegateHandle | ReportTicker |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Private constructor |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | Checkpoint () |
Called internally to generate rate checkpoints |
 |
void | Clear () |
Clears all accumulated data |
  |
FMallocLeakReporter & | Get () |
Return singleton instance |
  |
bool | IsEnabled () |
Returns our enabled state |
 |
void | SetDefaultAllocReportOptions
(
const FMallocLeakReportOptions& Options |
Sets default options for reporting allocations |
 |
void | SetDefaultLeakReportOptions
(
const FMallocLeakReportOptions& Options |
Sets default options for what are considered memory leaks |
 |
void | Starts tracking allocations. | |
 |
void | Stop () |
Stop tracking leaks |
 |
int32 | WriteReport
(
const TCHAR* ReportName, |
Writes out a report according to the passed in options |
 |
int32 | WriteReports
(
const uint32 ReportFlags |
Writes out a set of reports according to our defaults |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
EReportOption |
Typedefs
| Name | Description |
|---|---|
| FMallocLeakReportDelegate |