FUntypedBulkData

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FUntypedBulkData

	FByteBulkDataOld
	FFloatBulkDataOld
	FIntBulkDataOld
	FLidarPointCloudOctree::FLidarPointCloudBulkData
	FWordBulkDataOld
	TQuantizedLightSampleBulkData

References

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

Syntax

struct FUntypedBulkData

Variables

	Name	Description
FArchive *	AttachedAr	Archive associated with bulk data for serialization
FLinkerLoad ...	Linker	Used to make sure the linker doesn't get garbage collected at runtime for things with attached archives
FPackagePath	PackagePath	Name of the PackagePath containing the bulkdata
EPackageSegment	PackageSegment	Which segment of the package's data in the PackageResourceManager contains the bulkdata

Constructors

	Name	Description
	FUntypedBulkData()	Constructor, initializing all member variables.
	FUntypedBulkData ( const FUntypedBulkData& Other )	Copy constructor. Use the common routine to perform the copy.

Destructors

	Name	Description
	~FUntypedBulkData()	Virtual destructor, free'ing allocated memory.

Functions

	Name	Description
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.
bool	CanLoadFromDisk()	Returns true if the data can be loaded from disk.
void	ClearBulkDataFlags ( uint32 BulkDataFlagsToClear )	Clears the passed in bulk data flags.
void	ClearBulkDataFlagsOn ( EBulkDataFlags& InOutAccumulator, EBulkDataFlags FlagsToClear )	Disable the given flags in the given accumulator variable.
FIoChunkId	CreateChunkId()	Returns a FIoChunkId for the bulkdata payload, this will be invalid if the bulkdata is not stored in the IoStore
IBulkDataIOR...	CreateStreamingRequest ( int64 OffsetInBulkData, int64 BytesToRead, EAsyncIOPriorityAndFlags Priority, FBulkDataIORequestCallBack* Co..., uint8* UserSuppliedMemory )	Create an async read request for the bulk data.
IBulkDataIOR...	CreateStreamingRequest ( EAsyncIOPriorityAndFlags Priority, FBulkDataIORequestCallBack* Co..., uint8* UserSuppliedMemory )	Create an async read request for the bulk data.
IBulkDataIOR...	CreateStreamingRequestForRange ( const FPackagePath& PackagePath, EPackageSegment PackageSegment, const BulkDataRangeArray& RangeArr..., EAsyncIOPriorityAndFlags Priority, FBulkDataIORequestCallBack* Co... )	Create an async read request for a range of bulk data streaming tokens The request will read all data between the two given streaming tokens objects.
FBulkDataStr...	CreateStreamingToken()	Creates a FBulkDataStreamingToken representing the area of the file that the FUntypedBulkData represents.
bool	DoesExist()	Returns true if the data references a file that currently exists and can be referenced by the file system.
void	DumpBulkDataUsage ( FOutputDevice& Log )	Dumps detailed information of bulk data usage.
void	ForceBulkDataResident()	Forces the bulk data to be resident in memory and detaches the archive.
uint32	GetBulkDataAlignment()	Gets the current bulk data alignment.
uint32	GetBulkDataFlags()	Gets the current bulk data flags.
int64	GetBulkDataOffsetInFile()	Returns the offset into the file the bulk data is located at.
int64	GetBulkDataSize()	Returns the size of the bulk data in bytes.
int64	GetBulkDataSizeOnDisk()	Returns the size of the bulk data on disk.
void	GetCopy ( void** Dest, bool bDiscardInternalCopy )	Retrieves a copy of the bulk data.
FBulkDataBuf...	GetCopyAsBuffer ( int64 RequestedElementCount, bool bDiscardInternalCopy )	Returns a copy encapsulated by a FBulkDataBuffer.
FCustomVersi...	GetCustomVersions ( FArchive& InlineArchive )	Get the CustomVersions used in the file containing the BulkData payload.
FName	GetDecompressionFormat()	Returns flags usable to decompress the bulk data
FName	GetDecompressionFormat ( EBulkDataFlags InFlags )	Returns decompress method flags specified by the given bulk data flags.
int64	GetElementCount()	Returns the number of elements in this bulk data array.
int32	GetElementSize()	Returns size in bytes of single element.
FIoFilenameH...	GetIoFilenameHash()	Returns the io filename hash associated with this bulk data.
const FPacka...	GetPackagePath()	Returns the PackagePath this bulkdata resides in
EPackageSegm...	GetPackageSegment()	Returns which segment of its PackagePath this bulkdata resides in
bool	IsAsyncLoadingComplete()	Returns whether the bulk data asynchronous load has completed.
bool	IsAvailableForUse()	Returns whether this bulk data is used
bool	IsBulkDataLoaded()	Returns whether the bulk data is currently loaded and resident in memory.
bool	IsInExternalResource()	Returns whether this bulk data is stored in a PackageExternalResource rather than in a neighboring segment of its owner's PackagePath.
bool	IsInlined()	Returns whether this bulk data is currently stored inline or not
bool	IsInSeparateFile()	Returns whether this bulk data is currently stored in it's own file or not
bool	IsLocked()	Checks if this bulk is locked
bool	IsOptional()	Returns whether this bulk data represents optional data or not
bool	IsStoredCompressedOnDisk()	Returns whether the bulk data is stored compressed on disk.
bool	IsUsingIODispatcher()	Returns whether this bulk data is accessed via the IoDispatcher or not.
bool	LoadBulkDataWithFileReader()	Load the bulk data using a file reader.
void *	Lock ( uint32 LockFlags )	Locks the bulk data and returns a pointer to it.
const void &...	LockReadOnly()	Locks the bulk data and returns a read-only pointer to it.
IAsyncReadFi...	OpenAsyncReadHandle()	Opens a new IAsyncReadFileHandle that references the file that the BulkData object represents.
void *	Realloc ( int64 InElementCount )	Change size of locked bulk data. Only valid if locked via read-write lock.
void	RemoveBulkData()	Clears/removes any currently allocated data payload and resets element count to 0.
bool	RequiresSingleElementSerialization ( FArchive& Ar )	Returns whether single element serialization is required given an archive.
void	ResetBulkDataFlags ( uint32 BulkDataFlagsToSet )	Enable the given flags and disable all other flags.
void	Serialize ( FArchive& Ar, UObject* Owner, int32 Idx, bool bAttemptFileMapping, EFileRegionType FileRegionType )	Serialize function used to serialize this bulk data structure.
void	SerializeBulkData ( FArchive& Ar, void* Data, EBulkDataFlags InBulkDataFlags )	Serialize just the bulk data portion to/ from the passed in memory.
void	SerializeElement ( FArchive& Ar, void* Data, int64 ElementIndex )	Serializes a single element at a time, allowing backward compatible serialization and endian swapping to be performed.
void	SerializeElements ( FArchive& Ar, void* Data )	Serializes all elements, a single element at a time, allowing backward compatible serialization and endian swapping to be performed.
void	SetBulkDataAlignment ( uint16 BulkDataAlignmentToSet )	Sets the passed in bulk data alignment.
void	SetBulkDataFlags ( uint32 BulkDataFlagsToSet )	Enables the given flags without affecting any previously set flags.
void	SetBulkDataFlagsOn ( EBulkDataFlags& InOutAccumulator, EBulkDataFlags FlagsToSet )	Enable the given flags in the given accumulator variable.
void	SetFlagsFromDiskWrittenValues ( EBulkDataFlags InBulkDataFlags, int64 InBulkDataOffsetInFile, int64 InBulkDataSizeOnDisk, int64 LinkerSummaryBulkDataStartOff... )	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.
bool	StartAsyncLoading()	Initiates a new asynchronous operation to load the dulkdata from disk assuming that it is not already loaded.
FOwnedBulkDa...	StealFileMapping()
bool	UnloadBulkData()	Deallocates bulk data without detaching the archive, so that further bulk data accesses require a reload.
void	Unlock()	Unlocks bulk data after which point the pointer returned by Lock no longer is valid.

Operators

		Name	Description
	FUntypedBulk...	operator= ( const FUntypedBulkData& Other )	Copies the source array into this one after detaching from archive.

Typedefs

Name	Description
BulkDataRangeArray

Deprecated Functions

	Name	Description
IBulkDataIOR...	CreateStreamingRequestForRange ( const FString& Filename, const BulkDataRangeArray& RangeArr..., EAsyncIOPriorityAndFlags Priority, FBulkDataIORequestCallBack* Co... )	Use version that takes a FPackagePath instead
FString	GetFilename()	Use GetPackagePath instead
bool	InSeperateFile()	Use ::IsInSeparateFile() instead
void	SerializeBulkData ( FArchive& Ar, void* Data )	Use the version that takes InBulkDataFlags
void	StoreCompressedOnDisk ( FName CompressionFormat )	Use the FName version of StoreCompressedOnDisk
void	StoreCompressedOnDisk ( ECompressionFlags CompressionFlags )	Use the FName version of StoreCompressedOnDisk