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

#include <LargeMemoryData.h>

Public Member Functions

CORE_API FLargeMemoryData (const int64 PreAllocateBytes=0)
 
CORE_API ~FLargeMemoryData ()
 
CORE_API bool Write (void *InData, int64 InOffset, int64 InNum)
 
UE_FORCEINLINE_HINT void Append (void *InData, int64 InNum)
 
CORE_API bool Read (void *OutData, int64 InOffset, int64 InNum) const
 
UE_FORCEINLINE_HINT int64 GetSize () const
 
UE_FORCEINLINE_HINT uint8GetData ()
 
UE_FORCEINLINE_HINT const uint8GetData () const
 
CORE_API uint8ReleaseOwnership ()
 
bool HasData () const
 
CORE_API void Reserve (int64 Size)
 

Detailed Description

Data storage for the large memory reader and writer.

Constructor & Destructor Documentation

◆ FLargeMemoryData()

FLargeMemoryData::FLargeMemoryData ( const int64  PreAllocateBytes = 0)
explicit

◆ ~FLargeMemoryData()

FLargeMemoryData::~FLargeMemoryData ( )

Member Function Documentation

◆ Append()

UE_FORCEINLINE_HINT void FLargeMemoryData::Append ( void InData,
int64  InNum 
)
inline

Append data at the given offset.

◆ GetData() [1/2]

UE_FORCEINLINE_HINT uint8 * FLargeMemoryData::GetData ( )
inline

Returns the written data.

◆ GetData() [2/2]

UE_FORCEINLINE_HINT const uint8 * FLargeMemoryData::GetData ( ) const
inline

Returns the written data.

◆ GetSize()

UE_FORCEINLINE_HINT int64 FLargeMemoryData::GetSize ( ) const
inline

Gets the size of the data written.

◆ HasData()

bool FLargeMemoryData::HasData ( ) const
inline

Check whether data is allocated or if the ownership was released.

◆ Read()

bool FLargeMemoryData::Read ( void OutData,
int64  InOffset,
int64  InNum 
) const

Read data at the given offset. Returns true if the data was read.

◆ ReleaseOwnership()

uint8 * FLargeMemoryData::ReleaseOwnership ( )

Releases ownership of the written data.

◆ Reserve()

void FLargeMemoryData::Reserve ( int64  Size)

◆ Write()

bool FLargeMemoryData::Write ( void InData,
int64  InOffset,
int64  InNum 
)

Write data at the given offset. Returns true if the data was written.


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