UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FFileCache Class Reference

Classes

struct  FSlotInfo
 

Public Member Functions

 FFileCache (int32 NumSlots)
 UE_BUILD_SHIPPING.
 
 ~FFileCache ()
 
uint8GetSlotMemory (CacheSlotID SlotID)
 
CacheSlotID AcquireAndLockSlot (FFileCacheHandle *InHandle, CacheLineID InLineID)
 
bool IsSlotLocked (CacheSlotID InSlotID) const
 
void LockSlot (CacheSlotID InSlotID)
 
void UnlockSlot (CacheSlotID InSlotID)
 
bool EvictAll (FFileCacheHandle *InFile=nullptr)
 
void FlushCompletedRequests ()
 
void EvictFileCacheFromConsole ()
 
void PushCompletedRequest (IAsyncReadRequest *Request)
 
void UnlinkSlot (int32 SlotIndex)
 
void LinkSlotTail (int32 SlotIndex)
 
void LinkSlotHead (int32 SlotIndex)
 

Public Attributes

FCriticalSection CriticalSection
 
FAutoConsoleCommand EvictFileCacheCommand
 
TLockFreePointerListUnordered< IAsyncReadRequest, PLATFORM_CACHE_LINE_SIZECompletedRequests
 
FThreadSafeCounter CompletedRequestsCounter
 
TArray< FSlotInfoSlotInfo
 
uint8Memory
 
int64 SizeInBytes
 
int32 NumFreeSlots
 
int32 MinNumFreeSlots
 

Constructor & Destructor Documentation

◆ FFileCache()

FFileCache::FFileCache ( int32  NumSlots)
explicit

UE_BUILD_SHIPPING.

◆ ~FFileCache()

FFileCache::~FFileCache ( )
inline

Member Function Documentation

◆ AcquireAndLockSlot()

CacheSlotID FFileCache::AcquireAndLockSlot ( FFileCacheHandle InHandle,
CacheLineID  InLineID 
)

◆ EvictAll()

bool FFileCache::EvictAll ( FFileCacheHandle InFile = nullptr)

◆ EvictFileCacheFromConsole()

void FFileCache::EvictFileCacheFromConsole ( )
inline

◆ FlushCompletedRequests()

void FFileCache::FlushCompletedRequests ( )

◆ GetSlotMemory()

uint8 * FFileCache::GetSlotMemory ( CacheSlotID  SlotID)
inline

◆ IsSlotLocked()

bool FFileCache::IsSlotLocked ( CacheSlotID  InSlotID) const

◆ LinkSlotHead()

void FFileCache::LinkSlotHead ( int32  SlotIndex)
inline

◆ LinkSlotTail()

void FFileCache::LinkSlotTail ( int32  SlotIndex)
inline

◆ LockSlot()

void FFileCache::LockSlot ( CacheSlotID  InSlotID)

◆ PushCompletedRequest()

void FFileCache::PushCompletedRequest ( IAsyncReadRequest Request)
inline

◆ UnlinkSlot()

void FFileCache::UnlinkSlot ( int32  SlotIndex)
inline

◆ UnlockSlot()

void FFileCache::UnlockSlot ( CacheSlotID  InSlotID)

Member Data Documentation

◆ CompletedRequests

◆ CompletedRequestsCounter

FThreadSafeCounter FFileCache::CompletedRequestsCounter

◆ CriticalSection

FCriticalSection FFileCache::CriticalSection

◆ EvictFileCacheCommand

FAutoConsoleCommand FFileCache::EvictFileCacheCommand

◆ Memory

uint8* FFileCache::Memory

◆ MinNumFreeSlots

int32 FFileCache::MinNumFreeSlots

◆ NumFreeSlots

int32 FFileCache::NumFreeSlots

◆ SizeInBytes

int64 FFileCache::SizeInBytes

◆ SlotInfo

TArray<FSlotInfo> FFileCache::SlotInfo

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