Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
FGenericPlatformMemoryConstants Struct Reference

#include <GenericPlatformMemory.h>

+ Inheritance diagram for FGenericPlatformMemoryConstants:

Public Member Functions

 FGenericPlatformMemoryConstants ()
 
 FGenericPlatformMemoryConstants (const FGenericPlatformMemoryConstants &Other)
 

Public Attributes

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 constants for all platforms. These values don't change over the entire life of the executable.

Definition at line 72 of file GenericPlatformMemory.h.

Constructor & Destructor Documentation

◆ FGenericPlatformMemoryConstants() [1/2]

FGenericPlatformMemoryConstants::FGenericPlatformMemoryConstants ( )
inline

Default constructor, clears all variables.

Definition at line 104 of file GenericPlatformMemory.h.

◆ FGenericPlatformMemoryConstants() [2/2]

FGenericPlatformMemoryConstants::FGenericPlatformMemoryConstants ( const FGenericPlatformMemoryConstants & Other)
inline

Copy constructor, used by the generic platform memory stats.

Definition at line 116 of file GenericPlatformMemory.h.

Member Data Documentation

◆ AddressLimit

uint64 FGenericPlatformMemoryConstants::AddressLimit

Definition at line 98 of file GenericPlatformMemory.h.

◆ BinnedAllocationGranularity

SIZE_T FGenericPlatformMemoryConstants::BinnedAllocationGranularity

This is the "allocation granularity" in Binned malloc terms, i.e. BinnedMalloc will allocate the memory in increments of this value. If zero, Binned will use BinnedPageSize for this value.

Definition at line 93 of file GenericPlatformMemory.h.

◆ BinnedPageSize

SIZE_T FGenericPlatformMemoryConstants::BinnedPageSize

The size of a "page" in Binned2 malloc terms, in bytes. Should be at least 64KB. BinnedMalloc expects memory returned from BinnedAllocFromOS() to be aligned on BinnedPageSize boundary.

Definition at line 90 of file GenericPlatformMemory.h.

◆ OsAllocationGranularity

SIZE_T FGenericPlatformMemoryConstants::OsAllocationGranularity

Some platforms have advantages if memory is allocated in chunks larger than PageSize (e.g. VirtualAlloc() seems to have 64KB granularity as of now). This value is the minimum allocation size that the system will use behind the scenes.

Definition at line 87 of file GenericPlatformMemory.h.

◆ PageSize

SIZE_T FGenericPlatformMemoryConstants::PageSize

The size of a physical page, in bytes. This is also the granularity for PageProtect(), commitment and properties (e.g. ability to access) of the physical RAM.

Definition at line 81 of file GenericPlatformMemory.h.

◆ TotalPhysical

uint64 FGenericPlatformMemoryConstants::TotalPhysical

The amount of actual physical memory, in bytes (needs to handle >4GB for 64-bit devices running 32-bit code).

Definition at line 75 of file GenericPlatformMemory.h.

◆ TotalPhysicalGB

uint32 FGenericPlatformMemoryConstants::TotalPhysicalGB

Approximate physical RAM in GB; 1 on everything except PC. Used for "course tuning", like FPlatformMisc::NumberOfCores().

Definition at line 101 of file GenericPlatformMemory.h.

◆ TotalVirtual

uint64 FGenericPlatformMemoryConstants::TotalVirtual

The amount of virtual memory, in bytes.

Definition at line 78 of file GenericPlatformMemory.h.


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