FGenericPlatformMemoryStats Struct Reference

#include <GenericPlatformMemory.h>

Inheritance diagram for FGenericPlatformMemoryStats:

Classes
struct	FPlatformSpecificStat

Public Types
enum class	EMemoryPressureStatus : uint8 { Unknown , Nominal , Warning , Critical }

Public Member Functions
CORE_API EMemoryPressureStatus	GetMemoryPressureStatus () const
CORE_API	FGenericPlatformMemoryStats ()
CORE_API TArray< FPlatformSpecificStat >	GetPlatformSpecificStats () const
CORE_API uint64	GetAvailablePhysical (bool bExcludeExtraDevMemory) const
void	SetEndFrameCsvStats () const

Public Attributes
uint64	AvailablePhysical
uint64	AvailableVirtual
uint64	UsedPhysical
uint64	PeakUsedPhysical
uint64	UsedVirtual
uint64	PeakUsedVirtual
Public Attributes inherited from FGenericPlatformMemoryConstants
uint64	TotalPhysical = 0
uint64	TotalVirtual = 0
SIZE_T	PageSize = 0
SIZE_T	OsAllocationGranularity = 0
SIZE_T	BinnedPageSize = 0
SIZE_T	BinnedAllocationGranularity = 0
uint64	AddressStart = 0
uint64	AddressLimit = (uint64)0xffffffff + 1
uint32	TotalPhysicalGB = 1

Detailed Description

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

Member Enumeration Documentation

EMemoryPressureStatus

enum class FGenericPlatformMemoryStats::EMemoryPressureStatus : uint8

strong

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.

Enumerator
Unknown
Nominal
Warning
Critical

Constructor & Destructor Documentation

FGenericPlatformMemoryStats()

FGenericPlatformMemoryStats::FGenericPlatformMemoryStats

(

)

Default constructor, clears all variables.

Member Function Documentation

GetAvailablePhysical()

uint64 FGenericPlatformMemoryStats::GetAvailablePhysical

(

bool

bExcludeExtraDevMemory

)

const

GetMemoryPressureStatus()

FGenericPlatformMemoryStats::EMemoryPressureStatus FGenericPlatformMemoryStats::GetMemoryPressureStatus

(

)

const

GetPlatformSpecificStats()

TArray< typename FGenericPlatformMemoryStats::FPlatformSpecificStat > FGenericPlatformMemoryStats::GetPlatformSpecificStats

(

)

const

SetEndFrameCsvStats()

void FGenericPlatformMemoryStats::SetEndFrameCsvStats ( ) const

inline

Called by FCsvProfiler::EndFrame to set platform specific CSV stats.

Member Data Documentation

AvailablePhysical

uint64 FGenericPlatformMemoryStats::AvailablePhysical

The amount of physical memory currently available, in bytes.

AvailableVirtual

uint64 FGenericPlatformMemoryStats::AvailableVirtual

The amount of virtual memory currently available, in bytes.

PeakUsedPhysical

uint64 FGenericPlatformMemoryStats::PeakUsedPhysical

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

PeakUsedVirtual

uint64 FGenericPlatformMemoryStats::PeakUsedVirtual

The peak amount of virtual memory used by the process.

UsedPhysical

uint64 FGenericPlatformMemoryStats::UsedPhysical

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

UsedVirtual

uint64 FGenericPlatformMemoryStats::UsedVirtual

Total amount of virtual memory used by the process.

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformMemory.h
• Engine/Source/Runtime/Core/Private/GenericPlatform/GenericPlatformMemory.cpp