1. Epic GamesDeveloper
  3. FBulkData

FBulkData

Unreal Engine C++ API Reference > Runtime > CoreUObject > Serialization

Inheritance Hierarchy

References

   
Module CoreUObject
Header /Engine/Source/Runtime/CoreUObject/Public/Serialization/BulkData.h
Include #include "Serialization/BulkData.h"

Syntax

class FBulkData

Variables

  Type Name Description
Protected variable FArchive * AttachedAr Archive associated with bulk data for serialization
Protected variable FLinkerLoad * Linker Used to make sure the linker doesn't get garbage collected at runtime for things with attached archives
Protected variable FSerializeBulkDataElements * SerializeBulkDataElements Custom bulk data serialization hook when using FUntypedBulkData.

Constructors

  Type Name Description
Public function   Constructor, initializing all member variables.
Public function  

FBulkData ( const FBulkData& Other
)

 Copy constructor. Use the common routine to perform the copy.

Destructors

  Type Name Description
Public function   Virtual destructor, free'ing allocated memory.

Functions

  Type Name Description
Public function Const bool Test if it is possible to load the bulk data using a file reader, even when no archive is attached to the bulk data.
Public function Const bool Returns true if the data can be loaded from disk.
Public function void

ClearBulkDataFlags ( uint32 BulkDataFlagsToClear
)

 Clears the passed in bulk data flags.
Public function Static void

ClearBulkDataFlagsOn ( EBulkDataFlags& InOutAccumulator,
EBulkDataFlags FlagsToClear
)

 Disable the given flags in the given accumulator variable.
Public function Const FIoChunkId Returns a FIoChunkId for the bulkdata payload, this will be invalid if the bulkdata is not stored in the IoStore
Public function Const IBulkDataIORequest *

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

 Create an async read request for the bulk data.
Public function Const IBulkDataIORequest *

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

 Create an async read request for the bulk data.
Public function Const bool Returns true if the data references a file that currently exists and can be referenced by the file system.
Public function Static void Dumps detailed information of bulk data usage.
Public function void Forces the bulk data to be resident in memory and detaches the archive.
Public function Const uint32 Gets the current bulk data alignment.
Public function Const uint32 Gets the current bulk data flags.
Public function Const int64 Returns the offset into the file the bulk data is located at.
Public function Const int64 Returns the size of the bulk data in bytes.
Public function Const int64 Returns the size of the bulk data on disk.
Public function Const void

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

 Get the CustomVersions used in the file containing the BulkData payload.
Public function void

GetCopy ( void** Dest,
bool bDiscardInternalCopy
)

 Retrieves a copy of the bulk data.
Public function Const FString Returns a string representing the bulk data for debugging purposes.
Public function Static FName

GetDecompressionFormat ( EBulkDataFlags InFlags
)

 Returns decompress method flags specified by the given bulk data flags.
Public function Const FName Returns flags usable to decompress the bulk data
Public function Const FIoFilenameHash Returns the io filename hash associated with this bulk data.
Public function Static bool

HasFlags ( EBulkDataFlags Flags,
EBulkDataFlags Contains
)

 Returns whether all of the specified flags are set.
Public function Const bool Returns whether the bulk data asynchronous load has completed.
Public function Const bool Returns whether the bulk data is currently loaded and resident in memory.
Public function Const bool Returns whether this bulk data is memory mapped or not.
Public function Const bool Returns whether this bulk data represents duplicate non-optional data or not
Public function Const bool Returns whether this bulk data is stored in a PackageExternalResource rather than in a neighboring segment of its owner's PackagePath.
Public function Const bool Returns whether this bulk data is currently stored inline or not
Public function Const bool Returns whether this bulk data is currently stored in it's own file or not
Public function Const bool Checks if this bulk is locked
Public function Const bool Returns whether this bulk data represents optional data or not
Public function Const bool Returns whether to deallocate the bulk data after lock
Public function Const bool Returns whether the bulk data is stored compressed on disk.
Public function Const bool Checks if this bulk is unlocked
Public function Const bool Returns whether this bulk data is accessed via the IoDispatcher or not.
Public function bool Load the bulk data using a file reader.
Public function void *

Lock ( uint32 LockFlags
)

 Locks the bulk data and returns a pointer to it.
Public function Const const void * Locks the bulk data and returns a read-only pointer to it.
Public function Const IAsyncReadFileHandle * Opens a new IAsyncReadFileHandle that references the file that the BulkData object represents.
Public function void *

Realloc ( int64 ElementCount,
int64 ElementSize
)

 Change size of locked bulk data. Only valid if locked via read-write lock.
Public function void Clears/removes any currently allocated data payload and resets element count to 0.
Public function void

ResetBulkDataFlags ( uint32 BulkDataFlagsToSet
)

 Enable the given flags and disable all other flags.
Public function void

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

 Serialize function used to serialize this bulk data structure.
Public function void

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

 Serialize just the bulk data portion to/ from the passed in memory.
Protected function void

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

  
Public function void

SetBulkDataFlags ( uint32 BulkDataFlagsToSet
)

 Enables the given flags without affecting any previously set flags.
Public function Static void

SetBulkDataFlagsOn ( EBulkDataFlags& InOutAccumulator,
EBulkDataFlags FlagsToSet
)

 Enable the given flags in the given accumulator variable.
Public function 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.
Public function FOwnedBulkDataPtr *  
Public function void

StoreCompressedOnDisk ( FName CompressionFormat
)

 Sets whether we should store the data compressed on disk.
Public function bool Deallocates bulk data without detaching the archive, so that further bulk data accesses require a reload.
Public function Const void

Unlock ()

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

Operators

  Type Name Description
Public function FBulkData &

operator= ( const FBulkData& Other
)

 Copies the source array into this one after detaching from archive.

Typedefs

Name Description
BulkDataRangeArray  
FSerializeBulkDataElements  

Constants

Name Description
MaxBulkDataSize  

Deprecated Functions

  Type Name Description
Public function Static IBulkDataIORequest *

CreateStreamingRequestForRange ( const BulkDataRangeArray& RangeArray,
EAsyncIOPriorityAndFlags Priority,
FBulkDataIORequestCallBack* CompleteCallback
)

 Use FBulkDataRequest instead
Public function Const FCustomVersionContainer

GetCustomVersions ( FArchive& InlineArchive
)

 Call GetBulkDataVersions instead.
Public function Const const FPackagePath & Deprecated, no replacement
Public function Const EPackageSegment Deprecated, no replacement
Public function Const bool The feature is being removed, it is assumed that all bulkdata is available for use
Public function void

SetBulkDataAlignment ( uint16 BulkDataAlignmentToSet
)

 Bulk Data will always use default alignment
Public function bool Use FBulkDataRequest or CreateStreamingRequest instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page