Archive::ArchiveReaderSettings Struct Reference

Stores settings to configure how Archive Reader Settings. More...

#include <ArchiveReaderAPI.h>

Public Types
using	ErrorCallback = AZStd::function< void(const ArchiveReaderError &)>

Public Attributes
ErrorCallback	m_errorCallback = [](const ArchiveReaderError&) {}
AZ::u32	m_maxDecompressTasks { AZStd::thread::hardware_concurrency() }
AZ::u32	m_maxReadTasks { 1 }

Detailed Description

Stores settings to configure how Archive Reader Settings.

Member Typedef Documentation

ErrorCallback

using Archive::ArchiveReaderSettings::ErrorCallback = AZStd::function<void(const ArchiveReaderError&)>

Callback which is invoked by the ArchiveReader 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_maxDecompressTasks

AZ::u32 Archive::ArchiveReaderSettings::m_maxDecompressTasks { AZStd::thread::hardware_concurrency() }

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

m_maxReadTasks

AZ::u32 Archive::ArchiveReaderSettings::m_maxReadTasks { 1 }

Configures the maximum number of read task that can run in parallel For a value of 0 maps to a single read task

---

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

• Gems/Archive/Code/Include/Archive/Clients/ArchiveReaderAPI.h