Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > CoreUObject > Serialization > FBulkDataBase

Light Theme

Dark Theme

FBulkDataBase

Windows

MacOS

Linux

Inheritance Hierarchy

FBulkDataBase

FUntypedBulkData2

References

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

Syntax

class FBulkDataBase

Constructors

	Name	Description
	FBulkDataBase()
	FBulkDataBase ( const FBulkDataBase& Other )
	FBulkDataBase ( FBulkDataBase&& Other )

Destructors

	Name	Description
	~FBulkDataBase()

Functions

	Name	Description
bool	CanLoadFromDisk()
void	ClearBulkDataFlags ( uint32 BulkDataFlagsToClear )
IBulkDataIOR...	CreateStreamingRequest ( int64 OffsetInBulkData, int64 BytesToRead, EAsyncIOPriorityAndFlags Priority, FBulkDataIORequestCallBack* Co..., uint8* UserSuppliedMemory )
IBulkDataIOR...	CreateStreamingRequest ( EAsyncIOPriorityAndFlags Priority, FBulkDataIORequestCallBack* Co..., uint8* UserSuppliedMemory )
IBulkDataIOR...	CreateStreamingRequestForRange ( const BulkDataRangeArray& RangeArr..., EAsyncIOPriorityAndFlags Priority, FBulkDataIORequestCallBack* Co... )
bool	DoesExist()	Returns true if the data references a file that currently exists and can be referenced by the file system.
void	ForceBulkDataResident()	The following methods are for compatibility with SoundWave.cpp which assumes memory mapping.
uint32	GetBulkDataFlags()
int64	GetBulkDataOffsetInFile()	Added for compatibility with the older BulkData system.
int64	GetBulkDataSize()
void	GetCopy ( void** Dest, bool bDiscardInternalCopy )	Retrieves a copy of the bulk data.
FName	GetDecompressionFormat()
FString	GetFilename()
FIoDispatche...	GetIoDispatcher()
FIoFilenameH...	GetIoFilenameHash()	Returns the io filename hash associated with this bulk data.
const FTypeL...	GetTypeLayout()
bool	IsAsyncLoadingComplete()
bool	IsAvailableForUse()	TODO: The flag tests could be inline if we fixed the header dependency issues (the flags are defined in Bulkdata.h at the moment)
bool	IsBulkDataLoaded()
bool	IsDataMemoryMapped()
bool	IsDuplicateNonOptional()
bool	IsFileMemoryMapped()
bool	IsInlined()
bool	IsInSeparateFile()
bool	IsLocked()
bool	IsOptional()
bool	IsSingleUse()
bool	IsStoredCompressedOnDisk()
bool	IsUsingIODispatcher()
void *	Lock ( uint32 LockFlags )	Unimplemented:
const void &...	LockReadOnly()	Unimplemented:
IAsyncReadFi...	OpenAsyncReadHandle()
void *	Realloc ( int64 SizeInBytes )
void	RemoveBulkData()
void	ResetBulkDataFlags ( uint32 BulkDataFlagsToSet )
void	Serialize ( FArchive& Ar, UObject* Owner, int32 Index, bool bAttemptFileMapping, int32 ElementSize )
void	SetBulkDataFlags ( uint32 BulkDataFlagsToSet )
void	SetIoDispatcher ( FIoDispatcher* InIoDispatcher )
bool	StartAsyncLoading()	Initiates a new asynchronous operation to load the bulkdata from disk assuming that it is not already loaded.
FTypeLayoutD...	StaticGetTypeLayout()
FOwnedBulkDa...	StealFileMapping()
void	Unlock()

Operators

		Name	Description
	FBulkDataBas...	operator= ( const FBulkDataBase& Other )

Classes

	Name	Description
	InternalLinkType

Typedefs

Name	Description
AsyncCallback
BulkDataRangeArray
DerivedType
InternalBaseType

Constants

Name	Description
CounterBase
InterfaceType
InvalidToken
IoDispatcher

Deprecated Functions

		Name	Description
	bool	InSeperateFile()	Use ::IsInSeparateFile() instead
	bool	IsMemoryMapped()	Use ::IsFileMemoryMapped() instead

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss