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.
Public Types | Public Attributes | List of all members
Archive::ArchiveWriterSettings Struct Reference

#include <ArchiveWriterAPI.h>

Public Types

using ErrorCallback = AZStd::function< void(const ArchiveWriterError &)>
 

Public Attributes

AZStd::optional< Compression::CompressionAlgorithmId > m_tocCompressionAlgorithm
 
ErrorCallback m_errorCallback = [](const ArchiveWriterError&) {}
 
AZ::u32 m_maxCompressTasks { AZStd::thread::hardware_concurrency() }
 

Detailed Description

Stores settings to configure how Archive Writer performs specific operations This can be used to change if the Archive TOC should be compressed on Commit It also supports configuring an optional error callback to invoke if an error occurs in a function that can't return a outcome value such as a constructor/destructor The number of compression tasks that can run in parallel is also configurable

Member Typedef Documentation

◆ ErrorCallback

using Archive::ArchiveWriterSettings::ErrorCallback = AZStd::function<void(const ArchiveWriterError&)>

Callback which is invoked by the ArchiveWriter to inform users of errors that occurs This is used in by functions that can't return an error outcome such as constructors

Member Data Documentation

◆ m_maxCompressTasks

AZ::u32 Archive::ArchiveWriterSettings::m_maxCompressTasks { AZStd::thread::hardware_concurrency() }

Configures the maximum number of compression task that can run in parallel If the value is 0, then a single compression task that will be run at a given moment

◆ m_tocCompressionAlgorithm

AZStd::optional<Compression::CompressionAlgorithmId> Archive::ArchiveWriterSettings::m_tocCompressionAlgorithm

Optional Compression Algorithm to use when writing the Archive TOC to the archive If the optional is not engaged, then the compression algorithm stored in the ArchiveHeader::m_tocCompressionAlgoIndex field is used instead

If the compression algorithm isn't registered with the CompressionRegistrar or if the compression algorithm cannot be added to the Archive Header compression algorithm array due to it being full, then the TOC will be written as uncompressed

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