Skip to content

PackageFileHeaderDescription

Provides metadata about the package file.

Public Attributes

Type Name
ePackageFileCompressionMode m_CompressionMode = ePackageFileCompressionMode\_Invalid
The compression mode used for this package file.
AmUInt8 m_Header = { 'A', 'M', 'P', 'K' }
Package file header tag.
std::vector< PackageFileItemDescription > m_Items
The description of each item in the package file.
AmUInt16 m_Version = 0
Package file version.

Public Attributes Documentation

m_CompressionMode

The compression mode used for this package file. 

ePackageFileCompressionMode SparkyStudios::Audio::Amplitude::PackageFileHeaderDescription::m_CompressionMode;
m_Header

Package file header tag. 

AmUInt8 SparkyStudios::Audio::Amplitude::PackageFileHeaderDescription::m_Header[4];

Note:

Should be equal to 'AMPK'.

m_Items

The description of each item in the package file. 

std::vector<PackageFileItemDescription> SparkyStudios::Audio::Amplitude::PackageFileHeaderDescription::m_Items;

The total number of descriptions should match the number of items.

m_Version

Package file version. 

AmUInt16 SparkyStudios::Audio::Amplitude::PackageFileHeaderDescription::m_Version;

This is used to implement new features in package files and still be backward compatible with old versions.

The documentation for this struct was generated from the following file: include/SparkyStudios/Audio/Amplitude/IO/PackageFileSystem.h