Module |
|
Header |
/Engine/Source/Runtime/CoreUObject/Public/Serialization/BulkData.h |
Include |
#include "Serialization/BulkData.h" |
struct FUntypedBulkData
Name | Description | ||
---|---|---|---|
|
FArchive * |
AttachedAr |
Archive associated with bulk data for serialization |
|
Filename |
Name of the package file containing the bulkdata |
|
|
FLinkerLoad ... |
Linker |
Used to make sure the linker doesn't get garbage collected at runtime for things with attached archives |
Name | Description | |
---|---|---|
|
FUntypedBulkData() |
Constructor, initializing all member variables. |
|
FUntypedBulkData ( |
Copy constructor. Use the common routine to perform the copy. |
Name | Description | |
---|---|---|
|
~FUntypedBulkData() |
Virtual destructor, free'ing allocated memory. |
Name | Description | ||
---|---|---|---|
|
CanLoadFromDisk() |
Returns true if the data can be loaded from disk. |
|
|
ClearBulkDataFlags ( |
Clears the passed in bulk data flags. |
|
|
IBulkDataIOR... |
CreateStreamingRequest ( |
Create an async read request for the bulk data. |
|
IBulkDataIOR... |
CreateStreamingRequest ( |
Create an async read request for the bulk data. |
|
IBulkDataIOR... |
CreateStreamingRequestForRange ( |
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. |
|
DoesExist() |
Returns true if the data references a file that currently exists and can be referenced by the file system. |
|
|
DumpBulkDataUsage ( |
Dumps detailed information of bulk data usage. |
|
|
ForceBulkDataResident() |
Forces the bulk data to be resident in memory and detaches the archive. |
|
|
GetBulkDataAlignment() |
Gets the current bulk data alignment. |
|
|
GetBulkDataFlags() |
Gets the current bulk data flags. |
|
|
GetBulkDataOffsetInFile() |
Returns the offset into the file the bulk data is located at. |
|
|
GetBulkDataSize() |
Returns the size of the bulk data in bytes. |
|
|
GetBulkDataSizeOnDisk() |
Returns the size of the bulk data on disk. |
|
|
GetCopy |
Retrieves a copy of the bulk data. |
|
|
FBulkDataBuf... |
GetCopyAsBuffer |
Returns a copy encapsulated by a FBulkDataBuffer. |
|
GetDecompressionFormat() |
Returns flags usable to decompress the bulk data |
|
|
GetElementCount() |
Returns the number of elements in this bulk data array. |
|
|
GetElementSize() |
Returns size in bytes of single element. |
|
|
const FStrin... |
GetFilename() |
Returns the filename this bulkdata resides in |
|
IsAsyncLoadingComplete() |
Returns whether the bulk data asynchronous load has completed. |
|
|
IsAvailableForUse() |
Returns whether this bulk data is used |
|
|
IsBulkDataLoaded() |
Returns whether the bulk data is currently loaded and resident in memory. |
|
|
IsInlined() |
Returns whether this bulk data is currently stored inline or not |
|
|
IsInSeparateFile() |
Returns whether this bulk data is currently stored in it's own file or not |
|
|
IsLocked() |
Checks if this bulk is locked |
|
|
IsOptional() |
Returns whether this bulk data represents optional data or not |
|
|
IsStoredCompressedOnDisk() |
Returns whether the bulk data is stored compressed on disk. |
|
|
IsUsingIODispatcher() |
Returns whether this bulk data is accessed via the IoDispatcher or not. |
|
|
LoadBulkDataWithFileReader() |
Load the bulk data using a file reader. |
|
|
void * |
Lock ( |
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 ( |
Change size of locked bulk data. Only valid if locked via read-write lock. |
|
RemoveBulkData() |
Clears/ removes the bulk data and resets element count to 0. |
|
|
RequiresSingleElementSerialization ( |
Returns whether single element serialization is required given an archive. |
|
|
ResetBulkDataFlags ( |
Enable the given flags and disable all other flags. |
|
|
Serialize |
Serialize function used to serialize this bulk data structure. |
|
|
SerializeBulkData |
Serialize just the bulk data portion to/ from the passed in memory. |
|
|
SerializeElement |
Serializes a single element at a time, allowing backward compatible serialization and endian swapping to be performed. |
|
|
SerializeElements |
Serializes all elements, a single element at a time, allowing backward compatible serialization and endian swapping to be performed. |
|
|
SetBulkDataAlignment ( |
Sets the passed in bulk data alignment. |
|
|
SetBulkDataFlags ( |
Enables the given flags without affecting any previously set flags. |
|
|
FOwnedBulkDa... |
StealFileMapping() |
|
|
UnloadBulkData() |
Deallocates bulk data without detaching the archive, so that further bulk data accesses require a reload. |
|
|
Unlock() |
Unlocks bulk data after which point the pointer returned by Lock no longer is valid. |
Name | Description | ||
---|---|---|---|
|
FUntypedBulk... |
operator= ( |
Copies the source array into this one after detaching from archive. |
Name |
Description |
---|---|
BulkDataRangeArray |
Name | Description | ||
---|---|---|---|
|
InSeperateFile() |
Use ::IsInSeparateFile() instead |
|
|
StoreCompressedOnDisk ( |
Use the FName version of StoreCompressedOnDisk |
|
|
StoreCompressedOnDisk ( |
Use the FName version of StoreCompressedOnDisk |