UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
BulkData.cpp File Reference

Namespaces

namespace  UE
 
namespace  UE::BulkData
 
namespace  UE::BulkData::Private
 

Macros

#define TRACK_BULKDATA_USE   0
 
#define ALLOW_OPTIONAL_DATA   1
 
#define TEST_AND_ADD_FLAG(Sb, Flags, Contains)
 

Functions

FStringBuilderBaseLexToString (EBulkDataFlags Flags, FStringBuilderBase &Sb)
 
FString LexToString (EBulkDataFlags Flags)
 
FIoFilenameHash MakeIoFilenameHash (const FPackagePath &PackagePath)
 
FIoFilenameHash MakeIoFilenameHash (const FString &Filename)
 
FIoFilenameHash MakeIoFilenameHash (const FIoChunkId &ChunkID)
 
bool UE::BulkData::Private::OpenReadBulkData (const FBulkMetaData &BulkMeta, const FIoChunkId &BulkChunkId, int64 Offset, int64 Size, EAsyncIOPriorityAndFlags Priority, TFunction< void(FArchive &Ar)> &&Read)
 
TUniquePtr< IAsyncReadFileHandleUE::BulkData::Private::OpenAsyncReadBulkData (const FBulkMetaData &BulkMeta, const FIoChunkId &BulkChunkId, uint64 ChunkSize, uint64 AvailableChunkSize)
 
TUniquePtr< IBulkDataIORequestUE::BulkData::Private::CreateStreamingRequest (const FBulkMetaData &BulkMeta, const FIoChunkId &BulkChunkId, int64 Offset, int64 Size, EAsyncIOPriorityAndFlags Priority, FBulkDataIORequestCallBack *CompleteCallback, uint8 *UserSuppliedMemory)
 
bool UE::BulkData::Private::TryMemoryMapBulkData (const FBulkMetaData &BulkMeta, const FIoChunkId &BulkChunkId, int64 Offset, int64 Size, FIoMappedRegion &OutRegion)
 
FArchiveUE::BulkData::Private::operator<< (FArchive &Ar, FBulkMetaResource &BulkMeta)
 
FString UE::BulkData::Private::GetDebugNameFromArchive (FArchive &Ar)
 
voidUE::BulkData::Private::SafeMalloc (int64 SizeInBytes, uint32 Alignment)
 
voidUE::BulkData::Private::SafeRealloc (void *Original, int64 SizeInBytes, uint32 Alignment)
 
 DECLARE_STATS_GROUP (TEXT("Bulk Data"), STATGROUP_BulkData, STATCAT_Advanced)
 

Variables

const FIoFilenameHash FALLBACK_IO_FILENAME_HASH = INVALID_IO_FILENAME_HASH - 1
 
int32 GMinimumBulkDataSizeForAsyncLoading = 131072
 

Macro Definition Documentation

◆ ALLOW_OPTIONAL_DATA

#define ALLOW_OPTIONAL_DATA   1

◆ TEST_AND_ADD_FLAG

#define TEST_AND_ADD_FLAG (   Sb,
  Flags,
  Contains 
)
Value:
{\
if ((uint32(Flags) & uint32(Contains)) == uint32(Contains))\
{\
if (Sb.Len())\
{\
Sb.Append(TEXT("|"));\
}\
Sb.Append(TEXT(#Contains));\
}\
}
#define TEXT(x)
Definition Platform.h:1272
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
uint32_t uint32
Definition binka_ue_file_header.h:6

◆ TRACK_BULKDATA_USE

#define TRACK_BULKDATA_USE   0

Whether to track information of how bulk data is being used

Function Documentation

◆ DECLARE_STATS_GROUP()

DECLARE_STATS_GROUP ( TEXT("Bulk Data" ,
STATGROUP_BulkData  ,
STATCAT_Advanced   
)

◆ LexToString() [1/2]

FString LexToString ( EBulkDataFlags  Flags)

◆ LexToString() [2/2]

FStringBuilderBase & LexToString ( EBulkDataFlags  Flags,
FStringBuilderBase Sb 
)

◆ MakeIoFilenameHash() [1/3]

FIoFilenameHash MakeIoFilenameHash ( const FIoChunkId ChunkID)

Helpers to create the hash from a chunk id. Returns IOFILENAMEHASH_NONE if and only if the chunk id is invalid.

◆ MakeIoFilenameHash() [2/3]

FIoFilenameHash MakeIoFilenameHash ( const FPackagePath Filename)

Helpers to create the hash from a FPackagePath. Returns IOFILENAMEHASH_NONE if and only if the PackagePath is empty.

◆ MakeIoFilenameHash() [3/3]

FIoFilenameHash MakeIoFilenameHash ( const FString &  Filename)

Helpers to create the hash from a filename. Returns IOFILENAMEHASH_NONE if and only if the filename is empty.

Variable Documentation

◆ FALLBACK_IO_FILENAME_HASH

const FIoFilenameHash FALLBACK_IO_FILENAME_HASH = INVALID_IO_FILENAME_HASH - 1

◆ GMinimumBulkDataSizeForAsyncLoading

int32 GMinimumBulkDataSizeForAsyncLoading = 131072