IoChunkId.h File Reference

#include "CoreTypes.h"
#include "Containers/StringFwd.h"
#include "Memory/MemoryView.h"
#include "Misc/ByteSwap.h"
#include "String/BytesToHex.h"

Go to the source code of this file.

Classes
class	FIoChunkId

Enumerations
enum class	EIoChunkType : uint8 {   Invalid = 0 , ExportBundleData = 1 , BulkData = 2 , OptionalBulkData = 3 ,   MemoryMappedBulkData = 4 , ScriptObjects = 5 , ContainerHeader = 6 , ExternalFile = 7 ,   ShaderCodeLibrary = 8 , ShaderCode = 9 , PackageStoreEntry = 10 , DerivedData = 11 ,   EditorDerivedData = 12 , PackageResource = 13 , MAX }

Functions
CORE_API FString	LexToString (const EIoChunkType Type)
bool	IsBulkDataType (const EIoChunkType Type)
FIoChunkId	CreateIoChunkId (uint64 ChunkId, uint16 ChunkIndex, EIoChunkType IoChunkType)
FIoChunkId	CreateBulkDataIoChunkId (uint64 ChunkId, uint16 ChunkIndex, uint8 ChunkGroup, EIoChunkType IoChunkType)
CORE_API FIoChunkId	CreatePackageDataChunkId (const FPackageId &PackageId)
CORE_API FIoChunkId	CreateExternalFileChunkId (const FStringView Filename)
CORE_API FIoChunkId	CreateContainerHeaderChunkId (const FIoContainerId &ContainerId)

Enumeration Type Documentation

EIoChunkType

enum class EIoChunkType : uint8

strong

Addressable chunk types.

The enumerators have explicitly defined values here to encourage backward/forward compatible updates.

Also note that for certain discriminators, Zen Store will assume certain things about the structure of the chunk ID so changes must be made carefully.

Enumerator
Invalid
ExportBundleData
BulkData
OptionalBulkData
MemoryMappedBulkData
ScriptObjects
ContainerHeader
ExternalFile
ShaderCodeLibrary
ShaderCode
PackageStoreEntry
DerivedData
EditorDerivedData
PackageResource
MAX

Function Documentation

CreateBulkDataIoChunkId()

FIoChunkId CreateBulkDataIoChunkId ( uint64  ChunkId, uint16  ChunkIndex, uint8  ChunkGroup, EIoChunkType  IoChunkType  )

inline

Used to create a FIoChunkId that references a bulkdata chunk.

TODO Cannot use FBulkDataChunkGroup directly here as it is in CoreUObject

Parameters

ChunkId	FPackageId
ChunkIndex	MultiOutputIindex [0 = disabled, 1 enabled]
ChunkGroup	FBulkDataCookedIndex
IoChunkType	EIoChunkType

CreateContainerHeaderChunkId()

CORE_API FIoChunkId CreateContainerHeaderChunkId

(

const FIoContainerId &

ContainerId

)

Returns a container header I/O chunk ID.

CreateExternalFileChunkId()

CORE_API FIoChunkId CreateExternalFileChunkId

(

const FStringView

Filename

)

Returns a file data I/O chunk ID for the specified filename.

CreateIoChunkId()

FIoChunkId CreateIoChunkId ( uint64  ChunkId, uint16  ChunkIndex, EIoChunkType  IoChunkType  )

inline

Creates a chunk identifier (generic – prefer specialized versions where possible).

CreatePackageDataChunkId()

CORE_API FIoChunkId CreatePackageDataChunkId

(

const FPackageId &

PackageId

)

Returns a package data I/O chunk ID for the specified package ID.

IsBulkDataType()

bool IsBulkDataType ( const EIoChunkType  Type )

inline

LexToString()

CORE_API FString LexToString

(

const EIoChunkType

Type

)