Navigation
API > API/Runtime > API/Runtime/Core
Struct used to hold common memory stats for all platforms. These values may change over the entire life of the executable.
| Name | FGenericPlatformMemoryStats |
| Type | struct |
| Header File | /Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformMemory.h |
| Include Path | #include "GenericPlatform/GenericPlatformMemory.h" |
Syntax
struct FGenericPlatformMemoryStats : public FGenericPlatformMemoryConstants
Inheritance Hierarchy
- FGenericPlatformMemoryConstants → FGenericPlatformMemoryStats
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FGenericPlatformMemoryStats() |
Default constructor, clears all variables. | GenericPlatform/GenericPlatformMemory.h |
Structs
| Name | Remarks |
|---|---|
| FPlatformSpecificStat |
Enums
Public
| Name | Remarks |
|---|---|
| EMemoryPressureStatus | Memory pressure states, useful for platforms in which the available memory estimate may not take in to account memory reclaimable from closing inactive processes or resorting to swap. |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AvailablePhysical | uint64 | The amount of physical memory currently available, in bytes. | GenericPlatform/GenericPlatformMemory.h | |
| AvailableVirtual | uint64 | The amount of virtual memory currently available, in bytes. | GenericPlatform/GenericPlatformMemory.h | |
| PeakUsedPhysical | uint64 | The peak amount of physical memory used by the process, in bytes. | GenericPlatform/GenericPlatformMemory.h | |
| PeakUsedVirtual | uint64 | The peak amount of virtual memory used by the process. | GenericPlatform/GenericPlatformMemory.h | |
| UsedPhysical | uint64 | The amount of physical memory used by the process, in bytes. | GenericPlatform/GenericPlatformMemory.h | |
| UsedVirtual | uint64 | Total amount of virtual memory used by the process. | GenericPlatform/GenericPlatformMemory.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
uint64 GetAvailablePhysical
(
bool bExcludeExtraDevMemory |
GenericPlatform/GenericPlatformMemory.h | ||
EMemoryPressureStatus GetMemoryPressureStatus() |
GenericPlatform/GenericPlatformMemory.h | ||
TArray< FPlatformSpecificStat > GetPlatformSpecificStats() |
GenericPlatform/GenericPlatformMemory.h | ||
void SetEndFrameCsvStats() |
Called by FCsvProfiler::EndFrame to set platform specific CSV stats. | GenericPlatform/GenericPlatformMemory.h |