1. Epic GamesDeveloper
  3. FBulkData

FBulkData

@documentation

API > API/Runtime > API/Runtime/CoreUObject

@documentation

   
Name FBulkData
Type class
Header File /Engine/Source/Runtime/CoreUObject/Public/Serialization/BulkData.h
Include Path #include "Serialization/BulkData.h"

Syntax

class FBulkData

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
Constructor, initializing all member variables. Serialization/BulkData.h  

FBulkData ( const FBulkData& Other
)

 Copy constructor. Use the common routine to perform the copy. Serialization/BulkData.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FBulkData()

 Virtual destructor, free'ing allocated memory. Serialization/BulkData.h  

Structs

Name Remarks
FAllocatedPtr This struct represents an optional allocation.

Typedefs

Name Type Remarks Include Path
BulkDataRangeArray TArray< FBulkData *, TInlineAllocator< 8 > >   Serialization/BulkData.h
FSerializeBulkDataElements TFunction< void(FArchive &, void *, int64, EBulkDataFlags)>   Serialization/BulkData.h

Constants

Name Type Remarks Include Path
MaxBulkDataSize SIZE_T   Serialization/BulkData.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
BulkChunkId FIoChunkId   Serialization/BulkData.h  
BulkMeta UE::BulkData::Private::FBulkMetaData   Serialization/BulkData.h  
DataAllocation FAllocatedPtr   Serialization/BulkData.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CanLoadBulkDataWithFileReader()

 Test if it is possible to load the bulk data using a file reader, even when no archive is attached to the bulk data. Serialization/BulkData.h  

bool CanLoadFromDisk()

 Returns true if the data can be loaded from disk. Serialization/BulkData.h  

void ClearBulkDataFlags ( uint32 BulkDataFlagsToClear
)

 Clears the passed in bulk data flags. Serialization/BulkData.h  

FIoChunkId CreateChunkId()

 Returns a FIoChunkId for the bulkdata payload, this will be invalid if the bulkdata is not stored in the IoStore Serialization/BulkData.h  

IBulkDataIORequest * CreateStreamingRequest ( int64 OffsetInBulkData,
int64 BytesToRead,
EAsyncIOPriorityAndFlags Priority,
FBulkDataIORequestCallBack* CompleteCallback,
uint8* UserSuppliedMemory
) const

 Create an async read request for the bulk data. Serialization/BulkData.h  

IBulkDataIORequest * CreateStreamingRequest ( EAsyncIOPriorityAndFlags Priority,
FBulkDataIORequestCallBack* CompleteCallback,
uint8* UserSuppliedMemory
) const

 Create an async read request for the bulk data. Serialization/BulkData.h  

bool DoesExist()

 Returns true if the data references a file that currently exists and can be referenced by the file system. Serialization/BulkData.h  

void ForceBulkDataResident()

 Forces the bulk data to be resident in memory and detaches the archive. Serialization/BulkData.h  

uint32 GetBulkDataAlignment()

 Gets the current bulk data alignment. Serialization/BulkData.h  

uint32 GetBulkDataFlags()

 Gets the current bulk data flags. Serialization/BulkData.h  

int64 GetBulkDataOffsetInFile()

 Returns the offset into the file the bulk data is located at. Serialization/BulkData.h  

int64 GetBulkDataSize()

 Returns the size of the bulk data in bytes. Serialization/BulkData.h  
Returns the size of the bulk data on disk. Serialization/BulkData.h  

void GetBulkDataVersions ( FArchive& InlineArchive,
FPackageFileVersion& OutUEVersion,
int32& OutLicenseeUEVersion,
FCustomVersionContainer& OutCustomVersions
) const

 Get the CustomVersions used in the file containing the BulkData payload. Serialization/BulkData.h  

void GetCopy ( void** Dest,
bool bDiscardInternalCopy
)

 Retrieves a copy of the bulk data. Serialization/BulkData.h  

FString GetDebugName()

 Returns a string representing the bulk data for debugging purposes. Serialization/BulkData.h  
Returns flags usable to decompress the bulk data Serialization/BulkData.h  

FIoFilenameHash GetIoFilenameHash()

 Returns the io filename hash associated with this bulk data. Serialization/BulkData.h  

bool IsAsyncLoadingComplete()

 Deprecated Serialization/BulkData.h  

bool IsAvailableForUse()

 Returns whether this bulk data is used Serialization/BulkData.h  

bool IsBulkDataLoaded()

 Returns whether the bulk data is currently loaded and resident in memory. Serialization/BulkData.h  

bool IsDataMemoryMapped()

 Returns whether this bulk data is memory mapped or not. Serialization/BulkData.h  

bool IsDuplicateNonOptional()

 Returns whether this bulk data represents duplicate non-optional data or not Serialization/BulkData.h  

bool IsInExternalResource()

 Returns whether this bulk data is stored in a PackageExternalResource rather than in a neighboring segment of its owner's PackagePath. Serialization/BulkData.h  

bool IsInlined()

 Returns whether this bulk data is currently stored inline or not Serialization/BulkData.h  

bool IsInSeparateFile()

 Returns whether this bulk data is currently stored in it's own file or not Serialization/BulkData.h  

bool IsLocked()

 Checks if this bulk is locked Serialization/BulkData.h  

bool IsOptional()

 Returns whether this bulk data represents optional data or not Serialization/BulkData.h  

bool IsSingleUse()

 Returns whether to deallocate the bulk data after lock Serialization/BulkData.h  

bool IsStoredCompressedOnDisk()

 Returns whether the bulk data is stored compressed on disk. Serialization/BulkData.h  

bool IsUnlocked()

 Checks if this bulk is unlocked Serialization/BulkData.h  

bool IsUsingIODispatcher()

 Returns whether this bulk data is accessed via the IoDispatcher or not. Serialization/BulkData.h  
Load the bulk data using a file reader. Serialization/BulkData.h  

void * Lock ( uint32 LockFlags
)

 Locks the bulk data and returns a pointer to it. Serialization/BulkData.h  

const void * LockReadOnly ()

 Locks the bulk data and returns a read-only pointer to it. Serialization/BulkData.h  

IAsyncReadFileHandle * OpenAsyncReadHandle()

 Opens a new IAsyncReadFileHandle that references the file that the BulkData object represents. Serialization/BulkData.h  

void * Realloc ( int64 ElementCount,
int64 ElementSize
)

 Change size of locked bulk data. Only valid if locked via read-write lock. Serialization/BulkData.h  

void RemoveBulkData ()

 Clears/removes any currently allocated data payload and resets element count to 0. Serialization/BulkData.h  

void ResetBulkDataFlags ( uint32 BulkDataFlagsToSet
)

 Enable the given flags and disable all other flags. Serialization/BulkData.h  

void Serialize ( FArchive& Ar,
UObject* Owner,
bool bAttemptFileMapping,
int32 ElementSize,
EFileRegionType FileRegionType
)

 Serialize function used to serialize this bulk data structure. Serialization/BulkData.h  

void SerializeBulkData ( FArchive& Ar,
void* Data,
EBulkDataFlags InBulkDataFlags
)

 Serialize just the bulk data portion to/ from the passed in memory. Serialization/BulkData.h  

void SetBulkDataFlags ( uint32 BulkDataFlagsToSet
)

 Enables the given flags without affecting any previously set flags. Serialization/BulkData.h  

void SetCookedIndex ( FBulkDataCookedIndex Index
)

   Serialization/BulkData.h  

void SetFlagsFromDiskWrittenValues ( EBulkDataFlags InBulkDataFlags,
int64 InBulkDataOffsetInFile,
int64 InBulkDataSizeOnDisk,
int64 LinkerSummaryBulkDataStartOffset
)

 When saving BulkData, if we are overwriting the file we need to update the BulkData's (flags,offset,size) to be able to load from the new file. Serialization/BulkData.h  

FOwnedBulkDataPtr * StealFileMapping()

   Serialization/BulkData.h  

void StoreCompressedOnDisk ( FName CompressionFormat
)

 Sets whether we should store the data compressed on disk. Serialization/BulkData.h  

bool UnloadBulkData ()

 Deallocates bulk data without detaching the archive, so that further bulk data accesses require a reload. Serialization/BulkData.h  

void Unlock()

 Unlocks bulk data after which point the pointer returned by Lock no longer is valid. Serialization/BulkData.h  

Protected

Name Remarks Include Path Unreal Specifiers

void SerializeBulkData ( FArchive& Ar,
void* Data,
int64 DataSize,
EBulkDataFlags InBulkDataFlags
)

   Serialization/BulkData.h  

Static

Name Remarks Include Path Unreal Specifiers

static void ClearBulkDataFlagsOn ( EBulkDataFlags& InOutAccumulator,
EBulkDataFlags FlagsToClear
)

 Disable the given flags in the given accumulator variable. Serialization/BulkData.h  

static void DumpBulkDataUsage ( FOutputDevice& Log
)

 Dumps detailed information of bulk data usage. Serialization/BulkData.h  
Returns decompress method flags specified by the given bulk data flags. Serialization/BulkData.h  

static bool HasFlags ( EBulkDataFlags Flags,
EBulkDataFlags Contains
)

 Returns whether all of the specified flags are set. Serialization/BulkData.h  

static void SetBulkDataFlagsOn ( EBulkDataFlags& InOutAccumulator,
EBulkDataFlags FlagsToSet
)

 Enable the given flags in the given accumulator variable. Serialization/BulkData.h  

Operators

Name Remarks Include Path Unreal Specifiers

FBulkData & operator= ( const FBulkData& Other
)

 Copies the source array into this one after detaching from archive. Serialization/BulkData.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page