Navigation
Unreal Engine C++ API Reference > Runtime > CoreUObject > Serialization
References
Module | CoreUObject |
Header | /Engine/Source/Runtime/CoreUObject/Public/Serialization/BulkData.h |
Include | #include "Serialization/BulkData.h" |
Syntax
enum EBulkDataFlags
{
BULKDATA_None = 0,
BULKDATA_PayloadAtEndOfFile = 1 << 0,
BULKDATA_SerializeCompressedZLIB = 1 << 1,
BULKDATA_ForceSingleElementSerialization = 1 << 2,
BULKDATA_SingleUse = 1 << 3,
BULKDATA_ForceInlinePayload = 1 << 6,
BULKDATA_SerializeCompressed = (BULKDATA_SerializeCompressedZLIB),
BULKDATA_PayloadInSeperateFile = 1 << 8,
BULKDATA_Force_NOT_InlinePayload = 1 << 10,
BULKDATA_OptionalPayload = 1 << 11,
BULKDATA_MemoryMappedPayload = 1 << 12,
BULKDATA_Size64Bit = 1 << 13,
BULKDATA_DuplicateNonOptionalPayload = 1 << 14,
BULKDATA_NoOffsetFixUp = 1 << 16,
BULKDATA_WorkspaceDomainPayload = 1 << 17,
BULKDATA_LazyLoadable = 1 << 18,
BULKDATA_UsesIoDispatcher = 1u << 31u,
BULKDATA_DataIsMemoryMapped = 1 << 30,
BULKDATA_AlwaysAllowDiscard = 1 << 28,
}
Values
Name | Description |
---|---|
BULKDATA_None | Empty flag set. |
BULKDATA_PayloadAtEndOfFile | Indicates that when the payload was saved/cooked as part of a package was stored at the end of the package file rather than inline. |
BULKDATA_SerializeCompressedZLIB | If set, payload should be [un]compressed using ZLIB during serialization. |
BULKDATA_ForceSingleElementSerialization | Force usage of SerializeElement over bulk serialization. |
BULKDATA_SingleUse | When set the payload will be unloaded from memory after it has been accessed via Lock/::Unlock. |
BULKDATA_ForceInlinePayload | DEPRECATED Should be set before saing/cooking to force the internal payload to be stored inline |
BULKDATA_SerializeCompressed | |
BULKDATA_PayloadInSeperateFile | Forces the payload to be always streamed, regardless of its size. |
BULKDATA_Force_NOT_InlinePayload | DEPRECATED Should be set before being cooked as part of a package to force the cooked payload to before stored at the end of the package file either than being inline |
BULKDATA_OptionalPayload | During cooking, this flag indicates that the the payload is optional at runtime and should be stored in an .uptnl file, unless the payload is also set to be inline in which case this flag is ignored. |
BULKDATA_MemoryMappedPayload | During cooking this flag indicates that the payload should work with memory mapping at runtime if the target cooking platform supports it so the payload should be stored in a .m.ubulk file, unless the payload is also set to be inline in which case this flag is ignored. |
BULKDATA_Size64Bit | Set during serialization to indicate if the size and offset values were serialized as int64 types rather than the default int32 |
BULKDATA_DuplicateNonOptionalPayload | During cooking this flag indicates that although the payload is NOT optional it should be stored in both the .ubulk file and the .uptnl file as duplicate non-optional data, unless the payload is also set to be inline in which case this flag is ignored. |
BULKDATA_NoOffsetFixUp | DEPRECATED Set during saving and indicates that the payload offset value is correct and does not need adjusting via an additional offset stored in the FLinker (older legacy behavior) |
BULKDATA_WorkspaceDomainPayload | INTERNAL SET ONLY - callers of bulkdata should not set this flag on the bulk data If set, payload is stored in the workspace domain version of the file. |
BULKDATA_LazyLoadable | INTERNAL SET ONLY - callers of bulkdata should not set this flag on the bulk data If true, the BulkData can be loaded from its file at any time |
BULKDATA_UsesIoDispatcher | Assigned at runtime to indicate that the BulkData should be using the IoDispatcher when loading, not filepaths. |
BULKDATA_DataIsMemoryMapped | Assigned at runtime to indicate that the BulkData allocation is a memory mapped region of a file and not raw data. |
BULKDATA_AlwaysAllowDiscard | DEPRECATED Assigned at runtime to indicate that the BulkData object should be considered for discard even if it cannot load from disk. |
Remarks
Flags serialized with the bulk data.