Open 3D Engine AzFramework 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 Member Functions | List of all members
AZ::IO::INestedArchive Struct Referenceabstract

Inherits AZStd::intrusive_base.

Inherited by AZ::IO::NestedArchive.

Public Types

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 *
 

Public Member Functions

virtual Handle GetRootFolderHandle ()=0
 
virtual int UpdateFile (AZStd::string_view szRelativePath, const void *pUncompressed, uint64_t nSize, uint32_t nCompressionMethod=0, int nCompressionLevel=-1, CompressionCodec::Codec codec=CompressionCodec::Codec::ZLIB)=0
 
virtual int StartContinuousFileUpdate (AZStd::string_view szRelativePath, uint64_t nSize)=0
 
virtual int UpdateFileContinuousSegment (AZStd::string_view szRelativePath, uint64_t nSize, const void *pUncompressed, uint64_t nSegmentSize, uint64_t nOverwriteSeekPos=(std::numeric_limits< uint64_t >::max)())=0
 
virtual int UpdateFileCRC (AZStd::string_view szRelativePath, AZ::Crc32 dwCRC)=0
 
virtual int RemoveFile (AZStd::string_view szRelativePath)=0
 
virtual int RemoveDir (AZStd::string_view szRelativePath)=0
 
virtual int RemoveAll ()=0
 
virtual int ListAllFiles (AZStd::vector< AZ::IO::Path > &outFileEntries)=0
 
virtual Handle FindFile (AZStd::string_view szPath)=0
 
virtual uint64_t GetFileSize (Handle)=0
 
virtual int ReadFile (Handle, void *pBuffer)=0
 
virtual AZ::IO::PathView GetFullPath () const =0
 
virtual uint32_t GetFlags () const =0
 
virtual bool SetFlags (uint32_t nFlagsToSet)=0
 
virtual bool ResetFlags (uint32_t nFlagsToSet)=0
 
virtual bool SetPackAccessible (bool bAccessible)=0
 
bool IsReadOnly () const
 
The documentation for this struct was generated from the following file: