#include <GenericPlatformMemory.h>

Inheritance diagram for FGenericPlatformMemoryStats:

Collaboration diagram for FGenericPlatformMemoryStats:

Classes
struct	FPlatformSpecificStat

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

Public Member Functions
EMemoryPressureStatus	GetMemoryPressureStatus () const

	FGenericPlatformMemoryStats ()

TArray< FPlatformSpecificStat >	GetPlatformSpecificStats () const

uint64	GetAvailablePhysical (bool bExcludeExtraDevMemory) const

void	SetEndFrameCsvStats () const

Public Member Functions inherited from FGenericPlatformMemoryConstants
	FGenericPlatformMemoryConstants ()

	FGenericPlatformMemoryConstants (const FGenericPlatformMemoryConstants &Other)

Public Attributes
uint64	AvailablePhysical

uint64	AvailableVirtual

uint64	UsedPhysical

uint64	PeakUsedPhysical

uint64	UsedVirtual

uint64	PeakUsedVirtual

Public Attributes inherited from FGenericPlatformMemoryConstants
uint64	TotalPhysical

uint64	TotalVirtual

SIZE_T	PageSize

SIZE_T	OsAllocationGranularity

SIZE_T	BinnedPageSize

SIZE_T	BinnedAllocationGranularity

uint64	AddressLimit

uint32	TotalPhysicalGB

Detailed Description

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

Definition at line 134 of file GenericPlatformMemory.h.

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
Critical

Definition at line 156 of file GenericPlatformMemory.h.

Constructor & Destructor Documentation

◆ FGenericPlatformMemoryStats()

FGenericPlatformMemoryStats::FGenericPlatformMemoryStats ( )

Default constructor, clears all variables.

Here is the caller graph for this function:

Member Function Documentation

◆ GetAvailablePhysical()

uint64 FGenericPlatformMemoryStats::GetAvailablePhysical ( bool bExcludeExtraDevMemory ) const

◆ GetMemoryPressureStatus()

EMemoryPressureStatus FGenericPlatformMemoryStats::GetMemoryPressureStatus ( ) const

◆ GetPlatformSpecificStats()

TArray< FPlatformSpecificStat > FGenericPlatformMemoryStats::GetPlatformSpecificStats ( ) const

◆ SetEndFrameCsvStats()

void FGenericPlatformMemoryStats::SetEndFrameCsvStats ( ) const

inline

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

Definition at line 183 of file GenericPlatformMemory.h.

Member Data Documentation

◆ AvailablePhysical

uint64 FGenericPlatformMemoryStats::AvailablePhysical

The amount of physical memory currently available, in bytes.

Definition at line 137 of file GenericPlatformMemory.h.

◆ AvailableVirtual

uint64 FGenericPlatformMemoryStats::AvailableVirtual

The amount of virtual memory currently available, in bytes.

Definition at line 140 of file GenericPlatformMemory.h.

◆ PeakUsedPhysical

uint64 FGenericPlatformMemoryStats::PeakUsedPhysical

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

Definition at line 146 of file GenericPlatformMemory.h.

◆ PeakUsedVirtual

uint64 FGenericPlatformMemoryStats::PeakUsedVirtual

The peak amount of virtual memory used by the process.

Definition at line 152 of file GenericPlatformMemory.h.

◆ UsedPhysical

uint64 FGenericPlatformMemoryStats::UsedPhysical

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

Definition at line 143 of file GenericPlatformMemory.h.

◆ UsedVirtual

uint64 FGenericPlatformMemoryStats::UsedVirtual

Total amount of virtual memory used by the process.

Definition at line 149 of file GenericPlatformMemory.h.

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

C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/GenericPlatform/GenericPlatformMemory.h

Classes

Public Types

Public Member Functions

Public Attributes