An asset archive represents a file containing data assets that are loaded from disk and then cached in memory. More...

#include <asset_archive.h>

Classes
struct	FILE_INFO

Public Member Functions
	ASSET_ARCHIVE (const wxString &aFilePath, bool aLoadNow=true)

	~ASSET_ARCHIVE ()=default

bool	Load ()

long	GetFileContents (const wxString &aFilePath, const unsigned char *aDest, size_t aMaxLen)
	Retrieves a file with the given path from the cached archive.

long	GetFilePointer (const wxString &aFilePath, const unsigned char **aDest)
	Retrieves a pointer to a file with the given path from the cached archive.

Private Attributes
std::unordered_map< wxString, FILE_INFO >	m_fileInfoCache
	Cache of file info for a given file path.

std::vector< unsigned char >	m_cache
	The full file contents.

wxString	m_filePath
	Path to the source archive file.

Detailed Description

An asset archive represents a file containing data assets that are loaded from disk and then cached in memory.

For example, a set of bitmap images.

The entire contents of the archive will be uncompressed and kept resident in memory in the current implementation, so consider this before reusing this as-is for new use cases.

Definition at line 36 of file asset_archive.h.

Constructor & Destructor Documentation

◆ ASSET_ARCHIVE()

ASSET_ARCHIVE::ASSET_ARCHIVE	(	const wxString &	aFilePath,
		bool	aLoadNow = true )

Definition at line 27 of file asset_archive.cpp.

References Load(), and m_filePath.

◆ ~ASSET_ARCHIVE()

ASSET_ARCHIVE::~ASSET_ARCHIVE ( )

default

References GetFileContents(), and GetFilePointer().

Member Function Documentation

◆ GetFileContents()

long ASSET_ARCHIVE::GetFileContents	(	const wxString &	aFilePath,
		const unsigned char *	aDest,
		size_t	aMaxLen )

Retrieves a file with the given path from the cached archive.

Parameters

aFilePath	is the path within the archive to the requested file
aDest	is the target byte array to copy into
aMaxLen	is the maximum bytes that can be copied into aDest