FGenericPlatformMemoryStats

Struct used to hold common memory stats for all platforms.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformMemory.h

Include

#include "GenericPlatform/GenericPlatformMemory.h"

Syntax

struct FGenericPlatformMemoryStats : public FGenericPlatformMemoryConstants

Remarks

Struct used to hold common memory stats for all platforms. These values may change over the entire life of the executable.

Variables

Name Description

Public variable

uint64

 

AvailablePhysical

The amount of physical memory currently available, in bytes.

Public variable

uint64

 

AvailableVirtual

The amount of virtual memory currently available, in bytes.

Public variable

uint64

 

PeakUsedPhysical

The peak amount of physical memory used by the process, in bytes.

Public variable

uint64

 

PeakUsedVirtual

The peak amount of virtual memory used by the process.

Public variable

uint64

 

UsedPhysical

The amount of physical memory used by the process, in bytes.

Public variable

uint64

 

UsedVirtual

Total amount of virtual memory used by the process.

Constructors

Name Description

Public function

FGenericPlatformMemoryStats()

Default constructor, clears all variables.

Functions

Name Description

Public function Const

uint64

 

GetAvailablePhysical

(
    bool bExcludeExtraDevMemory
)

Public function

EMemoryPress...

 

GetMemoryPressureStatus()

Public function Const

TArray< FPla...

 

GetPlatformSpecificStats()

Classes

Name

Description

Public struct

FPlatformSpecificStat

Enums

Name

Description

Public enum

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.