Open 3D Engine AzFramework API Reference
2305.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
|
Inherits AZ::IO::IArchive, and Handler.
Public Member Functions | |
AZ_RTTI (Archive,"{764A2260-FF8A-4C86-B958-EBB0B69D9DFA}", IArchive) | |
AZ_CLASS_ALLOCATOR (Archive, AZ::OSAllocator) | |
void | FindCompressionInfo (bool &found, AZ::IO::CompressionInfo &info, const AZ::IO::PathView filePath) override |
CompressionBus Handler implementation. | |
void | SetLocalizationFolder (AZStd::string_view sLocalizationFolder) override |
const char * | GetLocalizationFolder () const override |
const char * | GetLocalizationRoot () const override |
AZStd::intrusive_ptr < INestedArchive > | OpenArchive (AZStd::string_view szPath, AZStd::string_view bindRoot={}, uint32_t nArchiveFlags=0, AZStd::intrusive_ptr< AZ::IO::MemoryBlock > pData=nullptr) override |
AZ::IO::PathView | GetFileArchivePath (AZ::IO::HandleType fileHandle) override |
void * | PoolMalloc (size_t size) override |
Return pointer to pool if available. | |
void | PoolFree (void *p) override |
Free pool. | |
void | RegisterFileAccessSink (IArchiveFileAccessSink *pSink) override |
void | UnregisterFileAccessSink (IArchiveFileAccessSink *pSink) override |
bool | OpenPack (AZStd::string_view pName, AZStd::intrusive_ptr< AZ::IO::MemoryBlock > pData=nullptr, AZ::IO::FixedMaxPathString *pFullPath=nullptr, bool addLevels=true) override |
bool | OpenPack (AZStd::string_view szBindRoot, AZStd::string_view pName, AZStd::intrusive_ptr< AZ::IO::MemoryBlock > pData=nullptr, AZ::IO::FixedMaxPathString *pFullPath=nullptr, bool addLevels=true) override |
bool | ClosePack (AZStd::string_view pName) override |
bool | OpenPacks (AZStd::string_view pWildcard, AZStd::vector< AZ::IO::FixedMaxPathString > *pFullPaths=nullptr) override |
bool | OpenPacks (AZStd::string_view szBindRoot, AZStd::string_view pWildcard, AZStd::vector< AZ::IO::FixedMaxPathString > *pFullPaths=nullptr) override |
bool | ClosePacks (AZStd::string_view pWildcard) override |
bool | FindPacks (AZStd::string_view pWildcardIn) override |
bool | SetPacksAccessible (bool bAccessible, AZStd::string_view pWildcard) override |
bool | SetPackAccessible (bool bAccessible, AZStd::string_view pName) override |
uint64_t | GetModificationTime (AZ::IO::HandleType fileHandle) override |
AZ::IO::HandleType | FOpen (AZStd::string_view pName, const char *mode) override |
size_t | FRead (void *data, size_t bytesToRead, AZ::IO::HandleType handle) override |
void * | FGetCachedFileData (AZ::IO::HandleType handle, size_t &nFileSize) override |
size_t | FWrite (const void *data, size_t bytesToWrite, AZ::IO::HandleType handle) override |
size_t | FSeek (AZ::IO::HandleType handle, uint64_t seek, int mode) override |
uint64_t | FTell (AZ::IO::HandleType handle) override |
int | FFlush (AZ::IO::HandleType handle) override |
int | FClose (AZ::IO::HandleType handle) override |
AZ::IO::ArchiveFileIterator | FindFirst (AZStd::string_view pDir, FileSearchLocation searchType=FileSearchLocation::InPak) override |
AZ::IO::ArchiveFileIterator | FindNext (AZ::IO::ArchiveFileIterator fileIterator) override |
bool | FindClose (AZ::IO::ArchiveFileIterator fileIterator) override |
int | FEof (AZ::IO::HandleType handle) override |
size_t | FGetSize (AZ::IO::HandleType fileHandle) override |
size_t | FGetSize (AZStd::string_view sFilename, bool bAllowUseFileSystem=false) override |
bool | IsInPak (AZ::IO::HandleType handle) override |
bool | RemoveFile (AZStd::string_view pName) override |
bool | RemoveDir (AZStd::string_view pName) override |
bool | IsAbsPath (AZStd::string_view pPath) override |
bool | IsFileExist (AZStd::string_view sFilename, FileSearchLocation fileLocation=FileSearchLocation::Any) override |
bool | IsFolder (AZStd::string_view sPath) override |
IArchive::SignedFileSize | GetFileSizeOnDisk (AZStd::string_view filename) override |
int | RawCompress (const void *pUncompressed, size_t *pDestSize, void *pCompressed, size_t nSrcSize, int nLevel=-1) override |
int | RawUncompress (void *pUncompressed, size_t *pDestSize, const void *pCompressed, size_t nSrcSize) override |
void | RecordFileOpen (ERecordFileOpenList eMode) override |
ERecordFileOpenList | GetRecordFileOpenList () override |
void | RecordFile (AZ::IO::HandleType in, AZStd::string_view szFilename) override |
IResourceList * | GetResourceList (ERecordFileOpenList eList) override |
void | SetResourceList (ERecordFileOpenList eList, IResourceList *pResourceList) override |
void | DisableRuntimeFileAccess (bool status) override |
bool | DisableRuntimeFileAccess (bool status, AZStd::thread_id threadId) override |
FileSearchPriority | GetPakPriority () const override |
uint64_t | GetFileOffsetOnMedia (AZStd::string_view szName) const override |
EStreamSourceMediaType | GetFileMediaType (AZStd::string_view szName) const override |
auto | GetLevelPackOpenEvent () -> LevelPackOpenEvent *override |
auto | GetLevelPackCloseEvent () -> LevelPackCloseEvent *override |
CCachedFileDataPtr | GetOpenedFileDataInZip (AZ::IO::HandleType file) |
ZipDir::FileEntry * | FindPakFileEntry (AZStd::string_view szPath, uint32_t &nArchiveFlags, ZipDir::CachePtr *pZip={}) const |
Public Member Functions inherited from AZ::IO::IArchive | |
AZ_RTTI (IArchive,"{764A2260-FF8A-4C86-B958-EBB0B69D9DFA}") | |
Friends | |
struct | CCachedFileData |
class | FindData |
class | NestedArchive |
struct | SAutoCollectFileAccessTime |
Additional Inherited Members | |
Public Types inherited from AZ::IO::IArchive | |
enum | ERecordFileOpenList { RFOM_Disabled, RFOM_EngineStartup, RFOM_Level, RFOM_NextLevel } |
enum | EInMemoryArchiveLocation { eInMemoryPakLocale_Unload = 0, eInMemoryPakLocale_CPU, eInMemoryPakLocale_GPU, eInMemoryPakLocale_PAK } |
using | FileTime = uint64_t |
using | SignedFileSize = int64_t |
using | LevelPackOpenEvent = AZ::Event< const AZStd::vector< AZ::IO::Path > & > |
using | LevelPackCloseEvent = AZ::Event< AZStd::string_view > |
Static Public Attributes inherited from AZ::IO::IArchive | |
static constexpr IArchive::SignedFileSize | FILE_NOT_PRESENT = -1 |