UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FMappedFileRegion Class Referencefinal
+ Inheritance diagram for FMappedFileRegion:

Public Member Functions

 FMappedFileRegion (const uint8 *InMappedPtr, const uint8 *InAlignedPtr, size_t InMappedSize, uint64 InAlignedSize, const FString &InDebugFilename, size_t InDebugOffsetIntoFile, class FMappedFileHandle *InParent)
 
 ~FMappedFileRegion ()
 
virtual void PreloadHint (int64 PreloadOffset=0, int64 BytesToPreload=MAX_int64) override
 
- Public Member Functions inherited from IMappedFileRegion
 IMappedFileRegion (const uint8 *InMappedPtr, size_t InMappedSize, const FString &InDebugFilename, size_t InDebugOffsetRelativeToFile)
 
virtual ~IMappedFileRegion ()
 
const uint8GetMappedPtr ()
 
int64 GetMappedSize ()
 
virtual void Flush (int64 FlushOffset=0, int64 BytesToFlush=MAX_int64)
 
 IMappedFileRegion (const IMappedFileRegion &)=delete
 
IMappedFileRegionoperator= (const IMappedFileRegion &)=delete
 

Public Attributes

class FMappedFileHandleParent
 
const uint8AlignedPtr
 
uint64 AlignedSize
 

Constructor & Destructor Documentation

◆ FMappedFileRegion()

FMappedFileRegion::FMappedFileRegion ( const uint8 InMappedPtr,
const uint8 InAlignedPtr,
size_t  InMappedSize,
uint64  InAlignedSize,
const FString &  InDebugFilename,
size_t  InDebugOffsetIntoFile,
class FMappedFileHandle InParent 
)
inline

◆ ~FMappedFileRegion()

FMappedFileRegion::~FMappedFileRegion ( )

Member Function Documentation

◆ PreloadHint()

virtual void FMappedFileRegion::PreloadHint ( int64  PreloadOffset = 0,
int64  BytesToPreload = MAX_int64 
)
inlineoverridevirtual

Synchronously preload part or all of the mapped region. Typically this is done by reading a byte from each CPU page. This is only a hint, some platforms might ignore it. There are not guarantees how long this data will stay in memory.

Parameters
PreloadOffsetOffset into this region to preload
BytesToPreloadnumber of bytes to preload. This is clamped to the size of the mapped region

Reimplemented from IMappedFileRegion.

Member Data Documentation

◆ AlignedPtr

const uint8* FMappedFileRegion::AlignedPtr

◆ AlignedSize

uint64 FMappedFileRegion::AlignedSize

◆ Parent

class FMappedFileHandle* FMappedFileRegion::Parent

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