Open 3D Engine AzFramework API Reference  2205.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
AZ::IO::NestedArchive Class Reference

Inherits AZ::IO::INestedArchive.

Public Member Functions

 AZ_CLASS_ALLOCATOR (NestedArchive, AZ::SystemAllocator, 0)
 
 NestedArchive (IArchive *pArchive, AZStd::string_view strBindRoot, ZipDir::CachePtr pCache, uint32_t nFlags=0)
 
auto GetRootFolderHandle () -> Handle override
 
int UpdateFile (AZStd::string_view szRelativePath, const void *pUncompressed, uint64_t nSize, uint32_t nCompressionMethod=ZipFile::METHOD_STORE, int nCompressionLevel=-1, CompressionCodec::Codec codec=CompressionCodec::Codec::ZLIB) override
 
int StartContinuousFileUpdate (AZStd::string_view szRelativePath, uint64_t nSize) override
 
int UpdateFileContinuousSegment (AZStd::string_view szRelativePath, uint64_t nSize, const void *pUncompressed, uint64_t nSegmentSize, uint64_t nOverwriteSeekPos) override
 
int UpdateFileCRC (AZStd::string_view szRelativePath, AZ::Crc32 dwCRC) override
 
int RemoveFile (AZStd::string_view szRelativePath) override
 
int RemoveDir (AZStd::string_view szRelativePath) override
 
int RemoveAll () override
 
int ListAllFiles (AZStd::vector< AZ::IO::Path > &outFileEntries) override
 
Handle FindFile (AZStd::string_view szRelativePath) override
 
uint64_t GetFileSize (Handle fileHandle) override
 
int ReadFile (Handle fileHandle, void *pBuffer) override
 
AZ::IO::PathView GetFullPath () const override
 
uint32_t GetFlags () const override
 
bool SetFlags (uint32_t nFlagsToSet) override
 
bool ResetFlags (uint32_t nFlagsToReset) override
 
bool SetPackAccessible (bool bAccessible) override
 
ZipDir::CacheGetCache ()
 
- Public Member Functions inherited from AZ::IO::INestedArchive
bool IsReadOnly () const
 

Protected Member Functions

AZ::IO::FixedMaxPathString AdjustPath (AZStd::string_view szRelativePath)
 

Protected Attributes

ZipDir::CachePtr m_pCache
 
AZ::IO::Path m_strBindRoot
 
IArchivem_archive {}
 
uint32_t m_nFlags {}
 

Additional Inherited Members

- Public Types inherited from AZ::IO::INestedArchive
enum  ECompressionMethods { METHOD_STORE = 0, METHOD_COMPRESS = 8, METHOD_DEFLATE = 8, METHOD_COMPRESS_AND_ENCRYPT = 11 }
 
enum  ECompressionLevels {
  LEVEL_FASTEST = 0, LEVEL_FASTER = 2, LEVEL_NORMAL = 8, LEVEL_BETTER = 8,
  LEVEL_BEST = 9, LEVEL_DEFAULT = -1
}
 
enum  EPakFlags {
  FLAGS_ABSOLUTE_PATHS = 1, FLAGS_RELATIVE_PATHS_ONLY = 1 << 1, FLAGS_READ_ONLY = 1 << 2, FLAGS_OPTIMIZED_READ_ONLY = (1 << 3),
  FLAGS_CREATE_NEW = 1 << 4, FLAGS_DONT_COMPACT = 1 << 5, FLAGS_VALIDATE_HEADERS = 1 << 9, FLAGS_FULL_VALIDATE = 1 << 10,
  FLAGS_DISABLE_PAK = 1 << 11
}
 
using Handle = void *
 

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