Open 3D Engine Archive Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Archive::ArchiveTableOfContents Struct Reference

#include <ArchiveTOC.h>

Classes

struct  Path
 

Public Types

using CreateFromTocViewOutcome = AZStd::expected< ArchiveTableOfContents, EnumerateErrorString >
 Initializes a Table of Contents in-memory structure from a Table of Contents view.
 
using ArchiveFilePathTable = AZStd::vector< Path >
 

Public Member Functions

 ArchiveTableOfContents ()
 

Static Public Member Functions

static CreateFromTocViewOutcome CreateFromTocView (const ArchiveTableOfContentsView &tocView)
 

Public Attributes

AZStd::vector< ArchiveTocFileMetadatam_fileMetadataTable
 
ArchiveFilePathTable m_filePaths
 
AZStd::vector< ArchiveBlockLineUnionm_blockOffsetTable {}
 vector storing the block offset table for each file
 

Detailed Description

Structure for which owns the Table of Contents data It contains data structure which makes it easier to dynamically add/remove/update files to the table of contents while in memory

Member Typedef Documentation

◆ ArchiveFilePathTable

vector storing a copy of each file path in memory Its length matches the value of m_fileCount

Constructor & Destructor Documentation

◆ ArchiveTableOfContents()

Archive::ArchiveTableOfContents::ArchiveTableOfContents ( )
inlinedefault

The Archive TOC is either uncompressed or compressed based on the compression algorithm index set within the Archive Header

Member Data Documentation

◆ m_fileMetadataTable

AZStd::vector<ArchiveTocFileMetadata> Archive::ArchiveTableOfContents::m_fileMetadataTable

vector storing a copy of each file metadata entry in memory It's length matches the value of m_fileCount


The documentation for this struct was generated from the following files: