FUntypedBulkData

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

CoreUObject

Header

/Engine/Source/Runtime/CoreUObject/Public/Serialization/BulkData.h

Include

#include "Serialization/BulkData.h"

Syntax

struct FUntypedBulkData

Variables

Name Description

Protected variable

FArchive *

 

AttachedAr

Archive associated with bulk data for serialization

Protected variable

FString

 

Filename

Name of the package file containing the bulkdata

Protected variable

FLinkerLoad ...

 

Linker

Used to make sure the linker doesn't get garbage collected at runtime for things with attached archives

Constructors

Name Description

Public function

FUntypedBulkData()

Constructor, initializing all member variables.

Public function

FUntypedBulkData

(
    const FUntypedBulkData& Other
)

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

Destructors

Name Description

Public function Virtual

~FUntypedBulkData()

Virtual destructor, free'ing allocated memory.

Functions

Name Description

Public function Const

bool

 

CanLoadFromDisk()

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

 

DumpBulkDataUsage

(
    FOutputDevice& Log
)

Dumps detailed information of bulk data usage.

Public function

void

 

ForceBulkDataResident()

Forces the bulk data to be resident in memory and detaches the archive.

Public function Const

uint32

 

GetBulkDataAlignment()

Gets the current bulk data alignment.

Public function Const

uint32

 

GetBulkDataFlags()

Gets the current bulk data flags.

Public function Const

int64

 

GetBulkDataOffsetInFile()

Returns the offset into the file the bulk data is located at.

Public function Const

int64

 

GetBulkDataSize()

Returns the size of the bulk data in bytes.

Public function Const

int64

 

GetBulkDataSizeOnDisk()

Returns the size of the bulk data on disk.

Public function

void

 

GetCopy

(
    void** Dest,
    bool bDiscardInternalCopy
)

Retrieves a copy of the bulk data.

Public function Const

FName

 

GetDecompressionFormat()

Returns flags usable to decompress the bulk data

Public function Const

int64

 

GetElementCount()

Returns the number of elements in this bulk data array.

Public function Const

int32

 

GetElementSize()

Returns size in bytes of single element.

Public function Const

const FStrin...

 

GetFilename()

Returns the filename this bulkdata resides in

Public function Const

bool

 

IsAsyncLoadingComplete()

Returns whether the bulk data asynchronous load has completed.

Public function Const

bool

 

IsAvailableForUse()

Returns whether this bulk data is used

Public function Const

bool

 

IsBulkDataLoaded()

Returns whether the bulk data is currently loaded and resident in memory.

Public function Const

bool

 

IsLocked()

Checks if this bulk is locked

Public function Const

bool

 

IsStoredCompressedOnDisk()

Returns whether the bulk data is stored compressed on disk.

Public function

bool

 

LoadBulkDataWithFileReader()

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 &...

 

LockReadOnly()

Locks the bulk data and returns a read-only pointer to it.

Public function

void *

 

Realloc

(
    int64 InElementCount
)

Change size of locked bulk data. Only valid if locked via read-write lock.

Public function

void

 

RemoveBulkData()

Clears/ removes the bulk data and resets element count to 0.

Protected function Virtual

bool

 

RequiresSingleElementSerialization

(
    FArchive& Ar
)

Returns whether single element serialization is required given an archive.

Public function

void

 

Serialize

(
    FArchive& Ar,
    UObject* Owner,
    int32 Idx,
    bool bAttemptFileMapping
)

Serialize function used to serialize this bulk data structure.

Public function

void

 

SerializeBulkData

(
    FArchive& Ar,
    void* Data
)

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

Protected function

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.

Protected function Virtual

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.

Public function

void

 

SetBulkDataAlignment

(
    uint32 BulkDataAlignmentToSet
)

Sets the passed in bulk data alignment.

Public function

void

 

SetBulkDataFlags

(
    uint32 BulkDataFlagsToSet
)

Sets the passed in bulk data flags.

Public function

FOwnedBulkDa...

 

StealFileMapping()

Public function

bool

 

UnloadBulkData()

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

Name Description

Public function

FUntypedBulk...

 

operator=

(
    const FUntypedBulkData& Other
)

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

Deprecated Functions

Name Description

Public function

void

 

StoreCompressedOnDisk

(
    ECompressionFlags CompressionFlags
)

Use the FName version of StoreCompressedOnDisk

Public function

void

 

StoreCompressedOnDisk

(
    FName CompressionFormat
)

Use the FName version of StoreCompressedOnDisk

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback