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

Classes

class  UE::BulkData::Private::FChunkRequest
 
class  UE::BulkData::Private::FChunkReadFileRequest
 
class  UE::BulkData::Private::FChunkFileSizeRequest
 
class  UE::BulkData::Private::FChunkReadFileHandle
 
class  UE::BulkData::Private::FChunkBulkDataRequest
 
class  FHandleBase
 
class  FChunkBatchReadRequest
 
class  FBulkDataBatchRequest::FBatchHandle
 

Namespaces

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

Macros

#define UE_ENABLE_BULKDATA_RANGE_TEST   0
 

Enumerations

enum class  UE::BulkData::Private::EChunkRequestStatus : uint32 {
  UE::BulkData::Private::None = 0 , UE::BulkData::Private::Pending = 1 << 0 , UE::BulkData::Private::Canceled = 1 << 1 , UE::BulkData::Private::DataReady = 1 << 2 ,
  UE::BulkData::Private::CallbackTriggered = 1 << 3
}
 

Functions

 TRACE_DECLARE_ATOMIC_INT_COUNTER (BulkDataBatchRequest_Count, TEXT("BulkData/BatchRequest/Count"))
 
 TRACE_DECLARE_ATOMIC_INT_COUNTER (BulkDataBatchRequest_PendingCount, TEXT("BulkData/BatchRequest/Pending"))
 
 UE::BulkData::Private::ENUM_CLASS_FLAGS (EChunkRequestStatus)
 
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< IAsyncReadFileHandleUE::BulkData::Private::OpenAsyncReadBulkData (const FBulkMetaData &BulkMeta, const FIoChunkId &BulkChunkId)
 
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)
 

Macro Definition Documentation

◆ UE_ENABLE_BULKDATA_RANGE_TEST

#define UE_ENABLE_BULKDATA_RANGE_TEST   0

When enabled calls to FChunkReadFileHandle::ReadRequest will validate that the request is within the bulkdata payload bounds. Currently disabled as FFileCache still uses the handle to represent the entire .ubulk file rather than the specific bulkdata payload.

Function Documentation

◆ TRACE_DECLARE_ATOMIC_INT_COUNTER() [1/2]

TRACE_DECLARE_ATOMIC_INT_COUNTER ( BulkDataBatchRequest_Count  ,
TEXT("BulkData/BatchRequest/Count"  
)

◆ TRACE_DECLARE_ATOMIC_INT_COUNTER() [2/2]

TRACE_DECLARE_ATOMIC_INT_COUNTER ( BulkDataBatchRequest_PendingCount  ,
TEXT("BulkData/BatchRequest/Pending"  
)